Class DatasetSummary

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

A summary of information about a dataset.

See Also:

  • Method Details

    • datasetName

      public final String datasetName()

      The name of the dataset.

      Returns:
      The name of the dataset.

    • status

      public final DatasetStatus status()

      The status of the dataset.

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

      Returns:
      The status of the dataset.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the dataset.

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

      Returns:
      The status of the dataset.
      See Also:

    • creationTime

      public final Instant creationTime()

      The time the dataset was created.

      Returns:
      The time the dataset was created.

    • lastUpdateTime

      public final Instant lastUpdateTime()

      The last time the dataset was updated.

      Returns:
      The last time the dataset was updated.

    • hasTriggers

      public final boolean hasTriggers()
      For responses, this returns true if the service returned a value for the Triggers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • triggers

      public final List<DatasetTrigger> triggers()

      A list of triggers. A trigger causes dataset content to be populated at a specified time interval or when another dataset is populated. The list of triggers can be empty or contain up to five DataSetTrigger objects

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTriggers() method.

      Returns:
      A list of triggers. A trigger causes dataset content to be populated at a specified time interval or when another dataset is populated. The list of triggers can be empty or contain up to five DataSetTrigger objects

    • hasActions

      public final boolean hasActions()
      For responses, this returns true if the service returned a value for the Actions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • actions

      public final List<DatasetActionSummary> actions()

      A list of DataActionSummary objects.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasActions() method.

      Returns:
      A list of DataActionSummary objects.

    • toBuilder

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

    • builder

      public static DatasetSummary.Builder builder()

    • serializableBuilderClass

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