ExportJobResponse (AWS Java SDK for Amazon Pinpoint 1.11.594 API)

java.lang.Object
- com.amazonaws.services.pinpoint.model.ExportJobResponse

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ExportJobResponse
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ExportJobResponse()

Constructors
Constructor and Description
`ExportJobResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ExportJobResponse`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getApplicationId()` The unique identifier for the application that's associated with the export job.
`Integer`	`getCompletedPieces()` The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
`String`	`getCompletionDate()` The date, in ISO 8601 format, when the export job was completed.
`String`	`getCreationDate()` The date, in ISO 8601 format, when the export job was created.
`ExportJobResource`	`getDefinition()` The resource settings that apply to the export job.
`Integer`	`getFailedPieces()` The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
`List<String>`	`getFailures()` An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
`String`	`getId()` The unique identifier for the export job.
`String`	`getJobStatus()` The status of the export job.
`Integer`	`getTotalFailures()` The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
`Integer`	`getTotalPieces()` The total number of pieces that must be processed to complete the export job.
`Integer`	`getTotalProcessed()` The total number of endpoint definitions that were processed by the export job.
`String`	`getType()` The job type.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setApplicationId(String applicationId)` The unique identifier for the application that's associated with the export job.
`void`	`setCompletedPieces(Integer completedPieces)` The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
`void`	`setCompletionDate(String completionDate)` The date, in ISO 8601 format, when the export job was completed.
`void`	`setCreationDate(String creationDate)` The date, in ISO 8601 format, when the export job was created.
`void`	`setDefinition(ExportJobResource definition)` The resource settings that apply to the export job.
`void`	`setFailedPieces(Integer failedPieces)` The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
`void`	`setFailures(Collection<String> failures)` An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
`void`	`setId(String id)` The unique identifier for the export job.
`void`	`setJobStatus(String jobStatus)` The status of the export job.
`void`	`setTotalFailures(Integer totalFailures)` The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
`void`	`setTotalPieces(Integer totalPieces)` The total number of pieces that must be processed to complete the export job.
`void`	`setTotalProcessed(Integer totalProcessed)` The total number of endpoint definitions that were processed by the export job.
`void`	`setType(String type)` The job type.
`String`	`toString()` Returns a string representation of this object.
`ExportJobResponse`	`withApplicationId(String applicationId)` The unique identifier for the application that's associated with the export job.
`ExportJobResponse`	`withCompletedPieces(Integer completedPieces)` The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
`ExportJobResponse`	`withCompletionDate(String completionDate)` The date, in ISO 8601 format, when the export job was completed.
`ExportJobResponse`	`withCreationDate(String creationDate)` The date, in ISO 8601 format, when the export job was created.
`ExportJobResponse`	`withDefinition(ExportJobResource definition)` The resource settings that apply to the export job.
`ExportJobResponse`	`withFailedPieces(Integer failedPieces)` The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
`ExportJobResponse`	`withFailures(Collection<String> failures)` An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
`ExportJobResponse`	`withFailures(String... failures)` An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
`ExportJobResponse`	`withId(String id)` The unique identifier for the export job.
`ExportJobResponse`	`withJobStatus(JobStatus jobStatus)` The status of the export job.
`ExportJobResponse`	`withJobStatus(String jobStatus)` The status of the export job.
`ExportJobResponse`	`withTotalFailures(Integer totalFailures)` The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
`ExportJobResponse`	`withTotalPieces(Integer totalPieces)` The total number of pieces that must be processed to complete the export job.
`ExportJobResponse`	`withTotalProcessed(Integer totalProcessed)` The total number of endpoint definitions that were processed by the export job.
`ExportJobResponse`	`withType(String type)` The job type.

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

- Constructor Detail
  - ExportJobResponse
```
public ExportJobResponse()
```
- Method Detail
  - setApplicationId
```
public void setApplicationId(String applicationId)
```
    The unique identifier for the application that's associated with the export job.
    
    Parameters:
    
    applicationId - The unique identifier for the application that's associated with the export job.
  - getApplicationId
```
public String getApplicationId()
```
    The unique identifier for the application that's associated with the export job.
    
    Returns:
    
    The unique identifier for the application that's associated with the export job.
  - withApplicationId
```
public ExportJobResponse withApplicationId(String applicationId)
```
    The unique identifier for the application that's associated with the export job.
    
    Parameters:
    
    applicationId - The unique identifier for the application that's associated with the export job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCompletedPieces
```
public void setCompletedPieces(Integer completedPieces)
```
    The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
    
    Parameters:
    
    completedPieces - The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
  - getCompletedPieces
```
public Integer getCompletedPieces()
```
    The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
    
    Returns:
    
    The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
  - withCompletedPieces
```
public ExportJobResponse withCompletedPieces(Integer completedPieces)
```
    The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
    
    Parameters:
    
    completedPieces - The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCompletionDate
```
public void setCompletionDate(String completionDate)
```
    The date, in ISO 8601 format, when the export job was completed.
    
    Parameters:
    
    completionDate - The date, in ISO 8601 format, when the export job was completed.
  - getCompletionDate
```
public String getCompletionDate()
```
    The date, in ISO 8601 format, when the export job was completed.
    
    Returns:
    
    The date, in ISO 8601 format, when the export job was completed.
  - withCompletionDate
```
public ExportJobResponse withCompletionDate(String completionDate)
```
    The date, in ISO 8601 format, when the export job was completed.
    
    Parameters:
    
    completionDate - The date, in ISO 8601 format, when the export job was completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(String creationDate)
```
    The date, in ISO 8601 format, when the export job was created.
    
    Parameters:
    
    creationDate - The date, in ISO 8601 format, when the export job was created.
  - getCreationDate
```
public String getCreationDate()
```
    The date, in ISO 8601 format, when the export job was created.
    
    Returns:
    
    The date, in ISO 8601 format, when the export job was created.
  - withCreationDate
```
public ExportJobResponse withCreationDate(String creationDate)
```
    The date, in ISO 8601 format, when the export job was created.
    
    Parameters:
    
    creationDate - The date, in ISO 8601 format, when the export job was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefinition
```
public void setDefinition(ExportJobResource definition)
```
    The resource settings that apply to the export job.
    
    Parameters:
    
    definition - The resource settings that apply to the export job.
  - getDefinition
```
public ExportJobResource getDefinition()
```
    The resource settings that apply to the export job.
    
    Returns:
    
    The resource settings that apply to the export job.
  - withDefinition
```
public ExportJobResponse withDefinition(ExportJobResource definition)
```
    The resource settings that apply to the export job.
    
    Parameters:
    
    definition - The resource settings that apply to the export job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailedPieces
```
public void setFailedPieces(Integer failedPieces)
```
    The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
    
    Parameters:
    
    failedPieces - The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
  - getFailedPieces
```
public Integer getFailedPieces()
```
    The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
    
    Returns:
    
    The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
  - withFailedPieces
```
public ExportJobResponse withFailedPieces(Integer failedPieces)
```
    The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
    
    Parameters:
    
    failedPieces - The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFailures
```
public List<String> getFailures()
```
    An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
    
    Returns:
    
    An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
  - setFailures
```
public void setFailures(Collection<String> failures)
```
    An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
    
    Parameters:
    
    failures - An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
  - withFailures
```
public ExportJobResponse withFailures(String... failures)
```
    An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
    
    NOTE: This method appends the values to the existing list (if any). Use setFailures(java.util.Collection) or withFailures(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    failures - An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFailures
```
public ExportJobResponse withFailures(Collection<String> failures)
```
    An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
    
    Parameters:
    
    failures - An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    The unique identifier for the export job.
    
    Parameters:
    
    id - The unique identifier for the export job.
  - getId
```
public String getId()
```
    The unique identifier for the export job.
    
    Returns:
    
    The unique identifier for the export job.
  - withId
```
public ExportJobResponse withId(String id)
```
    The unique identifier for the export job.
    
    Parameters:
    
    id - The unique identifier for the export job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobStatus
```
public void setJobStatus(String jobStatus)
```
    The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
    
    Parameters:
    
    jobStatus - The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
    
    See Also:
    
    JobStatus
  - getJobStatus
```
public String getJobStatus()
```
    The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
    
    Returns:
    
    The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
    
    See Also:
    
    JobStatus
  - withJobStatus
```
public ExportJobResponse withJobStatus(String jobStatus)
```
    The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
    
    Parameters:
    
    jobStatus - The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - withJobStatus
```
public ExportJobResponse withJobStatus(JobStatus jobStatus)
```
    The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
    
    Parameters:
    
    jobStatus - The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - setTotalFailures
```
public void setTotalFailures(Integer totalFailures)
```
    The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
    
    Parameters:
    
    totalFailures - The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
  - getTotalFailures
```
public Integer getTotalFailures()
```
    The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
    
    Returns:
    
    The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
  - withTotalFailures
```
public ExportJobResponse withTotalFailures(Integer totalFailures)
```
    The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
    
    Parameters:
    
    totalFailures - The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTotalPieces
```
public void setTotalPieces(Integer totalPieces)
```
    The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.
    
    Parameters:
    
    totalPieces - The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.
  - getTotalPieces
```
public Integer getTotalPieces()
```
    The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.
    
    Returns:
    
    The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.
  - withTotalPieces
```
public ExportJobResponse withTotalPieces(Integer totalPieces)
```
    The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.
    
    Parameters:
    
    totalPieces - The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTotalProcessed
```
public void setTotalProcessed(Integer totalProcessed)
```
    The total number of endpoint definitions that were processed by the export job.
    
    Parameters:
    
    totalProcessed - The total number of endpoint definitions that were processed by the export job.
  - getTotalProcessed
```
public Integer getTotalProcessed()
```
    The total number of endpoint definitions that were processed by the export job.
    
    Returns:
    
    The total number of endpoint definitions that were processed by the export job.
  - withTotalProcessed
```
public ExportJobResponse withTotalProcessed(Integer totalProcessed)
```
    The total number of endpoint definitions that were processed by the export job.
    
    Parameters:
    
    totalProcessed - The total number of endpoint definitions that were processed by the export job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The job type. This value is EXPORT for export jobs.
    
    Parameters:
    
    type - The job type. This value is EXPORT for export jobs.
  - getType
```
public String getType()
```
    The job type. This value is EXPORT for export jobs.
    
    Returns:
    
    The job type. This value is EXPORT for export jobs.
  - withType
```
public ExportJobResponse withType(String type)
```
    The job type. This value is EXPORT for export jobs.
    
    Parameters:
    
    type - The job type. This value is EXPORT for export jobs.
    
    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 ExportJobResponse clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class ExportJobResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExportJobResponse

Method Detail

setApplicationId

getApplicationId

withApplicationId

setCompletedPieces

getCompletedPieces

withCompletedPieces

setCompletionDate

getCompletionDate

withCompletionDate

setCreationDate

getCreationDate

withCreationDate

setDefinition

getDefinition

withDefinition

setFailedPieces

getFailedPieces

withFailedPieces

getFailures

setFailures

withFailures

withFailures

setId

getId

withId

setJobStatus

getJobStatus

withJobStatus

withJobStatus

setTotalFailures

getTotalFailures

withTotalFailures

setTotalPieces

getTotalPieces

withTotalPieces

setTotalProcessed

getTotalProcessed

withTotalProcessed

setType

getType

withType

toString

equals

hashCode

clone

marshall