CreateDatasetRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.iotanalytics.model

Class CreateDatasetRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.iotanalytics.model.CreateDatasetRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDatasetRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateDatasetRequest ()

Constructors
Constructor and Description
`CreateDatasetRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`CreateDatasetRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`List<DatasetAction>`	`getActions ()` A list of actions that create the dataset contents.
`List<DatasetContentDeliveryRule>`	`getContentDeliveryRules ()` When dataset contents are created, they are delivered to destinations specified here.
`String`	`getDatasetName ()` The name of the dataset.
`List<LateDataRule>`	`getLateDataRules ()` A list of data rules that send notifications to CloudWatch, when data arrives late.
`RetentionPeriod`	`getRetentionPeriod ()` Optional.
`List<Tag>`	`getTags ()` Metadata which can be used to manage the dataset.
`List<DatasetTrigger>`	`getTriggers ()` A list of triggers.
`VersioningConfiguration`	`getVersioningConfiguration ()` Optional.
`int`	`hashCode ()`
`void`	`setActions (Collection<DatasetAction> actions)` A list of actions that create the dataset contents.
`void`	`setContentDeliveryRules (Collection<DatasetContentDeliveryRule> contentDeliveryRules)` When dataset contents are created, they are delivered to destinations specified here.
`void`	`setDatasetName (String datasetName)` The name of the dataset.
`void`	`setLateDataRules (Collection<LateDataRule> lateDataRules)` A list of data rules that send notifications to CloudWatch, when data arrives late.
`void`	`setRetentionPeriod (RetentionPeriod retentionPeriod)` Optional.
`void`	`setTags (Collection<Tag> tags)` Metadata which can be used to manage the dataset.
`void`	`setTriggers (Collection<DatasetTrigger> triggers)` A list of triggers.
`void`	`setVersioningConfiguration (VersioningConfiguration versioningConfiguration)` Optional.
`String`	`toString ()` Returns a string representation of this object.
`CreateDatasetRequest`	`withActions (Collection<DatasetAction> actions)` A list of actions that create the dataset contents.
`CreateDatasetRequest`	`withActions (DatasetAction... actions)` A list of actions that create the dataset contents.
`CreateDatasetRequest`	`withContentDeliveryRules (Collection<DatasetContentDeliveryRule> contentDeliveryRules)` When dataset contents are created, they are delivered to destinations specified here.
`CreateDatasetRequest`	`withContentDeliveryRules (DatasetContentDeliveryRule... contentDeliveryRules)` When dataset contents are created, they are delivered to destinations specified here.
`CreateDatasetRequest`	`withDatasetName (String datasetName)` The name of the dataset.
`CreateDatasetRequest`	`withLateDataRules (Collection<LateDataRule> lateDataRules)` A list of data rules that send notifications to CloudWatch, when data arrives late.
`CreateDatasetRequest`	`withLateDataRules (LateDataRule... lateDataRules)` A list of data rules that send notifications to CloudWatch, when data arrives late.
`CreateDatasetRequest`	`withRetentionPeriod (RetentionPeriod retentionPeriod)` Optional.
`CreateDatasetRequest`	`withTags (Collection<Tag> tags)` Metadata which can be used to manage the dataset.
`CreateDatasetRequest`	`withTags (Tag... tags)` Metadata which can be used to manage the dataset.
`CreateDatasetRequest`	`withTriggers (Collection<DatasetTrigger> triggers)` A list of triggers.
`CreateDatasetRequest`	`withTriggers (DatasetTrigger... triggers)` A list of triggers.
`CreateDatasetRequest`	`withVersioningConfiguration (VersioningConfiguration versioningConfiguration)` Optional.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateDatasetRequest
```
public CreateDatasetRequest()
```
- Method Detail
  - setDatasetName
```
public void setDatasetName(String datasetName)
```
    The name of the dataset.
    
    Parameters:
    
    datasetName - The name of the dataset.
  - getDatasetName
```
public String getDatasetName()
```
    The name of the dataset.
    
    Returns:
    
    The name of the dataset.
  - withDatasetName
```
public CreateDatasetRequest withDatasetName(String datasetName)
```
    The name of the dataset.
    
    Parameters:
    
    datasetName - The name of the dataset.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getActions
```
public List<DatasetAction> getActions()
```
    A list of actions that create the dataset contents.
    
    Returns:
    
    A list of actions that create the dataset contents.
  - setActions
```
public void setActions(Collection<DatasetAction> actions)
```
    A list of actions that create the dataset contents.
    
    Parameters:
    
    actions - A list of actions that create the dataset contents.
  - withActions
```
public CreateDatasetRequest withActions(DatasetAction... actions)
```
    A list of actions that create the dataset contents.
    
    NOTE: This method appends the values to the existing list (if any). Use setActions(java.util.Collection) or withActions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    actions - A list of actions that create the dataset contents.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withActions
```
public CreateDatasetRequest withActions(Collection<DatasetAction> actions)
```
    A list of actions that create the dataset contents.
    
    Parameters:
    
    actions - A list of actions that create the dataset contents.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTriggers
```
public List<DatasetTrigger> getTriggers()
```
    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.
    
    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.
  - setTriggers
```
public void setTriggers(Collection<DatasetTrigger> 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.
    
    Parameters:
    
    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.
  - withTriggers
```
public CreateDatasetRequest withTriggers(DatasetTrigger... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setTriggers(java.util.Collection) or withTriggers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTriggers
```
public CreateDatasetRequest withTriggers(Collection<DatasetTrigger> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getContentDeliveryRules
```
public List<DatasetContentDeliveryRule> getContentDeliveryRules()
```
    When dataset contents are created, they are delivered to destinations specified here.
    
    Returns:
    
    When dataset contents are created, they are delivered to destinations specified here.
  - setContentDeliveryRules
```
public void setContentDeliveryRules(Collection<DatasetContentDeliveryRule> contentDeliveryRules)
```
    When dataset contents are created, they are delivered to destinations specified here.
    
    Parameters:
    
    contentDeliveryRules - When dataset contents are created, they are delivered to destinations specified here.
  - withContentDeliveryRules
```
public CreateDatasetRequest withContentDeliveryRules(DatasetContentDeliveryRule... contentDeliveryRules)
```
    When dataset contents are created, they are delivered to destinations specified here.
    
    NOTE: This method appends the values to the existing list (if any). Use setContentDeliveryRules(java.util.Collection) or withContentDeliveryRules(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    contentDeliveryRules - When dataset contents are created, they are delivered to destinations specified here.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withContentDeliveryRules
```
public CreateDatasetRequest withContentDeliveryRules(Collection<DatasetContentDeliveryRule> contentDeliveryRules)
```
    When dataset contents are created, they are delivered to destinations specified here.
    
    Parameters:
    
    contentDeliveryRules - When dataset contents are created, they are delivered to destinations specified here.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRetentionPeriod
```
public void setRetentionPeriod(RetentionPeriod 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 the versioningConfiguration parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
    
    Parameters:
    
    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 the versioningConfiguration parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
  - getRetentionPeriod
```
public RetentionPeriod getRetentionPeriod()
```
    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 the versioningConfiguration 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 the versioningConfiguration parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
  - withRetentionPeriod
```
public CreateDatasetRequest withRetentionPeriod(RetentionPeriod 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 the versioningConfiguration parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
    
    Parameters:
    
    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 the versioningConfiguration parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersioningConfiguration
```
public void setVersioningConfiguration(VersioningConfiguration 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.
    
    Parameters:
    
    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.
  - getVersioningConfiguration
```
public VersioningConfiguration getVersioningConfiguration()
```
    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.
  - withVersioningConfiguration
```
public CreateDatasetRequest withVersioningConfiguration(VersioningConfiguration 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    Metadata which can be used to manage the dataset.
    
    Returns:
    
    Metadata which can be used to manage the dataset.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    Metadata which can be used to manage the dataset.
    
    Parameters:
    
    tags - Metadata which can be used to manage the dataset.
  - withTags
```
public CreateDatasetRequest withTags(Tag... tags)
```
    Metadata which can be used to manage the dataset.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - Metadata which can be used to manage the dataset.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public CreateDatasetRequest withTags(Collection<Tag> tags)
```
    Metadata which can be used to manage the dataset.
    
    Parameters:
    
    tags - Metadata which can be used to manage the dataset.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getLateDataRules
```
public List<LateDataRule> getLateDataRules()
```
    A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.
    
    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.
  - setLateDataRules
```
public void setLateDataRules(Collection<LateDataRule> 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.
    
    Parameters:
    
    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.
  - withLateDataRules
```
public CreateDatasetRequest withLateDataRules(LateDataRule... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setLateDataRules(java.util.Collection) or withLateDataRules(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withLateDataRules
```
public CreateDatasetRequest withLateDataRules(Collection<LateDataRule> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateDatasetRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class CreateDatasetRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateDatasetRequest

Method Detail

setDatasetName

getDatasetName

withDatasetName

getActions

setActions

withActions

withActions

getTriggers

setTriggers

withTriggers

withTriggers

getContentDeliveryRules

setContentDeliveryRules

withContentDeliveryRules

withContentDeliveryRules

setRetentionPeriod

getRetentionPeriod

withRetentionPeriod

setVersioningConfiguration

getVersioningConfiguration

withVersioningConfiguration

getTags

setTags

withTags

withTags

getLateDataRules

setLateDataRules

withLateDataRules

withLateDataRules

toString

equals

hashCode

clone