Interface StartSearchJobRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,BackupSearchRequest.Builder,Buildable,CopyableBuilder<StartSearchJobRequest.Builder,StartSearchJobRequest>,SdkBuilder<StartSearchJobRequest.Builder,StartSearchJobRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- StartSearchJobRequest
public static interface StartSearchJobRequest.Builder extends BackupSearchRequest.Builder, SdkPojo, CopyableBuilder<StartSearchJobRequest.Builder,StartSearchJobRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description StartSearchJobRequest.BuilderclientToken(String clientToken)Include this parameter to allow multiple identical calls for idempotency.StartSearchJobRequest.BuilderencryptionKeyArn(String encryptionKeyArn)The encryption key for the specified search job.default StartSearchJobRequest.BuilderitemFilters(Consumer<ItemFilters.Builder> itemFilters)Item Filters represent all input item properties specified when the search was created.StartSearchJobRequest.BuilderitemFilters(ItemFilters itemFilters)Item Filters represent all input item properties specified when the search was created.StartSearchJobRequest.Buildername(String name)Include alphanumeric characters to create a name for this search job.StartSearchJobRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)StartSearchJobRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)default StartSearchJobRequest.BuildersearchScope(Consumer<SearchScope.Builder> searchScope)This object can contain BackupResourceTypes, BackupResourceArns, BackupResourceCreationTime, BackupResourceTags, and SourceResourceArns to filter the recovery points returned by the search job.StartSearchJobRequest.BuildersearchScope(SearchScope searchScope)This object can contain BackupResourceTypes, BackupResourceArns, BackupResourceCreationTime, BackupResourceTags, and SourceResourceArns to filter the recovery points returned by the search job.StartSearchJobRequest.Buildertags(Map<String,String> tags)List of tags returned by the operation.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.services.backupsearch.model.BackupSearchRequest.Builder
build
-
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
-
-
-
-
Method Detail
-
tags
StartSearchJobRequest.Builder tags(Map<String,String> tags)
List of tags returned by the operation.
- Parameters:
tags- List of tags returned by the operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
StartSearchJobRequest.Builder name(String name)
Include alphanumeric characters to create a name for this search job.
- Parameters:
name- Include alphanumeric characters to create a name for this search job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encryptionKeyArn
StartSearchJobRequest.Builder encryptionKeyArn(String encryptionKeyArn)
The encryption key for the specified search job.
- Parameters:
encryptionKeyArn- The encryption key for the specified search job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientToken
StartSearchJobRequest.Builder clientToken(String clientToken)
Include this parameter to allow multiple identical calls for idempotency.
A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.
- Parameters:
clientToken- Include this parameter to allow multiple identical calls for idempotency.A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
searchScope
StartSearchJobRequest.Builder searchScope(SearchScope searchScope)
This object can contain BackupResourceTypes, BackupResourceArns, BackupResourceCreationTime, BackupResourceTags, and SourceResourceArns to filter the recovery points returned by the search job.
- Parameters:
searchScope- This object can contain BackupResourceTypes, BackupResourceArns, BackupResourceCreationTime, BackupResourceTags, and SourceResourceArns to filter the recovery points returned by the search job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
searchScope
default StartSearchJobRequest.Builder searchScope(Consumer<SearchScope.Builder> searchScope)
This object can contain BackupResourceTypes, BackupResourceArns, BackupResourceCreationTime, BackupResourceTags, and SourceResourceArns to filter the recovery points returned by the search job.
This is a convenience method that creates an instance of theSearchScope.Builderavoiding the need to create one manually viaSearchScope.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosearchScope(SearchScope).- Parameters:
searchScope- a consumer that will call methods onSearchScope.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
searchScope(SearchScope)
-
itemFilters
StartSearchJobRequest.Builder itemFilters(ItemFilters itemFilters)
Item Filters represent all input item properties specified when the search was created.
Contains either EBSItemFilters or S3ItemFilters
- Parameters:
itemFilters- Item Filters represent all input item properties specified when the search was created.Contains either EBSItemFilters or S3ItemFilters
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
itemFilters
default StartSearchJobRequest.Builder itemFilters(Consumer<ItemFilters.Builder> itemFilters)
Item Filters represent all input item properties specified when the search was created.
Contains either EBSItemFilters or S3ItemFilters
This is a convenience method that creates an instance of theItemFilters.Builderavoiding the need to create one manually viaItemFilters.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toitemFilters(ItemFilters).- Parameters:
itemFilters- a consumer that will call methods onItemFilters.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
itemFilters(ItemFilters)
-
overrideConfiguration
StartSearchJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
StartSearchJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-