com.amazonaws.services.pinpoint.model

Class ExportJobResponse

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

Export job response.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExportJobResponse()

Method Summary

Modifier and Type	Method and Description
ExportJobResponse	clone()
boolean	equals(Object obj)
String	getApplicationId() The unique ID of the application associated with the export job.
Integer	getCompletedPieces() The number of pieces that have successfully completed as of the time of the request.
String	getCompletionDate() The date the job completed in ISO 8601 format.
String	getCreationDate() The date the job was created in ISO 8601 format.
ExportJobResource	getDefinition() The export job settings.
Integer	getFailedPieces() The number of pieces that failed to be processed as of the time of the request.
List<String>	getFailures() Provides up to 100 of the first failed entries for the job, if any exist.
String	getId() The unique ID of the job.
String	getJobStatus() The status of the job.
Integer	getTotalFailures() The number of endpoints that were not processed; for example, because of syntax errors.
Integer	getTotalPieces() The total number of pieces that must be processed to finish the job.
Integer	getTotalProcessed() The number of endpoints that were processed by the job.
String	getType() The job type.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setApplicationId(String applicationId) The unique ID of the application associated with the export job.
void	setCompletedPieces(Integer completedPieces) The number of pieces that have successfully completed as of the time of the request.
void	setCompletionDate(String completionDate) The date the job completed in ISO 8601 format.
void	setCreationDate(String creationDate) The date the job was created in ISO 8601 format.
void	setDefinition(ExportJobResource definition) The export job settings.
void	setFailedPieces(Integer failedPieces) The number of pieces that failed to be processed as of the time of the request.
void	setFailures(Collection<String> failures) Provides up to 100 of the first failed entries for the job, if any exist.
void	setId(String id) The unique ID of the job.
void	setJobStatus(String jobStatus) The status of the job.
void	setTotalFailures(Integer totalFailures) The number of endpoints that were not processed; for example, because of syntax errors.
void	setTotalPieces(Integer totalPieces) The total number of pieces that must be processed to finish the job.
void	setTotalProcessed(Integer totalProcessed) The number of endpoints that were processed by the job.
void	setType(String type) The job type.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ExportJobResponse	withApplicationId(String applicationId) The unique ID of the application associated with the export job.
ExportJobResponse	withCompletedPieces(Integer completedPieces) The number of pieces that have successfully completed as of the time of the request.
ExportJobResponse	withCompletionDate(String completionDate) The date the job completed in ISO 8601 format.
ExportJobResponse	withCreationDate(String creationDate) The date the job was created in ISO 8601 format.
ExportJobResponse	withDefinition(ExportJobResource definition) The export job settings.
ExportJobResponse	withFailedPieces(Integer failedPieces) The number of pieces that failed to be processed as of the time of the request.
ExportJobResponse	withFailures(Collection<String> failures) Provides up to 100 of the first failed entries for the job, if any exist.
ExportJobResponse	withFailures(String... failures) Provides up to 100 of the first failed entries for the job, if any exist.
ExportJobResponse	withId(String id) The unique ID of the job.
ExportJobResponse	withJobStatus(JobStatus jobStatus) The status of the job.
ExportJobResponse	withJobStatus(String jobStatus) The status of the job.
ExportJobResponse	withTotalFailures(Integer totalFailures) The number of endpoints that were not processed; for example, because of syntax errors.
ExportJobResponse	withTotalPieces(Integer totalPieces) The total number of pieces that must be processed to finish the job.
ExportJobResponse	withTotalProcessed(Integer totalProcessed) The number of endpoints that were processed by the 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 ID of the application associated with the export job.

Parameters:

applicationId - The unique ID of the application associated with the export job.

getApplicationId

public String getApplicationId()

The unique ID of the application associated with the export job.

Returns:

The unique ID of the application associated with the export job.

withApplicationId

public ExportJobResponse withApplicationId(String applicationId)

The unique ID of the application associated with the export job.

Parameters:

applicationId - The unique ID of the application 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 have successfully completed as of the time of the request.

Parameters:

completedPieces - The number of pieces that have successfully completed as of the time of the request.

getCompletedPieces

public Integer getCompletedPieces()

The number of pieces that have successfully completed as of the time of the request.

Returns:

The number of pieces that have successfully completed as of the time of the request.

withCompletedPieces

public ExportJobResponse withCompletedPieces(Integer completedPieces)

The number of pieces that have successfully completed as of the time of the request.

Parameters:

completedPieces - The number of pieces that have successfully completed 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 the job completed in ISO 8601 format.

Parameters:

completionDate - The date the job completed in ISO 8601 format.

getCompletionDate

public String getCompletionDate()

The date the job completed in ISO 8601 format.

Returns:

The date the job completed in ISO 8601 format.

withCompletionDate

public ExportJobResponse withCompletionDate(String completionDate)

The date the job completed in ISO 8601 format.

Parameters:

completionDate - The date the job completed in ISO 8601 format.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCreationDate

public void setCreationDate(String creationDate)

The date the job was created in ISO 8601 format.

Parameters:

creationDate - The date the job was created in ISO 8601 format.

getCreationDate

public String getCreationDate()

The date the job was created in ISO 8601 format.

Returns:

The date the job was created in ISO 8601 format.

withCreationDate

public ExportJobResponse withCreationDate(String creationDate)

The date the job was created in ISO 8601 format.

Parameters:

creationDate - The date the job was created in ISO 8601 format.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDefinition

public void setDefinition(ExportJobResource definition)

The export job settings.

Parameters:

definition - The export job settings.

getDefinition

public ExportJobResource getDefinition()

The export job settings.

Returns:

The export job settings.

withDefinition

public ExportJobResponse withDefinition(ExportJobResource definition)

The export job settings.

Parameters:

definition - The export job settings.

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 failed to be processed as of the time of the request.

Parameters:

failedPieces - The number of pieces that failed to be processed as of the time of the request.

getFailedPieces

public Integer getFailedPieces()

The number of pieces that failed to be processed as of the time of the request.

Returns:

The number of pieces that failed to be processed as of the time of the request.

withFailedPieces

public ExportJobResponse withFailedPieces(Integer failedPieces)

The number of pieces that failed to be processed as of the time of the request.

Parameters:

failedPieces - The number of pieces that failed to be processed 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()

Provides up to 100 of the first failed entries for the job, if any exist.

Returns:

Provides up to 100 of the first failed entries for the job, if any exist.

setFailures

public void setFailures(Collection<String> failures)

Provides up to 100 of the first failed entries for the job, if any exist.

Parameters:

failures - Provides up to 100 of the first failed entries for the job, if any exist.

withFailures

public ExportJobResponse withFailures(String... failures)

Provides up to 100 of the first failed entries for the job, if any exist.

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 - Provides up to 100 of the first failed entries for the job, if any exist.

Returns:

Returns a reference to this object so that method calls can be chained together.

withFailures

public ExportJobResponse withFailures(Collection<String> failures)

Provides up to 100 of the first failed entries for the job, if any exist.

Parameters:

failures - Provides up to 100 of the first failed entries for the job, if any exist.

Returns:

Returns a reference to this object so that method calls can be chained together.

setId

public void setId(String id)

The unique ID of the job.

Parameters:

id - The unique ID of the job.

getId

public String getId()

The unique ID of the job.

Returns:

The unique ID of the job.

withId

public ExportJobResponse withId(String id)

The unique ID of the job.

Parameters:

id - The unique ID of the 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 job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed.

Parameters:

jobStatus - The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed.

See Also:

JobStatus

getJobStatus

public String getJobStatus()

The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed.

Returns:

The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed.

See Also:

JobStatus

withJobStatus

public ExportJobResponse withJobStatus(String jobStatus)

The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed.

Parameters:

jobStatus - The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed.

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 job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed.

Parameters:

jobStatus - The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed.

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 number of endpoints that were not processed; for example, because of syntax errors.

Parameters:

totalFailures - The number of endpoints that were not processed; for example, because of syntax errors.

getTotalFailures

public Integer getTotalFailures()

The number of endpoints that were not processed; for example, because of syntax errors.

Returns:

The number of endpoints that were not processed; for example, because of syntax errors.

withTotalFailures

public ExportJobResponse withTotalFailures(Integer totalFailures)

The number of endpoints that were not processed; for example, because of syntax errors.

Parameters:

totalFailures - The number of endpoints that were not processed; for example, because of syntax errors.

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 finish the job. Each piece is an approximately equal portion of the endpoints.

Parameters:

totalPieces - The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.

getTotalPieces

public Integer getTotalPieces()

The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.

Returns:

The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.

withTotalPieces

public ExportJobResponse withTotalPieces(Integer totalPieces)

The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.

Parameters:

totalPieces - The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTotalProcessed

public void setTotalProcessed(Integer totalProcessed)

The number of endpoints that were processed by the job.

Parameters:

totalProcessed - The number of endpoints that were processed by the job.

getTotalProcessed

public Integer getTotalProcessed()

The number of endpoints that were processed by the job.

Returns:

The number of endpoints that were processed by the job.

withTotalProcessed

public ExportJobResponse withTotalProcessed(Integer totalProcessed)

The number of endpoints that were processed by the job.

Parameters:

totalProcessed - The number of endpoints that were processed by the 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. Will be 'EXPORT'.

Parameters:

type - The job type. Will be 'EXPORT'.

getType

public String getType()

The job type. Will be 'EXPORT'.

Returns:

The job type. Will be 'EXPORT'.

withType

public ExportJobResponse withType(String type)

The job type. Will be 'EXPORT'.

Parameters:

type - The job type. Will be 'EXPORT'.

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; useful for testing and debugging.

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