Package software.amazon.awssdk.services.pinpoint.model

Interface ExportJobResponse.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ExportJobResponse.Builder,ExportJobResponse>, SdkBuilder<ExportJobResponse.Builder,ExportJobResponse>, SdkPojo

Enclosing class:

ExportJobResponse

public static interface ExportJobResponse.Builder
extends SdkPojo, CopyableBuilder<ExportJobResponse.Builder,ExportJobResponse>

Method Summary

Modifier and Type	Method	Description
ExportJobResponse.Builder	applicationId(String applicationId)	The unique identifier for the application that's associated with the export job.
ExportJobResponse.Builder	completedPieces(Integer completedPieces)	The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
ExportJobResponse.Builder	completionDate(String completionDate)	The date, in ISO 8601 format, when the export job was completed.
ExportJobResponse.Builder	creationDate(String creationDate)	The date, in ISO 8601 format, when the export job was created.
default ExportJobResponse.Builder	definition(Consumer<ExportJobResource.Builder> definition)	The resource settings that apply to the export job.
ExportJobResponse.Builder	definition(ExportJobResource definition)	The resource settings that apply to the export job.
ExportJobResponse.Builder	failedPieces(Integer failedPieces)	The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
ExportJobResponse.Builder	failures(String... failures)	An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
ExportJobResponse.Builder	failures(Collection<String> failures)	An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
ExportJobResponse.Builder	id(String id)	The unique identifier for the export job.
ExportJobResponse.Builder	jobStatus(String jobStatus)	The status of the export job.
ExportJobResponse.Builder	jobStatus(JobStatus jobStatus)	The status of the export job.
ExportJobResponse.Builder	totalFailures(Integer totalFailures)	The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
ExportJobResponse.Builder	totalPieces(Integer totalPieces)	The total number of pieces that must be processed to complete the export job.
ExportJobResponse.Builder	totalProcessed(Integer totalProcessed)	The total number of endpoint definitions that were processed by the export job.
ExportJobResponse.Builder	type(String type)	The job type.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

applicationId

ExportJobResponse.Builder applicationId(String applicationId)

The unique identifier for the application that's associated with the export job.

Parameters:

applicationId - The unique identifier for the application that's associated with the export job.

Returns:

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

completedPieces

ExportJobResponse.Builder completedPieces(Integer completedPieces)

The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.

Parameters:

completedPieces - The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.

Returns:

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

completionDate

ExportJobResponse.Builder completionDate(String completionDate)

The date, in ISO 8601 format, when the export job was completed.

Parameters:

completionDate - The date, in ISO 8601 format, when the export job was completed.

Returns:

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

creationDate

ExportJobResponse.Builder creationDate(String creationDate)

The date, in ISO 8601 format, when the export job was created.

Parameters:

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

Returns:

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

definition

ExportJobResponse.Builder definition(ExportJobResource definition)

The resource settings that apply to the export job.

Parameters:

definition - The resource settings that apply to the export job.

Returns:

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

definition

default ExportJobResponse.Builder definition(Consumer<ExportJobResource.Builder> definition)

The resource settings that apply to the export job.

This is a convenience method that creates an instance of the ExportJobResource.Builder avoiding the need to create one manually via ExportJobResource.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to definition(ExportJobResource).

Parameters:

definition - a consumer that will call methods on ExportJobResource.Builder

Returns:

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

See Also:

definition(ExportJobResource)

failedPieces

ExportJobResponse.Builder failedPieces(Integer failedPieces)

The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.

Parameters:

failedPieces - The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.

Returns:

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

failures

ExportJobResponse.Builder failures(Collection<String> failures)

An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.

Parameters:

failures - An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.

Returns:

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

failures

ExportJobResponse.Builder failures(String... failures)

An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.

Parameters:

failures - An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.

Returns:

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

id

ExportJobResponse.Builder id(String id)

The unique identifier for the export job.

Parameters:

id - The unique identifier for the export job.

Returns:

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

jobStatus

ExportJobResponse.Builder jobStatus(String jobStatus)

The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

Parameters:

jobStatus - The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

Returns:

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

See Also:

JobStatus, JobStatus

jobStatus

ExportJobResponse.Builder jobStatus(JobStatus jobStatus)

The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

Parameters:

jobStatus - The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

Returns:

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

See Also:

JobStatus, JobStatus

totalFailures

ExportJobResponse.Builder totalFailures(Integer totalFailures)

The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.

Parameters:

totalFailures - The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.

Returns:

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

totalPieces

ExportJobResponse.Builder totalPieces(Integer totalPieces)

The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.

Parameters:

totalPieces - The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.

Returns:

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

totalProcessed

ExportJobResponse.Builder totalProcessed(Integer totalProcessed)

The total number of endpoint definitions that were processed by the export job.

Parameters:

totalProcessed - The total number of endpoint definitions that were processed by the export job.

Returns:

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

type

ExportJobResponse.Builder type(String type)

The job type. This value is EXPORT for export jobs.

Parameters:

type - The job type. This value is EXPORT for export jobs.

Returns:

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