Interface GetSearchResultExportJobResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,BackupSearchResponse.Builder
,Buildable
,CopyableBuilder<GetSearchResultExportJobResponse.Builder,
,GetSearchResultExportJobResponse> SdkBuilder<GetSearchResultExportJobResponse.Builder,
,GetSearchResultExportJobResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
GetSearchResultExportJobResponse
-
Method Summary
Modifier and TypeMethodDescriptioncompletionTime
(Instant completionTime) The date and time that an export job completed, in Unix format and Coordinated Universal Time (UTC).creationTime
(Instant creationTime) The date and time that an export job was created, in Unix format and Coordinated Universal Time (UTC).exportJobArn
(String exportJobArn) The unique Amazon Resource Name (ARN) that uniquely identifies the export job.exportJobIdentifier
(String exportJobIdentifier) This is the unique string that identifies the specified export job.exportSpecification
(Consumer<ExportSpecification.Builder> exportSpecification) The export specification consists of the destination S3 bucket to which the search results were exported, along with the destination prefix.exportSpecification
(ExportSpecification exportSpecification) The export specification consists of the destination S3 bucket to which the search results were exported, along with the destination prefix.searchJobArn
(String searchJobArn) The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.This is the current status of the export job.status
(ExportJobStatus status) This is the current status of the export job.statusMessage
(String statusMessage) A status message is a string that is returned for search job with a status ofFAILED
, along with steps to remedy and retry the operation.Methods inherited from interface software.amazon.awssdk.services.backupsearch.model.BackupSearchResponse.Builder
build, responseMetadata, responseMetadata
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, sdkFieldNameToField, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
exportJobIdentifier
This is the unique string that identifies the specified export job.
- Parameters:
exportJobIdentifier
- This is the unique string that identifies the specified export job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
exportJobArn
The unique Amazon Resource Name (ARN) that uniquely identifies the export job.
- Parameters:
exportJobArn
- The unique Amazon Resource Name (ARN) that uniquely identifies the export job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
This is the current status of the export job.
- Parameters:
status
- This is the current status of the export job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
This is the current status of the export job.
- Parameters:
status
- This is the current status of the export job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
creationTime
The date and time that an export job was created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationTime
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.- Parameters:
creationTime
- The date and time that an export job was created, in Unix format and Coordinated Universal Time (UTC). The value ofCreationTime
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
completionTime
The date and time that an export job completed, in Unix format and Coordinated Universal Time (UTC). The value of
CreationTime
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.- Parameters:
completionTime
- The date and time that an export job completed, in Unix format and Coordinated Universal Time (UTC). The value ofCreationTime
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statusMessage
A status message is a string that is returned for search job with a status of
FAILED
, along with steps to remedy and retry the operation.- Parameters:
statusMessage
- A status message is a string that is returned for search job with a status ofFAILED
, along with steps to remedy and retry the operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
exportSpecification
GetSearchResultExportJobResponse.Builder exportSpecification(ExportSpecification exportSpecification) The export specification consists of the destination S3 bucket to which the search results were exported, along with the destination prefix.
- Parameters:
exportSpecification
- The export specification consists of the destination S3 bucket to which the search results were exported, along with the destination prefix.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
exportSpecification
default GetSearchResultExportJobResponse.Builder exportSpecification(Consumer<ExportSpecification.Builder> exportSpecification) The export specification consists of the destination S3 bucket to which the search results were exported, along with the destination prefix.
This is a convenience method that creates an instance of theExportSpecification.Builder
avoiding the need to create one manually viaExportSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toexportSpecification(ExportSpecification)
.- Parameters:
exportSpecification
- a consumer that will call methods onExportSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
searchJobArn
The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.
- Parameters:
searchJobArn
- The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-