software.amazon.awssdk.services.pinpoint.model

Class ExportJobResponse

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.ExportJobResponse

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ExportJobResponse.Builder,ExportJobResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class ExportJobResponse
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ExportJobResponse.Builder,ExportJobResponse>

Export job response.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExportJobResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	applicationId() The unique ID of the application associated with the export job.
static ExportJobResponse.Builder	builder()
Integer	completedPieces() The number of pieces that have successfully completed as of the time of the request.
String	completionDate() The date the job completed in ISO 8601 format.
String	creationDate() The date the job was created in ISO 8601 format.
ExportJobResource	definition() The export job settings.
boolean	equals(Object obj)
Integer	failedPieces() The number of pieces that failed to be processed as of the time of the request.
List<String>	failures() Provides up to 100 of the first failed entries for the job, if any exist.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The unique ID of the job.
JobStatus	jobStatus() The status of the job.
String	jobStatusAsString() The status of the job.
List<SdkField<?>>	sdkFields()
static Class<? extends ExportJobResponse.Builder>	serializableBuilderClass()
ExportJobResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Integer	totalFailures() The number of endpoints that were not processed; for example, because of syntax errors.
Integer	totalPieces() The total number of pieces that must be processed to finish the job.
Integer	totalProcessed() The number of endpoints that were processed by the job.
String	type() The job type.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

applicationId

public String applicationId()

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

Returns:

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

completedPieces

public Integer completedPieces()

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.

completionDate

public String completionDate()

The date the job completed in ISO 8601 format.

Returns:

The date the job completed in ISO 8601 format.

creationDate

public String creationDate()

The date the job was created in ISO 8601 format.

Returns:

The date the job was created in ISO 8601 format.

definition

public ExportJobResource definition()

The export job settings.

Returns:

The export job settings.

failedPieces

public Integer failedPieces()

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.

failures

public List<String> failures()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

id

public String id()

The unique ID of the job.

Returns:

The unique ID of the job.

jobStatus

public 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.

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

See Also:

JobStatus

jobStatusAsString

public String jobStatusAsString()

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.

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

See Also:

JobStatus

totalFailures

public Integer totalFailures()

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.

totalPieces

public 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.

Returns:

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

totalProcessed

public Integer totalProcessed()

The number of endpoints that were processed by the job.

Returns:

The number of endpoints that were processed by the job.

type

public String type()

The job type. Will be 'EXPORT'.

Returns:

The job type. Will be 'EXPORT'.

toBuilder

public ExportJobResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ExportJobResponse.Builder,ExportJobResponse>

Returns:

a builder for type T

builder

public static ExportJobResponse.Builder builder()

serializableBuilderClass

public static Class<? extends ExportJobResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.