ImportJobResponse (AWS Java SDK :: Services :: Amazon Pinpoint 2.18.40 API)

java.lang.Object
- software.amazon.awssdk.services.pinpoint.model.ImportJobResponse

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ImportJobResponse.Builder,ImportJobResponse>
```
@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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ImportJobResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ImportJobResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` For responses, this returns true if the service returned a value for the Failures property.
`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.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - applicationId
```
public final String applicationId()
```
    The unique identifier for the application that's associated with the import job.
    
    Returns:
    
    The unique identifier for the application that's associated with the import job.
  - completedPieces
```
public final Integer completedPieces()
```
    The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.
    
    Returns:
    
    The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.
  - completionDate
```
public final String completionDate()
```
    The date, in ISO 8601 format, when the import job was completed.
    
    Returns:
    
    The date, in ISO 8601 format, when the import job was completed.
  - creationDate
```
public final String creationDate()
```
    The date, in ISO 8601 format, when the import job was created.
    
    Returns:
    
    The date, in ISO 8601 format, when the import job was created.
  - definition
```
public final ImportJobResource definition()
```
    The resource settings that apply to the import job.
    
    Returns:
    
    The resource settings that apply to the import job.
  - failedPieces
```
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.
    
    Returns:
    
    The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.
  - hasFailures
```
public final boolean hasFailures()
```
    For responses, this returns true if the service returned a value for the Failures property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - failures
```
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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFailures() method.
    
    Returns:
    
    An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.
  - id
```
public final String id()
```
    The unique identifier for the import job.
    
    Returns:
    
    The unique identifier for the import job.
  - jobStatus
```
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().
    
    Returns:
    
    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.
    
    See Also:
    
    JobStatus
  - jobStatusAsString
```
public 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().
    
    Returns:
    
    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.
    
    See Also:
    
    JobStatus
  - totalFailures
```
public 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.
    
    Returns:
    
    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.
  - totalPieces
```
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.
    
    Returns:
    
    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.
  - totalProcessed
```
public final Integer totalProcessed()
```
    The total number of endpoint definitions that were processed by the import job.
    
    Returns:
    
    The total number of endpoint definitions that were processed by the import job.
  - type
```
public final String type()
```
    The job type. This value is IMPORT for import jobs.
    
    Returns:
    
    The job type. This value is IMPORT for import jobs.
  - toBuilder
```
public ImportJobResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ImportJobResponse.Builder,ImportJobResponse>
  - builder
```
public static ImportJobResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ImportJobResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ImportJobResponse

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

applicationId

completedPieces

completionDate

creationDate

definition

failedPieces

hasFailures

failures

id

jobStatus

jobStatusAsString

totalFailures

totalPieces

totalProcessed

type

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields