DatasetExportJob (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.personalize.model.DatasetExportJob

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DatasetExportJob()

Constructors
Constructor and Description
`DatasetExportJob()`

Method Summary

All Methods Instance Methods Concrete Methods
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.

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

- Constructor Detail
  - DatasetExportJob
```
public DatasetExportJob()
```
- Method Detail
  - setJobName
```
public void setJobName(String jobName)
```
    The name of the export job.
    
    Parameters:
    
    jobName - The name of the export job.
  - getJobName
```
public String getJobName()
```
    The name of the export job.
    
    Returns:
    
    The name of the export job.
  - withJobName
```
public DatasetExportJob withJobName(String jobName)
```
    The name of the export job.
    
    Parameters:
    
    jobName - The name of the export job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDatasetExportJobArn
```
public void setDatasetExportJobArn(String datasetExportJobArn)
```
    The Amazon Resource Name (ARN) of the dataset export job.
    
    Parameters:
    
    datasetExportJobArn - The Amazon Resource Name (ARN) of the dataset export job.
  - getDatasetExportJobArn
```
public String getDatasetExportJobArn()
```
    The Amazon Resource Name (ARN) of the dataset export job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the dataset export job.
  - withDatasetExportJobArn
```
public DatasetExportJob withDatasetExportJobArn(String datasetExportJobArn)
```
    The Amazon Resource Name (ARN) of the dataset export job.
    
    Parameters:
    
    datasetExportJobArn - The Amazon Resource Name (ARN) of the dataset export job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDatasetArn
```
public void setDatasetArn(String datasetArn)
```
    The Amazon Resource Name (ARN) of the dataset to export.
    
    Parameters:
    
    datasetArn - The Amazon Resource Name (ARN) of the dataset to export.
  - getDatasetArn
```
public String getDatasetArn()
```
    The Amazon Resource Name (ARN) of the dataset to export.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the dataset to export.
  - withDatasetArn
```
public DatasetExportJob withDatasetArn(String datasetArn)
```
    The Amazon Resource Name (ARN) of the dataset to export.
    
    Parameters:
    
    datasetArn - The Amazon Resource Name (ARN) of the dataset to export.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIngestionMode
```
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.
    
    Parameters:
    
    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.
    
    See Also:
    
    IngestionMode
  - getIngestionMode
```
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.
    
    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), or ALL for both types. The default value is PUT.
    
    See Also:
    
    IngestionMode
  - withIngestionMode
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IngestionMode
  - withIngestionMode
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IngestionMode
  - setRoleArn
```
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.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
  - getRoleArn
```
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.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
  - withRoleArn
```
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.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
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
    Parameters:
    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
  - getStatus
```
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
    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
  - withStatus
```
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
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobOutput
```
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/
    
    Parameters:
    
    jobOutput - The path to the Amazon S3 bucket where the job's output is stored. For example:
    
    s3://bucket-name/folder-name/
  - getJobOutput
```
public DatasetExportJobOutput getJobOutput()
```
    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/
  - withJobOutput
```
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/
    
    Parameters:
    
    jobOutput - The path to the Amazon S3 bucket where the job's output is stored. For example:
    
    s3://bucket-name/folder-name/
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDateTime
```
public void setCreationDateTime(Date creationDateTime)
```
    The creation date and time (in Unix time) of the dataset export job.
    
    Parameters:
    
    creationDateTime - The creation date and time (in Unix time) of the dataset export job.
  - getCreationDateTime
```
public Date getCreationDateTime()
```
    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.
  - withCreationDateTime
```
public DatasetExportJob withCreationDateTime(Date creationDateTime)
```
    The creation date and time (in Unix time) of the dataset export job.
    
    Parameters:
    
    creationDateTime - The creation date and time (in Unix time) of the dataset export job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedDateTime
```
public void setLastUpdatedDateTime(Date lastUpdatedDateTime)
```
    The date and time (in Unix time) the status of the dataset export job was last updated.
    
    Parameters:
    
    lastUpdatedDateTime - The date and time (in Unix time) the status of the dataset export job was last updated.
  - getLastUpdatedDateTime
```
public Date getLastUpdatedDateTime()
```
    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.
  - withLastUpdatedDateTime
```
public DatasetExportJob withLastUpdatedDateTime(Date lastUpdatedDateTime)
```
    The date and time (in Unix time) the status of the dataset export job was last updated.
    
    Parameters:
    
    lastUpdatedDateTime - The date and time (in Unix time) the status of the dataset export job was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    If a dataset export job fails, provides the reason why.
    
    Parameters:
    
    failureReason - If a dataset export job fails, provides the reason why.
  - getFailureReason
```
public String getFailureReason()
```
    If a dataset export job fails, provides the reason why.
    
    Returns:
    
    If a dataset export job fails, provides the reason why.
  - withFailureReason
```
public DatasetExportJob withFailureReason(String failureReason)
```
    If a dataset export job fails, provides the reason why.
    
    Parameters:
    
    failureReason - If a dataset export job fails, provides the reason why.
    
    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 DatasetExportJob clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class DatasetExportJob

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DatasetExportJob

Method Detail

setJobName

getJobName

withJobName

setDatasetExportJobArn

getDatasetExportJobArn

withDatasetExportJobArn

setDatasetArn

getDatasetArn

withDatasetArn

setIngestionMode

getIngestionMode

withIngestionMode

withIngestionMode

setRoleArn

getRoleArn

withRoleArn

setStatus

getStatus

withStatus

setJobOutput

getJobOutput

withJobOutput

setCreationDateTime

getCreationDateTime

withCreationDateTime

setLastUpdatedDateTime

getLastUpdatedDateTime

withLastUpdatedDateTime

setFailureReason

getFailureReason

withFailureReason

toString

equals

hashCode

clone

marshall