public class ExportJobResponse extends Object implements Serializable
| Constructor and Description |
|---|
ExportJobResponse() |
| Modifier and Type | Method and Description |
|---|---|
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 |
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(JobStatus jobStatus)
The status 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.
|
public String getApplicationId()
public void setApplicationId(String applicationId)
applicationId - The unique ID of the application associated with the
export job.public ExportJobResponse withApplicationId(String applicationId)
Returns a reference to this object so that method calls can be chained together.
applicationId - The unique ID of the application associated with the
export job.public Integer getCompletedPieces()
public void setCompletedPieces(Integer completedPieces)
completedPieces - The number of pieces that have successfully
completed as of the time of the request.public ExportJobResponse withCompletedPieces(Integer completedPieces)
Returns a reference to this object so that method calls can be chained together.
completedPieces - The number of pieces that have successfully
completed as of the time of the request.public String getCompletionDate()
public void setCompletionDate(String completionDate)
completionDate - The date the job completed in ISO 8601 format.public ExportJobResponse withCompletionDate(String completionDate)
Returns a reference to this object so that method calls can be chained together.
completionDate - The date the job completed in ISO 8601 format.public String getCreationDate()
public void setCreationDate(String creationDate)
creationDate - The date the job was created in ISO 8601 format.public ExportJobResponse withCreationDate(String creationDate)
Returns a reference to this object so that method calls can be chained together.
creationDate - The date the job was created in ISO 8601 format.public ExportJobResource getDefinition()
public void setDefinition(ExportJobResource definition)
definition - The export job settings.public ExportJobResponse withDefinition(ExportJobResource definition)
Returns a reference to this object so that method calls can be chained together.
definition - The export job settings.public Integer getFailedPieces()
public void setFailedPieces(Integer failedPieces)
failedPieces - The number of pieces that failed to be processed as
of the time of the request.public ExportJobResponse withFailedPieces(Integer failedPieces)
Returns a reference to this object so that method calls can be chained together.
failedPieces - The number of pieces that failed to be processed as
of the time of the request.public List<String> getFailures()
public void setFailures(Collection<String> failures)
failures - Provides up to 100 of the first failed entries for the
job, if any exist.public ExportJobResponse withFailures(String... failures)
Returns a reference to this object so that method calls can be chained together.
failures - Provides up to 100 of the first failed entries for the
job, if any exist.public ExportJobResponse withFailures(Collection<String> failures)
Returns a reference to this object so that method calls can be chained together.
failures - Provides up to 100 of the first failed entries for the
job, if any exist.public String getId()
public void setId(String id)
id - The unique ID of the job.public ExportJobResponse withId(String id)
Returns a reference to this object so that method calls can be chained together.
id - The unique ID of the job.public String getJobStatus()
Constraints:
Allowed Values: CREATED, INITIALIZING, PROCESSING, COMPLETING,
COMPLETED, FAILING, FAILED
JobStatuspublic void setJobStatus(String jobStatus)
Constraints:
Allowed Values: CREATED, INITIALIZING, PROCESSING, COMPLETING,
COMPLETED, FAILING, FAILED
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.JobStatuspublic ExportJobResponse withJobStatus(String jobStatus)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CREATED, INITIALIZING, PROCESSING, COMPLETING,
COMPLETED, FAILING, FAILED
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.JobStatuspublic void setJobStatus(JobStatus jobStatus)
Constraints:
Allowed Values: CREATED, INITIALIZING, PROCESSING, COMPLETING,
COMPLETED, FAILING, FAILED
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.JobStatuspublic ExportJobResponse withJobStatus(JobStatus jobStatus)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CREATED, INITIALIZING, PROCESSING, COMPLETING,
COMPLETED, FAILING, FAILED
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.JobStatuspublic Integer getTotalFailures()
public void setTotalFailures(Integer totalFailures)
totalFailures - The number of endpoints that were not processed; for
example, because of syntax errors.public ExportJobResponse withTotalFailures(Integer totalFailures)
Returns a reference to this object so that method calls can be chained together.
totalFailures - The number of endpoints that were not processed; for
example, because of syntax errors.public Integer getTotalPieces()
public void setTotalPieces(Integer totalPieces)
totalPieces - The total number of pieces that must be processed to
finish the job. Each piece is an approximately equal portion
of the endpoints.public ExportJobResponse withTotalPieces(Integer totalPieces)
Returns a reference to this object so that method calls can be chained together.
totalPieces - The total number of pieces that must be processed to
finish the job. Each piece is an approximately equal portion
of the endpoints.public Integer getTotalProcessed()
public void setTotalProcessed(Integer totalProcessed)
totalProcessed - The number of endpoints that were processed by the
job.public ExportJobResponse withTotalProcessed(Integer totalProcessed)
Returns a reference to this object so that method calls can be chained together.
totalProcessed - The number of endpoints that were processed by the
job.public String getType()
public void setType(String type)
type - The job type. Will be 'EXPORT'.public ExportJobResponse withType(String type)
Returns a reference to this object so that method calls can be chained together.
type - The job type. Will be 'EXPORT'.public String toString()
toString in class ObjectObject.toString()Copyright © 2019. All rights reserved.