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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDatasetSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<DatasetActionSummary>actions()A list ofDataActionSummaryobjects.static DatasetSummary.Builderbuilder()InstantcreationTime()The time the dataset was created.StringdatasetName()The name of the dataset.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasActions()For responses, this returns true if the service returned a value for the Actions property.inthashCode()booleanhasTriggers()For responses, this returns true if the service returned a value for the Triggers property.InstantlastUpdateTime()The last time the dataset was updated.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends DatasetSummary.Builder>serializableBuilderClass()DatasetStatusstatus()The status of the dataset.StringstatusAsString()The status of the dataset.DatasetSummary.BuildertoBuilder()StringtoString()Returns a string representation of this object.List<DatasetTrigger>triggers()A list of triggers.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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,
statuswill returnDatasetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the dataset.
- See Also:
DatasetStatus
-
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,
statuswill returnDatasetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the dataset.
- See Also:
DatasetStatus
-
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 theisEmpty()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
DataSetTriggerobjectsAttempts 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
DataSetTriggerobjects
-
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 theisEmpty()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
DataActionSummaryobjects.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
DataActionSummaryobjects.
-
toBuilder
public DatasetSummary.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DatasetSummary.Builder,DatasetSummary>
-
builder
public static DatasetSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends DatasetSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-