Interface StartSearchJobRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BackupSearchRequest.Builder, Buildable, CopyableBuilder<StartSearchJobRequest.Builder,StartSearchJobRequest>, SdkBuilder<StartSearchJobRequest.Builder,StartSearchJobRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartSearchJobRequest
@Mutable @NotThreadSafe public static interface StartSearchJobRequest.Builder extends BackupSearchRequest.Builder, SdkPojo, CopyableBuilder<StartSearchJobRequest.Builder,StartSearchJobRequest>

  • Method Details

    • 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 the SearchScope.Builder avoiding the need to create one manually via SearchScope.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to searchScope(SearchScope).

      Parameters:
      searchScope - a consumer that will call methods on SearchScope.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 the ItemFilters.Builder avoiding the need to create one manually via ItemFilters.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to itemFilters(ItemFilters).

      Parameters:
      itemFilters - a consumer that will call methods on ItemFilters.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      StartSearchJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartSearchJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.