Class DatasetExportJob
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DatasetExportJob.Builder,
DatasetExportJob>
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
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DatasetExportJob.Builder
builder()
final Instant
The creation date and time (in Unix time) of the dataset export job.final String
The Amazon Resource Name (ARN) of the dataset to export.final String
The Amazon Resource Name (ARN) of the dataset export job.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
If a dataset export job fails, provides the reason why.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final IngestionMode
The data to export, based on how you imported the data.final String
The data to export, based on how you imported the data.final String
jobName()
The name of the export job.final DatasetExportJobOutput
The path to the Amazon S3 bucket where the job's output is stored.final Instant
The date and time (in Unix time) the status of the dataset export job was last updated.final String
roleArn()
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.static Class
<? extends DatasetExportJob.Builder> final String
status()
The status of the dataset export job.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
jobName
The name of the export job.
- Returns:
- The name of the export job.
-
datasetExportJobArn
The Amazon Resource Name (ARN) of the dataset export job.
- Returns:
- The Amazon Resource Name (ARN) of the dataset export job.
-
datasetArn
The Amazon Resource Name (ARN) of the dataset to export.
- Returns:
- The Amazon Resource Name (ARN) of the dataset to export.
-
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), orALL
for both types. The default value isPUT
.If the service returns an enum value that is not available in the current SDK version,
ingestionMode
will returnIngestionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromingestionModeAsString()
.- Returns:
- 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), orALL
for both types. The default value isPUT
. - See Also:
-
ingestionModeAsString
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), orALL
for both types. The default value isPUT
.If the service returns an enum value that is not available in the current SDK version,
ingestionMode
will returnIngestionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromingestionModeAsString()
.- Returns:
- 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), orALL
for both types. The default value isPUT
. - See Also:
-
roleArn
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
- Returns:
- The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
-
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
- Returns:
- 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
-
-
-
jobOutput
The path to the Amazon S3 bucket where the job's output is stored. For example:
s3://bucket-name/folder-name/
- Returns:
- The path to the Amazon S3 bucket where the job's output is stored. For example:
s3://bucket-name/folder-name/
-
creationDateTime
The creation date and time (in Unix time) of the dataset export job.
- Returns:
- The creation date and time (in Unix time) of the dataset export job.
-
lastUpdatedDateTime
The date and time (in Unix time) the status of the dataset export job was last updated.
- Returns:
- The date and time (in Unix time) the status of the dataset export job was last updated.
-
failureReason
If a dataset export job fails, provides the reason why.
- Returns:
- If a dataset export job fails, provides the reason why.
-
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<DatasetExportJob.Builder,
DatasetExportJob> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-