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 and Description
ExportJobResponse.Builder	applicationId(String applicationId) The unique ID of the application associated with the export job.
ExportJobResponse.Builder	completedPieces(Integer completedPieces) The number of pieces that have successfully completed as of the time of the request.
ExportJobResponse.Builder	completionDate(String completionDate) The date the job completed in ISO 8601 format.
ExportJobResponse.Builder	creationDate(String creationDate) The date the job was created in ISO 8601 format.
default ExportJobResponse.Builder	definition(Consumer<ExportJobResource.Builder> definition) The export job settings.
ExportJobResponse.Builder	definition(ExportJobResource definition) The export job settings.
ExportJobResponse.Builder	failedPieces(Integer failedPieces) The number of pieces that failed to be processed as of the time of the request.
ExportJobResponse.Builder	failures(Collection<String> failures) Provides up to 100 of the first failed entries for the job, if any exist.
ExportJobResponse.Builder	failures(String... failures) Provides up to 100 of the first failed entries for the job, if any exist.
ExportJobResponse.Builder	id(String id) The unique ID of the job.
ExportJobResponse.Builder	jobStatus(JobStatus jobStatus) The status of the job.
ExportJobResponse.Builder	jobStatus(String jobStatus) The status of the job.
ExportJobResponse.Builder	totalFailures(Integer totalFailures) The number of endpoints that were not processed; for example, because of syntax errors.
ExportJobResponse.Builder	totalPieces(Integer totalPieces) The total number of pieces that must be processed to finish the job.
ExportJobResponse.Builder	totalProcessed(Integer totalProcessed) The number of endpoints that were processed by the job.
ExportJobResponse.Builder	type(String type) The job type.

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

sdkFields

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

copy

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

applyMutation, build

Method Detail

applicationId

ExportJobResponse.Builder applicationId(String applicationId)

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

Parameters:

applicationId - The unique ID of the application 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 have successfully completed as of the time of the request.

Parameters:

completedPieces - The number of pieces that have successfully completed 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 the job completed in ISO 8601 format.

Parameters:

completionDate - The date the job completed in ISO 8601 format.

Returns:

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

creationDate

ExportJobResponse.Builder creationDate(String creationDate)

The date the job was created in ISO 8601 format.

Parameters:

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

Returns:

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

definition

ExportJobResponse.Builder definition(ExportJobResource definition)

The export job settings.

Parameters:

definition - The export job settings.

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 export job settings. This is a convenience 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 failed to be processed as of the time of the request.

Parameters:

failedPieces - The number of pieces that failed to be processed 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)

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

Parameters:

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

Returns:

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

failures

ExportJobResponse.Builder failures(String... failures)

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

Parameters:

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

Returns:

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

id

ExportJobResponse.Builder id(String id)

The unique ID of the job.

Parameters:

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

Parameters:

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.

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

Parameters:

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.

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 number of endpoints that were not processed; for example, because of syntax errors.

Parameters:

totalFailures - The number of endpoints that were not processed; for example, because of syntax errors.

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 finish the job. Each piece is an approximately equal portion of the endpoints.

Parameters:

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:

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

totalProcessed

ExportJobResponse.Builder totalProcessed(Integer totalProcessed)

The number of endpoints that were processed by the job.

Parameters:

totalProcessed - The number of endpoints that were processed by the 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. Will be 'EXPORT'.

Parameters:

type - The job type. Will be 'EXPORT'.

Returns:

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