@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DatasetExportJob extends Object implements Serializable, Cloneable, StructuredPojo
Describes a job that exports a dataset to an Amazon S3 bucket. For more information, see CreateDatasetExportJob.
A dataset export job can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
Constructor and Description |
---|
DatasetExportJob() |
Modifier and Type | Method and Description |
---|---|
DatasetExportJob |
clone() |
boolean |
equals(Object obj) |
Date |
getCreationDateTime()
The creation date and time (in Unix time) of the dataset export job.
|
String |
getDatasetArn()
The Amazon Resource Name (ARN) of the dataset to export.
|
String |
getDatasetExportJobArn()
The Amazon Resource Name (ARN) of the dataset export job.
|
String |
getFailureReason()
If a dataset export job fails, provides the reason why.
|
String |
getIngestionMode()
The data to export, based on how you imported the data.
|
String |
getJobName()
The name of the export job.
|
DatasetExportJobOutput |
getJobOutput()
The path to the Amazon S3 bucket where the job's output is stored.
|
Date |
getLastUpdatedDateTime()
The date and time (in Unix time) the status of the dataset export job was last updated.
|
String |
getRoleArn()
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3
bucket.
|
String |
getStatus()
The status of the dataset export job.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCreationDateTime(Date creationDateTime)
The creation date and time (in Unix time) of the dataset export job.
|
void |
setDatasetArn(String datasetArn)
The Amazon Resource Name (ARN) of the dataset to export.
|
void |
setDatasetExportJobArn(String datasetExportJobArn)
The Amazon Resource Name (ARN) of the dataset export job.
|
void |
setFailureReason(String failureReason)
If a dataset export job fails, provides the reason why.
|
void |
setIngestionMode(String ingestionMode)
The data to export, based on how you imported the data.
|
void |
setJobName(String jobName)
The name of the export job.
|
void |
setJobOutput(DatasetExportJobOutput jobOutput)
The path to the Amazon S3 bucket where the job's output is stored.
|
void |
setLastUpdatedDateTime(Date lastUpdatedDateTime)
The date and time (in Unix time) the status of the dataset export job was last updated.
|
void |
setRoleArn(String roleArn)
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3
bucket.
|
void |
setStatus(String status)
The status of the dataset export job.
|
String |
toString()
Returns a string representation of this object.
|
DatasetExportJob |
withCreationDateTime(Date creationDateTime)
The creation date and time (in Unix time) of the dataset export job.
|
DatasetExportJob |
withDatasetArn(String datasetArn)
The Amazon Resource Name (ARN) of the dataset to export.
|
DatasetExportJob |
withDatasetExportJobArn(String datasetExportJobArn)
The Amazon Resource Name (ARN) of the dataset export job.
|
DatasetExportJob |
withFailureReason(String failureReason)
If a dataset export job fails, provides the reason why.
|
DatasetExportJob |
withIngestionMode(IngestionMode ingestionMode)
The data to export, based on how you imported the data.
|
DatasetExportJob |
withIngestionMode(String ingestionMode)
The data to export, based on how you imported the data.
|
DatasetExportJob |
withJobName(String jobName)
The name of the export job.
|
DatasetExportJob |
withJobOutput(DatasetExportJobOutput jobOutput)
The path to the Amazon S3 bucket where the job's output is stored.
|
DatasetExportJob |
withLastUpdatedDateTime(Date lastUpdatedDateTime)
The date and time (in Unix time) the status of the dataset export job was last updated.
|
DatasetExportJob |
withRoleArn(String roleArn)
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3
bucket.
|
DatasetExportJob |
withStatus(String status)
The status of the dataset export job.
|
public void setJobName(String jobName)
The name of the export job.
jobName
- The name of the export job.public String getJobName()
The name of the export job.
public DatasetExportJob withJobName(String jobName)
The name of the export job.
jobName
- The name of the export job.public void setDatasetExportJobArn(String datasetExportJobArn)
The Amazon Resource Name (ARN) of the dataset export job.
datasetExportJobArn
- The Amazon Resource Name (ARN) of the dataset export job.public String getDatasetExportJobArn()
The Amazon Resource Name (ARN) of the dataset export job.
public DatasetExportJob withDatasetExportJobArn(String datasetExportJobArn)
The Amazon Resource Name (ARN) of the dataset export job.
datasetExportJobArn
- The Amazon Resource Name (ARN) of the dataset export job.public void setDatasetArn(String datasetArn)
The Amazon Resource Name (ARN) of the dataset to export.
datasetArn
- The Amazon Resource Name (ARN) of the dataset to export.public String getDatasetArn()
The Amazon Resource Name (ARN) of the dataset to export.
public DatasetExportJob withDatasetArn(String datasetArn)
The Amazon Resource Name (ARN) of the dataset to export.
datasetArn
- The Amazon Resource Name (ARN) of the dataset to export.public void setIngestionMode(String ingestionMode)
The data to export, based on how you imported the data. You can choose to export BULK
data that you
imported using a dataset import job, PUT
data that you imported incrementally (using the console,
PutEvents, PutUsers and PutItems operations), or ALL
for both types. The default value is
PUT
.
ingestionMode
- The data to export, based on how you imported the data. You can choose to export BULK
data
that you imported using a dataset import job, PUT
data that you imported incrementally (using
the console, PutEvents, PutUsers and PutItems operations), or ALL
for both types. The default
value is PUT
.IngestionMode
public String getIngestionMode()
The data to export, based on how you imported the data. You can choose to export BULK
data that you
imported using a dataset import job, PUT
data that you imported incrementally (using the console,
PutEvents, PutUsers and PutItems operations), or ALL
for both types. The default value is
PUT
.
BULK
data
that you imported using a dataset import job, PUT
data that you imported incrementally
(using the console, PutEvents, PutUsers and PutItems operations), or ALL
for both types. The
default value is PUT
.IngestionMode
public DatasetExportJob withIngestionMode(String ingestionMode)
The data to export, based on how you imported the data. You can choose to export BULK
data that you
imported using a dataset import job, PUT
data that you imported incrementally (using the console,
PutEvents, PutUsers and PutItems operations), or ALL
for both types. The default value is
PUT
.
ingestionMode
- The data to export, based on how you imported the data. You can choose to export BULK
data
that you imported using a dataset import job, PUT
data that you imported incrementally (using
the console, PutEvents, PutUsers and PutItems operations), or ALL
for both types. The default
value is PUT
.IngestionMode
public DatasetExportJob withIngestionMode(IngestionMode ingestionMode)
The data to export, based on how you imported the data. You can choose to export BULK
data that you
imported using a dataset import job, PUT
data that you imported incrementally (using the console,
PutEvents, PutUsers and PutItems operations), or ALL
for both types. The default value is
PUT
.
ingestionMode
- The data to export, based on how you imported the data. You can choose to export BULK
data
that you imported using a dataset import job, PUT
data that you imported incrementally (using
the console, PutEvents, PutUsers and PutItems operations), or ALL
for both types. The default
value is PUT
.IngestionMode
public void setRoleArn(String roleArn)
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
roleArn
- The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output
Amazon S3 bucket.public String getRoleArn()
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
public DatasetExportJob withRoleArn(String roleArn)
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
roleArn
- The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output
Amazon S3 bucket.public void setStatus(String status)
The status of the dataset export job.
A dataset export job can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
status
- The status of the dataset export job.
A dataset export job can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
public String getStatus()
The status of the dataset export job.
A dataset export job can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
A dataset export job can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
public DatasetExportJob withStatus(String status)
The status of the dataset export job.
A dataset export job can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
status
- The status of the dataset export job.
A dataset export job can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
public void setJobOutput(DatasetExportJobOutput jobOutput)
The path to the Amazon S3 bucket where the job's output is stored. For example:
s3://bucket-name/folder-name/
jobOutput
- The path to the Amazon S3 bucket where the job's output is stored. For example:
s3://bucket-name/folder-name/
public DatasetExportJobOutput getJobOutput()
The path to the Amazon S3 bucket where the job's output is stored. For example:
s3://bucket-name/folder-name/
s3://bucket-name/folder-name/
public DatasetExportJob withJobOutput(DatasetExportJobOutput jobOutput)
The path to the Amazon S3 bucket where the job's output is stored. For example:
s3://bucket-name/folder-name/
jobOutput
- The path to the Amazon S3 bucket where the job's output is stored. For example:
s3://bucket-name/folder-name/
public void setCreationDateTime(Date creationDateTime)
The creation date and time (in Unix time) of the dataset export job.
creationDateTime
- The creation date and time (in Unix time) of the dataset export job.public Date getCreationDateTime()
The creation date and time (in Unix time) of the dataset export job.
public DatasetExportJob withCreationDateTime(Date creationDateTime)
The creation date and time (in Unix time) of the dataset export job.
creationDateTime
- The creation date and time (in Unix time) of the dataset export job.public void setLastUpdatedDateTime(Date lastUpdatedDateTime)
The date and time (in Unix time) the status of the dataset export job was last updated.
lastUpdatedDateTime
- The date and time (in Unix time) the status of the dataset export job was last updated.public Date getLastUpdatedDateTime()
The date and time (in Unix time) the status of the dataset export job was last updated.
public DatasetExportJob withLastUpdatedDateTime(Date lastUpdatedDateTime)
The date and time (in Unix time) the status of the dataset export job was last updated.
lastUpdatedDateTime
- The date and time (in Unix time) the status of the dataset export job was last updated.public void setFailureReason(String failureReason)
If a dataset export job fails, provides the reason why.
failureReason
- If a dataset export job fails, provides the reason why.public String getFailureReason()
If a dataset export job fails, provides the reason why.
public DatasetExportJob withFailureReason(String failureReason)
If a dataset export job fails, provides the reason why.
failureReason
- If a dataset export job fails, provides the reason why.public String toString()
toString
in class Object
Object.toString()
public DatasetExportJob clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.