Class DataSegmentSummary

java.lang.Object
software.amazon.awssdk.services.iotsitewise.model.DataSegmentSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DataSegmentSummary.Builder,DataSegmentSummary>
@Generated("software.amazon.awssdk:codegen") public final class DataSegmentSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DataSegmentSummary.Builder,DataSegmentSummary>

Contains summary information about a data segment, including its source dataset, time series, timestamp range, and enrichment status.

See Also:

  • Method Details

    • sourceDatasetId

      public final String sourceDatasetId()

      The ID of the source dataset that contains the data segment.

      Returns:
      The ID of the source dataset that contains the data segment.

    • timeSeriesId

      public final String timeSeriesId()

      The ID of the time series.

      Returns:
      The ID of the time series.

    • startTimestamp

      public final TimeInNanos startTimestamp()

      The nanosecond-precision start time of the data segment.

      Returns:
      The nanosecond-precision start time of the data segment.

    • endTimestamp

      public final TimeInNanos endTimestamp()

      The nanosecond-precision end time of the data segment.

      Returns:
      The nanosecond-precision end time of the data segment.

    • alias

      public final String alias()

      The alias of the time series.

      Returns:
      The alias of the time series.

    • dataType

      public final PropertyDataType dataType()

      The data type of the time series.

      If the service returns an enum value that is not available in the current SDK version, dataType will return PropertyDataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataTypeAsString().

      Returns:
      The data type of the time series.
      See Also:

    • dataTypeAsString

      public final String dataTypeAsString()

      The data type of the time series.

      If the service returns an enum value that is not available in the current SDK version, dataType will return PropertyDataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataTypeAsString().

      Returns:
      The data type of the time series.
      See Also:

    • enrichment

      public final DataSegmentEnrichment enrichment()

      The enrichment information for the data segment.

      Returns:
      The enrichment information for the data segment.

    • toBuilder

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

    • builder

      public static DataSegmentSummary.Builder builder()

    • serializableBuilderClass

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