Interface StartSearchResultExportJobRequest.Builder

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

  • Method Details

    • searchJobIdentifier

      StartSearchResultExportJobRequest.Builder searchJobIdentifier(String searchJobIdentifier)

      The unique string that specifies the search job.

      Parameters:
      searchJobIdentifier - The unique string that specifies the search job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exportSpecification

      StartSearchResultExportJobRequest.Builder exportSpecification(ExportSpecification exportSpecification)

      This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.

      Parameters:
      exportSpecification - This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exportSpecification

      default StartSearchResultExportJobRequest.Builder exportSpecification(Consumer<ExportSpecification.Builder> exportSpecification)

      This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.

      This is a convenience method that creates an instance of the ExportSpecification.Builder avoiding the need to create one manually via ExportSpecification.builder().

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

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

    • clientToken

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

    • tags

      StartSearchResultExportJobRequest.Builder tags(Map<String,String> tags)

      Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

      Parameters:
      tags - Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      StartSearchResultExportJobRequest.Builder roleArn(String roleArn)

      This parameter specifies the role ARN used to start the search results export jobs.

      Parameters:
      roleArn - This parameter specifies the role ARN used to start the search results export jobs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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