@Generated(value="software.amazon.awssdk:codegen") public final class ImportJobResponse extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ImportJobResponse.Builder,ImportJobResponse>
Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.
| Modifier and Type | Class and Description |
|---|---|
static interface |
ImportJobResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
applicationId()
The unique identifier for the application that's associated with the import job.
|
static ImportJobResponse.Builder |
builder() |
Integer |
completedPieces()
The number of pieces that were processed successfully (completed) by the import job, as of the time of the
request.
|
String |
completionDate()
The date, in ISO 8601 format, when the import job was completed.
|
String |
creationDate()
The date, in ISO 8601 format, when the import job was created.
|
ImportJobResource |
definition()
The resource settings that apply to the import job.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
Integer |
failedPieces()
The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the
request.
|
List<String> |
failures()
An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the
import job, if any.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasFailures()
Returns true if the Failures property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
int |
hashCode() |
String |
id()
The unique identifier for the import job.
|
JobStatus |
jobStatus()
The status of the import job.
|
String |
jobStatusAsString()
The status of the import job.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ImportJobResponse.Builder> |
serializableBuilderClass() |
ImportJobResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
Integer |
totalFailures()
The total number of endpoint definitions that weren't processed successfully (failed) by the import job,
typically because an error, such as a syntax error, occurred.
|
Integer |
totalPieces()
The total number of pieces that must be processed to complete the import job.
|
Integer |
totalProcessed()
The total number of endpoint definitions that were processed by the import job.
|
String |
type()
The job type.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String applicationId()
The unique identifier for the application that's associated with the import job.
public final Integer completedPieces()
The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.
public final String completionDate()
The date, in ISO 8601 format, when the import job was completed.
public final String creationDate()
The date, in ISO 8601 format, when the import job was created.
public final ImportJobResource definition()
The resource settings that apply to the import job.
public final Integer failedPieces()
The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.
public final boolean hasFailures()
public final List<String> failures()
An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasFailures() to see if a value was sent in this field.
public final String id()
The unique identifier for the import job.
public final JobStatus jobStatus()
The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
If the service returns an enum value that is not available in the current SDK version, jobStatus will
return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
jobStatusAsString().
JobStatuspublic final String jobStatusAsString()
The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
If the service returns an enum value that is not available in the current SDK version, jobStatus will
return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
jobStatusAsString().
JobStatuspublic final Integer totalFailures()
The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.
public final Integer totalPieces()
The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.
public final Integer totalProcessed()
The total number of endpoint definitions that were processed by the import job.
public final String type()
The job type. This value is IMPORT for import jobs.
public ImportJobResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<ImportJobResponse.Builder,ImportJobResponse>public static ImportJobResponse.Builder builder()
public static Class<? extends ImportJobResponse.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2021. All rights reserved.