Class EventDetection

java.lang.Object
software.amazon.awssdk.services.iotsitewise.model.EventDetection
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EventDetection.Builder,EventDetection>
@Generated("software.amazon.awssdk:codegen") public final class EventDetection extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EventDetection.Builder,EventDetection>
<p>Configuration for event detection enrichment on video time-series data.</p> <p>Event detection generates embeddings from video data enabling natural language similarity search on events. This allows customers to:</p> <ul> <li>Query video events using semantic search after enrichment completes</li> <li>Find relevant video segments through natural language queries</li> <li>Search across video time-series data stored in IoT SiteWise</li> </ul> <p>You must specify the dataset, exactly one time-series identifier (timeSeriesId OR propertyAlias), and trim settings defining the video time window to process.</p>
See Also:

  • Method Details

    • datasetId

      public final String datasetId()
      <p>The IoT SiteWise dataset ID containing the video time-series data to analyze. Query IoT SiteWise to discover available datasets in your workspace.</p>
      Returns:
      <p>The IoT SiteWise dataset ID containing the video time-series data to analyze. Query IoT SiteWise to discover available datasets in your workspace.</p>

    • timeSeriesId

      public final String timeSeriesId()
      <p>Unique system identifier for the video time series to analyze. Specify either timeSeriesId or propertyAlias, but not both. Use this when you have the system-generated time series identifier from IoT SiteWise.</p>
      Returns:
      <p>Unique system identifier for the video time series to analyze. Specify either timeSeriesId or propertyAlias, but not both. Use this when you have the system-generated time series identifier from IoT SiteWise.</p>

    • propertyAlias

      public final String propertyAlias()
      <p>Human-readable alias for the video time series to analyze (e.g., /camera/warehouse/zone-a). Specify either propertyAlias or timeSeriesId, but not both. Use this when you have configured friendly aliases in IoT SiteWise for better readability.</p>
      Returns:
      <p>Human-readable alias for the video time series to analyze (e.g., /camera/warehouse/zone-a). Specify either propertyAlias or timeSeriesId, but not both. Use this when you have configured friendly aliases in IoT SiteWise for better readability.</p>

    • trimSettings

      public final EnrichmentTrimSettings trimSettings()
      <p>Time range settings defining which portion of the video time-series data to process. Required to ensure predictable processing time and prevent analyzing unbounded datasets. Start and end times must be within the dataset's time bounds.</p>
      Returns:
      <p>Time range settings defining which portion of the video time-series data to process. Required to ensure predictable processing time and prevent analyzing unbounded datasets. Start and end times must be within the dataset's time bounds.</p>

    • toBuilder

      public EventDetection.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<EventDetection.Builder,EventDetection>
      Returns:
      a builder for type T

    • builder

      public static EventDetection.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EventDetection.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.