Class CreateDatasetRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateDatasetRequest.Builder,
CreateDatasetRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<DatasetAction> actions()
A list of actions that create the dataset contents.static CreateDatasetRequest.Builder
builder()
final List
<DatasetContentDeliveryRule> When dataset contents are created, they are delivered to destinations specified here.final String
The name of the dataset.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Actions property.final boolean
For responses, this returns true if the service returned a value for the ContentDeliveryRules property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the LateDataRules property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final boolean
For responses, this returns true if the service returned a value for the Triggers property.final List
<LateDataRule> A list of data rules that send notifications to CloudWatch, when data arrives late.final RetentionPeriod
Optional.static Class
<? extends CreateDatasetRequest.Builder> tags()
Metadata which can be used to manage the dataset.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final List
<DatasetTrigger> triggers()
A list of triggers.final VersioningConfiguration
Optional.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
datasetName
The name of the dataset.
- Returns:
- The name of the dataset.
-
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
A list of actions that create the dataset contents.
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 actions that create the dataset contents.
-
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
A list of triggers. A trigger causes dataset contents to be populated at a specified time interval or when another dataset's contents are created. 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 contents to be populated at a specified time interval or
when another dataset's contents are created. The list of triggers can be empty or contain up to five
DataSetTrigger
objects.
-
hasContentDeliveryRules
public final boolean hasContentDeliveryRules()For responses, this returns true if the service returned a value for the ContentDeliveryRules 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. -
contentDeliveryRules
When dataset contents are created, they are delivered to destinations specified here.
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
hasContentDeliveryRules()
method.- Returns:
- When dataset contents are created, they are delivered to destinations specified here.
-
retentionPeriod
Optional. How long, in days, versions of dataset contents are kept for the dataset. If not specified or set to
null
, versions of dataset contents are retained for at most 90 days. The number of versions of dataset contents retained is determined by theversioningConfiguration
parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.- Returns:
- Optional. How long, in days, versions of dataset contents are kept for the dataset. If not specified or
set to
null
, versions of dataset contents are retained for at most 90 days. The number of versions of dataset contents retained is determined by theversioningConfiguration
parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
-
versioningConfiguration
Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the
retentionPeriod
parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.- Returns:
- Optional. How many versions of dataset contents are kept. If not specified or set to null, only the
latest version plus the latest succeeded version (if they are different) are kept for the time period
specified by the
retentionPeriod
parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags 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. -
tags
Metadata which can be used to manage the dataset.
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
hasTags()
method.- Returns:
- Metadata which can be used to manage the dataset.
-
hasLateDataRules
public final boolean hasLateDataRules()For responses, this returns true if the service returned a value for the LateDataRules 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. -
lateDataRules
A list of data rules that send notifications to CloudWatch, when data arrives late. To specify
lateDataRules
, the dataset must use a DeltaTimer filter.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
hasLateDataRules()
method.- Returns:
- A list of data rules that send notifications to CloudWatch, when data arrives late. To specify
lateDataRules
, the dataset must use a DeltaTimer filter.
-
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 interfaceToCopyableBuilder<CreateDatasetRequest.Builder,
CreateDatasetRequest> - Specified by:
toBuilder
in classIoTAnalyticsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-