public class GenerateDataSetRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
GenerateDataSetRequest() |
| Modifier and Type | Method and Description |
|---|---|
GenerateDataSetRequest |
addCustomerDefinedValuesEntry(String key,
String value) |
GenerateDataSetRequest |
clearCustomerDefinedValuesEntries()
Removes all the entries added into CustomerDefinedValues.
|
GenerateDataSetRequest |
clone() |
boolean |
equals(Object obj) |
Map<String,String> |
getCustomerDefinedValues()
(Optional) Key-value pairs which will be returned, unmodified, in the
Amazon SNS notification message and the data set metadata file.
|
Date |
getDataSetPublicationDate()
The date a data set was published.
|
String |
getDataSetType()
The desired data set type.
|
String |
getDestinationS3BucketName()
The name (friendly name, not ARN) of the destination S3 bucket.
|
String |
getDestinationS3Prefix()
(Optional) The desired S3 prefix for the published data set, similar to a
directory path in standard file systems.
|
String |
getRoleNameArn()
The Amazon Resource Name (ARN) of the Role with an attached permissions
policy to interact with the provided AWS services.
|
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(Map<String,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(Date dataSetPublicationDate)
The date a data set was published.
|
void |
setDataSetType(DataSetType dataSetType)
The desired data set type.
|
void |
setDataSetType(String dataSetType)
The desired data set type.
|
void |
setDestinationS3BucketName(String destinationS3BucketName)
The name (friendly name, not ARN) of the destination S3 bucket.
|
void |
setDestinationS3Prefix(String destinationS3Prefix)
(Optional) The desired S3 prefix for the published data set, similar to a
directory path in standard file systems.
|
void |
setRoleNameArn(String roleNameArn)
The Amazon Resource Name (ARN) of the Role with an attached permissions
policy to interact with the provided AWS services.
|
void |
setSnsTopicArn(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.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
GenerateDataSetRequest |
withCustomerDefinedValues(Map<String,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(Date dataSetPublicationDate)
The date a data set was published.
|
GenerateDataSetRequest |
withDataSetType(DataSetType dataSetType)
The desired data set type.
|
GenerateDataSetRequest |
withDataSetType(String dataSetType)
The desired data set type.
|
GenerateDataSetRequest |
withDestinationS3BucketName(String destinationS3BucketName)
The name (friendly name, not ARN) of the destination S3 bucket.
|
GenerateDataSetRequest |
withDestinationS3Prefix(String destinationS3Prefix)
(Optional) The desired S3 prefix for the published data set, similar to a
directory path in standard file systems.
|
GenerateDataSetRequest |
withRoleNameArn(String roleNameArn)
The Amazon Resource Name (ARN) of the Role with an attached permissions
policy to interact with the provided AWS services.
|
GenerateDataSetRequest |
withSnsTopicArn(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, withSdkRequestTimeoutpublic void setDataSetType(String dataSetType)
The desired data set type.
dataSetType - The desired data set type.
DataSetTypepublic String getDataSetType()
The desired data set type.
DataSetTypepublic GenerateDataSetRequest withDataSetType(String dataSetType)
The desired data set type.
dataSetType - The desired data set type.
DataSetTypepublic void setDataSetType(DataSetType dataSetType)
The desired data set type.
dataSetType - The desired data set type.
DataSetTypepublic GenerateDataSetRequest withDataSetType(DataSetType dataSetType)
The desired data set type.
dataSetType - The desired data set type.
DataSetTypepublic void setDataSetPublicationDate(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 Date getDataSetPublicationDate()
public GenerateDataSetRequest withDataSetPublicationDate(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(String roleNameArn)
roleNameArn - The Amazon Resource Name (ARN) of the Role with an attached
permissions policy to interact with the provided AWS services.public String getRoleNameArn()
public GenerateDataSetRequest withRoleNameArn(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(String destinationS3BucketName)
destinationS3BucketName - The name (friendly name, not ARN) of the destination S3 bucket.public String getDestinationS3BucketName()
public GenerateDataSetRequest withDestinationS3BucketName(String destinationS3BucketName)
destinationS3BucketName - The name (friendly name, not ARN) of the destination S3 bucket.public void setDestinationS3Prefix(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 String getDestinationS3Prefix()
public GenerateDataSetRequest withDestinationS3Prefix(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(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 String getSnsTopicArn()
public GenerateDataSetRequest withSnsTopicArn(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 Map<String,String> getCustomerDefinedValues()
public void setCustomerDefinedValues(Map<String,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(Map<String,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(String key, String value)
public GenerateDataSetRequest clearCustomerDefinedValuesEntries()
public String toString()
toString in class ObjectObject.toString()public GenerateDataSetRequest clone()
clone in class AmazonWebServiceRequestCopyright © 2016. All rights reserved.