public class GenerateDataSetRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Modifier and Type | Field and Description |
---|---|
private java.util.Map<java.lang.String,java.lang.String> |
customerDefinedValues
(Optional) Key-value pairs which will be returned, unmodified, in the
Amazon SNS notification message and the data set metadata file.
|
private java.util.Date |
dataSetPublicationDate
The date a data set was published.
|
private java.lang.String |
dataSetType
The desired data set type.
|
private java.lang.String |
destinationS3BucketName
The name (friendly name, not ARN) of the destination S3 bucket.
|
private java.lang.String |
destinationS3Prefix
(Optional) The desired S3 prefix for the published data set, similar to a
directory path in standard file systems.
|
private java.lang.String |
roleNameArn
The Amazon Resource Name (ARN) of the Role with an attached permissions
policy to interact with the provided AWS services.
|
private java.lang.String |
snsTopicArn
Amazon Resource Name (ARN) for the SNS Topic that will be notified when
the data set has been published or if an error has occurred.
|
NOOP
Constructor and Description |
---|
GenerateDataSetRequest() |
Modifier and Type | Method and Description |
---|---|
GenerateDataSetRequest |
addCustomerDefinedValuesEntry(java.lang.String key,
java.lang.String value) |
GenerateDataSetRequest |
clearCustomerDefinedValuesEntries()
Removes all the entries added into CustomerDefinedValues.
|
GenerateDataSetRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.util.Map<java.lang.String,java.lang.String> |
getCustomerDefinedValues()
(Optional) Key-value pairs which will be returned, unmodified, in the
Amazon SNS notification message and the data set metadata file.
|
java.util.Date |
getDataSetPublicationDate()
The date a data set was published.
|
java.lang.String |
getDataSetType()
The desired data set type.
|
java.lang.String |
getDestinationS3BucketName()
The name (friendly name, not ARN) of the destination S3 bucket.
|
java.lang.String |
getDestinationS3Prefix()
(Optional) The desired S3 prefix for the published data set, similar to a
directory path in standard file systems.
|
java.lang.String |
getRoleNameArn()
The Amazon Resource Name (ARN) of the Role with an attached permissions
policy to interact with the provided AWS services.
|
java.lang.String |
getSnsTopicArn()
Amazon Resource Name (ARN) for the SNS Topic that will be notified when
the data set has been published or if an error has occurred.
|
int |
hashCode() |
void |
setCustomerDefinedValues(java.util.Map<java.lang.String,java.lang.String> customerDefinedValues)
(Optional) Key-value pairs which will be returned, unmodified, in the
Amazon SNS notification message and the data set metadata file.
|
void |
setDataSetPublicationDate(java.util.Date dataSetPublicationDate)
The date a data set was published.
|
void |
setDataSetType(DataSetType dataSetType)
The desired data set type.
|
void |
setDataSetType(java.lang.String dataSetType)
The desired data set type.
|
void |
setDestinationS3BucketName(java.lang.String destinationS3BucketName)
The name (friendly name, not ARN) of the destination S3 bucket.
|
void |
setDestinationS3Prefix(java.lang.String destinationS3Prefix)
(Optional) The desired S3 prefix for the published data set, similar to a
directory path in standard file systems.
|
void |
setRoleNameArn(java.lang.String roleNameArn)
The Amazon Resource Name (ARN) of the Role with an attached permissions
policy to interact with the provided AWS services.
|
void |
setSnsTopicArn(java.lang.String snsTopicArn)
Amazon Resource Name (ARN) for the SNS Topic that will be notified when
the data set has been published or if an error has occurred.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
GenerateDataSetRequest |
withCustomerDefinedValues(java.util.Map<java.lang.String,java.lang.String> customerDefinedValues)
(Optional) Key-value pairs which will be returned, unmodified, in the
Amazon SNS notification message and the data set metadata file.
|
GenerateDataSetRequest |
withDataSetPublicationDate(java.util.Date dataSetPublicationDate)
The date a data set was published.
|
GenerateDataSetRequest |
withDataSetType(DataSetType dataSetType)
The desired data set type.
|
GenerateDataSetRequest |
withDataSetType(java.lang.String dataSetType)
The desired data set type.
|
GenerateDataSetRequest |
withDestinationS3BucketName(java.lang.String destinationS3BucketName)
The name (friendly name, not ARN) of the destination S3 bucket.
|
GenerateDataSetRequest |
withDestinationS3Prefix(java.lang.String destinationS3Prefix)
(Optional) The desired S3 prefix for the published data set, similar to a
directory path in standard file systems.
|
GenerateDataSetRequest |
withRoleNameArn(java.lang.String roleNameArn)
The Amazon Resource Name (ARN) of the Role with an attached permissions
policy to interact with the provided AWS services.
|
GenerateDataSetRequest |
withSnsTopicArn(java.lang.String snsTopicArn)
Amazon Resource Name (ARN) for the SNS Topic that will be notified when
the data set has been published or if an error has occurred.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
private java.lang.String dataSetType
The desired data set type.
private java.util.Date dataSetPublicationDate
private java.lang.String roleNameArn
private java.lang.String destinationS3BucketName
private java.lang.String destinationS3Prefix
private java.lang.String snsTopicArn
private java.util.Map<java.lang.String,java.lang.String> customerDefinedValues
public void setDataSetType(java.lang.String dataSetType)
The desired data set type.
dataSetType
- The desired data set type.
DataSetType
public java.lang.String getDataSetType()
The desired data set type.
DataSetType
public GenerateDataSetRequest withDataSetType(java.lang.String dataSetType)
The desired data set type.
dataSetType
- The desired data set type.
DataSetType
public void setDataSetType(DataSetType dataSetType)
The desired data set type.
dataSetType
- The desired data set type.
DataSetType
public GenerateDataSetRequest withDataSetType(DataSetType dataSetType)
The desired data set type.
dataSetType
- The desired data set type.
DataSetType
public void setDataSetPublicationDate(java.util.Date dataSetPublicationDate)
dataSetPublicationDate
- The date a data set was published. For daily data sets, provide a
date with day-level granularity for the desired day. For weekly
data sets, provide a date with day-level granularity within the
desired week (the day value will be ignored). For monthly data
sets, provide a date with month-level granularity for the desired
month (the day value will be ignored).public java.util.Date getDataSetPublicationDate()
public GenerateDataSetRequest withDataSetPublicationDate(java.util.Date dataSetPublicationDate)
dataSetPublicationDate
- The date a data set was published. For daily data sets, provide a
date with day-level granularity for the desired day. For weekly
data sets, provide a date with day-level granularity within the
desired week (the day value will be ignored). For monthly data
sets, provide a date with month-level granularity for the desired
month (the day value will be ignored).public void setRoleNameArn(java.lang.String roleNameArn)
roleNameArn
- The Amazon Resource Name (ARN) of the Role with an attached
permissions policy to interact with the provided AWS services.public java.lang.String getRoleNameArn()
public GenerateDataSetRequest withRoleNameArn(java.lang.String roleNameArn)
roleNameArn
- The Amazon Resource Name (ARN) of the Role with an attached
permissions policy to interact with the provided AWS services.public void setDestinationS3BucketName(java.lang.String destinationS3BucketName)
destinationS3BucketName
- The name (friendly name, not ARN) of the destination S3 bucket.public java.lang.String getDestinationS3BucketName()
public GenerateDataSetRequest withDestinationS3BucketName(java.lang.String destinationS3BucketName)
destinationS3BucketName
- The name (friendly name, not ARN) of the destination S3 bucket.public void setDestinationS3Prefix(java.lang.String destinationS3Prefix)
destinationS3Prefix
- (Optional) The desired S3 prefix for the published data set,
similar to a directory path in standard file systems. For example,
if given the bucket name "mybucket" and the prefix
"myprefix/mydatasets", the output file "outputfile" would be
published to "s3://mybucket/myprefix/mydatasets/outputfile". If
the prefix directory structure does not exist, it will be created.
If no prefix is provided, the data set will be published to the S3
bucket root.public java.lang.String getDestinationS3Prefix()
public GenerateDataSetRequest withDestinationS3Prefix(java.lang.String destinationS3Prefix)
destinationS3Prefix
- (Optional) The desired S3 prefix for the published data set,
similar to a directory path in standard file systems. For example,
if given the bucket name "mybucket" and the prefix
"myprefix/mydatasets", the output file "outputfile" would be
published to "s3://mybucket/myprefix/mydatasets/outputfile". If
the prefix directory structure does not exist, it will be created.
If no prefix is provided, the data set will be published to the S3
bucket root.public void setSnsTopicArn(java.lang.String snsTopicArn)
snsTopicArn
- Amazon Resource Name (ARN) for the SNS Topic that will be notified
when the data set has been published or if an error has occurred.public java.lang.String getSnsTopicArn()
public GenerateDataSetRequest withSnsTopicArn(java.lang.String snsTopicArn)
snsTopicArn
- Amazon Resource Name (ARN) for the SNS Topic that will be notified
when the data set has been published or if an error has occurred.public java.util.Map<java.lang.String,java.lang.String> getCustomerDefinedValues()
public void setCustomerDefinedValues(java.util.Map<java.lang.String,java.lang.String> customerDefinedValues)
customerDefinedValues
- (Optional) Key-value pairs which will be returned, unmodified, in
the Amazon SNS notification message and the data set metadata
file. These key-value pairs can be used to correlated responses
with tracking information from other systems.public GenerateDataSetRequest withCustomerDefinedValues(java.util.Map<java.lang.String,java.lang.String> customerDefinedValues)
customerDefinedValues
- (Optional) Key-value pairs which will be returned, unmodified, in
the Amazon SNS notification message and the data set metadata
file. These key-value pairs can be used to correlated responses
with tracking information from other systems.public GenerateDataSetRequest addCustomerDefinedValuesEntry(java.lang.String key, java.lang.String value)
public GenerateDataSetRequest clearCustomerDefinedValuesEntries()
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public GenerateDataSetRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()