Interface GetUploadJobResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<GetUploadJobResponse.Builder,
,GetUploadJobResponse> CustomerProfilesResponse.Builder
,SdkBuilder<GetUploadJobResponse.Builder,
,GetUploadJobResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
GetUploadJobResponse
-
Method Summary
Modifier and TypeMethodDescriptioncompletedAt
(Instant completedAt) The timestamp when the upload job was completed.The timestamp when the upload job was created.dataExpiry
(Integer dataExpiry) The expiry duration for the profiles ingested with the upload job.displayName
(String displayName) The unique name of the upload job.fields
(Map<String, ObjectTypeField> fields) The mapping between CSV Columns and Profile Object attributes for the upload job.The unique identifier of the upload job.default GetUploadJobResponse.Builder
resultsSummary
(Consumer<ResultsSummary.Builder> resultsSummary) The summary of results for the upload job, including the number of updated, created, and failed records.resultsSummary
(ResultsSummary resultsSummary) The summary of results for the upload job, including the number of updated, created, and failed records.The status describing the status for the upload job.status
(UploadJobStatus status) The status describing the status for the upload job.statusReason
(String statusReason) The reason for the current status of the upload job.statusReason
(StatusReason statusReason) The reason for the current status of the upload job.The unique key columns used for de-duping the keys in the upload job.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
jobId
The unique identifier of the upload job.
- Parameters:
jobId
- The unique identifier of the upload job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
displayName
The unique name of the upload job. Could be a file name to identify the upload job.
- Parameters:
displayName
- The unique name of the upload job. Could be a file name to identify the upload job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
The status describing the status for the upload job. The following are Valid Values:
-
CREATED: The upload job has been created, but has not started processing yet.
-
IN_PROGRESS: The upload job is currently in progress, ingesting and processing the profile data.
-
PARTIALLY_SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.
-
SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.
-
FAILED: The upload job has failed to complete.
-
STOPPED: The upload job has been manually stopped or terminated before completion.
- Parameters:
status
- The status describing the status for the upload job. The following are Valid Values:-
CREATED: The upload job has been created, but has not started processing yet.
-
IN_PROGRESS: The upload job is currently in progress, ingesting and processing the profile data.
-
PARTIALLY_SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.
-
SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.
-
FAILED: The upload job has failed to complete.
-
STOPPED: The upload job has been manually stopped or terminated before completion.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
status
The status describing the status for the upload job. The following are Valid Values:
-
CREATED: The upload job has been created, but has not started processing yet.
-
IN_PROGRESS: The upload job is currently in progress, ingesting and processing the profile data.
-
PARTIALLY_SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.
-
SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.
-
FAILED: The upload job has failed to complete.
-
STOPPED: The upload job has been manually stopped or terminated before completion.
- Parameters:
status
- The status describing the status for the upload job. The following are Valid Values:-
CREATED: The upload job has been created, but has not started processing yet.
-
IN_PROGRESS: The upload job is currently in progress, ingesting and processing the profile data.
-
PARTIALLY_SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.
-
SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.
-
FAILED: The upload job has failed to complete.
-
STOPPED: The upload job has been manually stopped or terminated before completion.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
statusReason
The reason for the current status of the upload job. Possible reasons:
-
VALIDATION_FAILURE: The upload job has encountered an error or issue and was unable to complete the profile data ingestion.
-
INTERNAL_FAILURE: Failure caused from service side
- Parameters:
statusReason
- The reason for the current status of the upload job. Possible reasons:-
VALIDATION_FAILURE: The upload job has encountered an error or issue and was unable to complete the profile data ingestion.
-
INTERNAL_FAILURE: Failure caused from service side
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
statusReason
The reason for the current status of the upload job. Possible reasons:
-
VALIDATION_FAILURE: The upload job has encountered an error or issue and was unable to complete the profile data ingestion.
-
INTERNAL_FAILURE: Failure caused from service side
- Parameters:
statusReason
- The reason for the current status of the upload job. Possible reasons:-
VALIDATION_FAILURE: The upload job has encountered an error or issue and was unable to complete the profile data ingestion.
-
INTERNAL_FAILURE: Failure caused from service side
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
createdAt
The timestamp when the upload job was created.
- Parameters:
createdAt
- The timestamp when the upload job was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
completedAt
The timestamp when the upload job was completed.
- Parameters:
completedAt
- The timestamp when the upload job was completed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fields
The mapping between CSV Columns and Profile Object attributes for the upload job.
- Parameters:
fields
- The mapping between CSV Columns and Profile Object attributes for the upload job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
uniqueKey
The unique key columns used for de-duping the keys in the upload job.
- Parameters:
uniqueKey
- The unique key columns used for de-duping the keys in the upload job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resultsSummary
The summary of results for the upload job, including the number of updated, created, and failed records.
- Parameters:
resultsSummary
- The summary of results for the upload job, including the number of updated, created, and failed records.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resultsSummary
default GetUploadJobResponse.Builder resultsSummary(Consumer<ResultsSummary.Builder> resultsSummary) The summary of results for the upload job, including the number of updated, created, and failed records.
This is a convenience method that creates an instance of theResultsSummary.Builder
avoiding the need to create one manually viaResultsSummary.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toresultsSummary(ResultsSummary)
.- Parameters:
resultsSummary
- a consumer that will call methods onResultsSummary.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
dataExpiry
The expiry duration for the profiles ingested with the upload job.
- Parameters:
dataExpiry
- The expiry duration for the profiles ingested with the upload job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-