Class TimeseriesItem

java.lang.Object
software.amazon.awssdk.services.iotsitewise.model.TimeseriesItem
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TimeseriesItem.Builder,TimeseriesItem>
@Generated("software.amazon.awssdk:codegen") public final class TimeseriesItem extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TimeseriesItem.Builder,TimeseriesItem>
<p>A single timeseries item to process. Exactly one of timeSeriesId or propertyAlias must be provided.</p>
See Also:

  • Method Details

    • timeSeriesId

      public final String timeSeriesId()
      <p>The unique identifier for the timeseries. Mutually exclusive with propertyAlias.</p>
      Returns:
      <p>The unique identifier for the timeseries. Mutually exclusive with propertyAlias.</p>

    • propertyAlias

      public final String propertyAlias()
      <p>The customer-friendly alias for the timeseries. Mutually exclusive with timeSeriesId.</p>
      Returns:
      <p>The customer-friendly alias for the timeseries. Mutually exclusive with timeSeriesId.</p>

    • trimSettings

      public final TrimSettings trimSettings()
      <p>The trim settings for the time range to export. Required for VIDEO and TELEMETRY data types; optional for ANNOTATION data types.</p>
      Returns:
      <p>The trim settings for the time range to export. Required for VIDEO and TELEMETRY data types; optional for ANNOTATION data types.</p>

    • formatSettings

      public final FormatSettings formatSettings()
      <p>The optional format settings for the output.</p>
      Returns:
      <p>The optional format settings for the output.</p>

    • toBuilder

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

    • builder

      public static TimeseriesItem.Builder builder()

    • serializableBuilderClass

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