Class EnrichmentTrimSettings

java.lang.Object
software.amazon.awssdk.services.iotsitewise.model.EnrichmentTrimSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EnrichmentTrimSettings.Builder,EnrichmentTrimSettings>
@Generated("software.amazon.awssdk:codegen") public final class EnrichmentTrimSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EnrichmentTrimSettings.Builder,EnrichmentTrimSettings>
<p>Time range settings for extracting a specific window of video time-series data to process.</p> <p>Trim settings define the time bounds for enrichment and must satisfy:</p> <ul> <li>Start and end times must be within the dataset's time bounds</li> <li>Trim settings retrieve fully contained data segments within the specified time range</li> <li>endTime must be greater than startTime</li> <li>Both times should represent valid data ranges in the dataset</li> </ul> <p>Trim settings are required to:</p> <ul> <li>Prevent accidentally analyzing unbounded datasets</li> <li>Ensure predictable processing time and costs</li> <li>Allow focused analysis on specific time periods of interest</li> </ul>
See Also:

  • Method Details

    • startTime

      public final TimeInNanos startTime()
      <p>Start time for the video analysis time range in nanoseconds since Unix epoch (TimeInNanos format). Data segments at or after this time are included in the enrichment. Must be within the dataset's time bounds.</p> <p>Example (JavaScript): Date.parse('2024-01-01T00:00:00Z') * 1000000 Example (Python): int(datetime.timestamp() * 1e9)</p>
      Returns:
      <p>Start time for the video analysis time range in nanoseconds since Unix epoch (TimeInNanos format). Data segments at or after this time are included in the enrichment. Must be within the dataset's time bounds.</p> <p>Example (JavaScript): Date.parse('2024-01-01T00:00:00Z') * 1000000 Example (Python): int(datetime.timestamp() * 1e9)</p>

    • endTime

      public final TimeInNanos endTime()
      <p>End time for the video analysis time range in nanoseconds since Unix epoch (TimeInNanos format). Data segments at or before this time are included in the enrichment. Must be greater than startTime and within the dataset's time bounds.</p>
      Returns:
      <p>End time for the video analysis time range in nanoseconds since Unix epoch (TimeInNanos format). Data segments at or before this time are included in the enrichment. Must be greater than startTime and within the dataset's time bounds.</p>

    • toBuilder

      public EnrichmentTrimSettings.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<EnrichmentTrimSettings.Builder,EnrichmentTrimSettings>
      Returns:
      a builder for type T

    • builder

      public static EnrichmentTrimSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EnrichmentTrimSettings.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.