software.amazon.awssdk.services.pinpoint.model

Interface ImportJobResponse.Builder

All Superinterfaces:

CopyableBuilder<ImportJobResponse.Builder,ImportJobResponse>, SdkBuilder<ImportJobResponse.Builder,ImportJobResponse>

Enclosing class:

ImportJobResponse

public static interface ImportJobResponse.Builder
extends CopyableBuilder<ImportJobResponse.Builder,ImportJobResponse>

Method Summary

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

apply, build

Method Detail

applicationId

ImportJobResponse.Builder applicationId(String applicationId)

The unique ID of the application to which the import job applies.

Parameters:

applicationId - The unique ID of the application to which the import job applies.

Returns:

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

completedPieces

ImportJobResponse.Builder completedPieces(Integer completedPieces)

The number of pieces that have successfully imported as of the time of the request.

Parameters:

completedPieces - The number of pieces that have successfully imported as of the time of the request.

Returns:

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

completionDate

ImportJobResponse.Builder completionDate(String completionDate)

The date the import job completed in ISO 8601 format.

Parameters:

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

Returns:

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

creationDate

ImportJobResponse.Builder creationDate(String creationDate)

The date the import job was created in ISO 8601 format.

Parameters:

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

Returns:

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

definition

ImportJobResponse.Builder definition(ImportJobResource definition)

The import job settings.

Parameters:

definition - The import job settings.

Returns:

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

definition

default ImportJobResponse.Builder definition(Consumer<ImportJobResource.Builder> definition)

The import job settings. This is a convenience that creates an instance of the ImportJobResource.Builder avoiding the need to create one manually via ImportJobResource.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to definition(ImportJobResource).

Parameters:

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

Returns:

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

See Also:

definition(ImportJobResource)

failedPieces

ImportJobResponse.Builder failedPieces(Integer failedPieces)

The number of pieces that have failed to import as of the time of the request.

Parameters:

failedPieces - The number of pieces that have failed to import as of the time of the request.

Returns:

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

failures

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

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

ImportJobResponse.Builder id(String id)

The unique ID of the import job.

Parameters:

id - The unique ID of the import job.

Returns:

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

jobStatus

ImportJobResponse.Builder jobStatus(String jobStatus)

The status of the import job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed to import.

Parameters:

jobStatus - The status of the import job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed to import.

Returns:

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

See Also:

JobStatus, JobStatus

jobStatus

ImportJobResponse.Builder jobStatus(JobStatus jobStatus)

The status of the import job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed to import.

Parameters:

jobStatus - The status of the import job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed to import.

Returns:

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

See Also:

JobStatus, JobStatus

totalFailures

ImportJobResponse.Builder totalFailures(Integer totalFailures)

The number of endpoints that failed to import; for example, because of syntax errors.

Parameters:

totalFailures - The number of endpoints that failed to import; for example, because of syntax errors.

Returns:

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

totalPieces

ImportJobResponse.Builder totalPieces(Integer totalPieces)

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

Parameters:

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

Returns:

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

totalProcessed

ImportJobResponse.Builder totalProcessed(Integer totalProcessed)

The number of endpoints that were processed by the import job.

Parameters:

totalProcessed - The number of endpoints that were processed by the import job.

Returns:

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

type

ImportJobResponse.Builder type(String type)

The job type. Will be Import.

Parameters:

type - The job type. Will be Import.

Returns:

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