Interface GetSearchJobResponse.Builder

All Superinterfaces:
AwsResponse.Builder, BackupSearchResponse.Builder, Buildable, CopyableBuilder<GetSearchJobResponse.Builder,GetSearchJobResponse>, SdkBuilder<GetSearchJobResponse.Builder,GetSearchJobResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetSearchJobResponse
@Mutable @NotThreadSafe public static interface GetSearchJobResponse.Builder extends BackupSearchResponse.Builder, SdkPojo, CopyableBuilder<GetSearchJobResponse.Builder,GetSearchJobResponse>

  • Method Details

    • name

      GetSearchJobResponse.Builder name(String name)

      Returned name of the specified search job.

      Parameters:
      name - Returned name of the specified search job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchScopeSummary

      GetSearchJobResponse.Builder searchScopeSummary(SearchScopeSummary searchScopeSummary)

      Returned summary of the specified search job scope, including:

      • TotalBackupsToScanCount, the number of recovery points returned by the search.

      • TotalItemsToScanCount, the number of items returned by the search.

      Parameters:
      searchScopeSummary - Returned summary of the specified search job scope, including:

      • TotalBackupsToScanCount, the number of recovery points returned by the search.

      • TotalItemsToScanCount, the number of items returned by the search.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchScopeSummary

      default GetSearchJobResponse.Builder searchScopeSummary(Consumer<SearchScopeSummary.Builder> searchScopeSummary)

      Returned summary of the specified search job scope, including:

      • TotalBackupsToScanCount, the number of recovery points returned by the search.

      • TotalItemsToScanCount, the number of items returned by the search.

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

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

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

    • currentSearchProgress

      GetSearchJobResponse.Builder currentSearchProgress(CurrentSearchProgress currentSearchProgress)

      Returns numbers representing BackupsScannedCount, ItemsScanned, and ItemsMatched.

      Parameters:
      currentSearchProgress - Returns numbers representing BackupsScannedCount, ItemsScanned, and ItemsMatched.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • currentSearchProgress

      default GetSearchJobResponse.Builder currentSearchProgress(Consumer<CurrentSearchProgress.Builder> currentSearchProgress)

      Returns numbers representing BackupsScannedCount, ItemsScanned, and ItemsMatched.

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

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

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

    • statusMessage

      GetSearchJobResponse.Builder statusMessage(String statusMessage)

      A status message will be returned for either a earch job with a status of ERRORED or a status of COMPLETED jobs with issues.

      For example, a message may say that a search contained recovery points unable to be scanned because of a permissions issue.

      Parameters:
      statusMessage - A status message will be returned for either a earch job with a status of ERRORED or a status of COMPLETED jobs with issues.

      For example, a message may say that a search contained recovery points unable to be scanned because of a permissions issue.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionKeyArn

      GetSearchJobResponse.Builder encryptionKeyArn(String encryptionKeyArn)

      The encryption key for the specified search job.

      Example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      Parameters:
      encryptionKeyArn - The encryption key for the specified search job.

      Example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • completionTime

      GetSearchJobResponse.Builder completionTime(Instant completionTime)

      The date and time that a search job completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime 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 a search job completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime 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.

    • status

      GetSearchJobResponse.Builder status(String status)

      The current status of the specified search job.

      A search job may have one of the following statuses: RUNNING; COMPLETED; STOPPED; FAILED; TIMED_OUT; or EXPIRED .

      Parameters:
      status - The current status of the specified search job.

      A search job may have one of the following statuses: RUNNING; COMPLETED; STOPPED; FAILED; TIMED_OUT; or EXPIRED .

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetSearchJobResponse.Builder status(SearchJobState status)

      The current status of the specified search job.

      A search job may have one of the following statuses: RUNNING; COMPLETED; STOPPED; FAILED; TIMED_OUT; or EXPIRED .

      Parameters:
      status - The current status of the specified search job.

      A search job may have one of the following statuses: RUNNING; COMPLETED; STOPPED; FAILED; TIMED_OUT; or EXPIRED .

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • searchScope

      GetSearchJobResponse.Builder searchScope(SearchScope searchScope)

      The search scope is all backup properties input into a search.

      Parameters:
      searchScope - The search scope is all backup properties input into a search.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchScope

      default GetSearchJobResponse.Builder searchScope(Consumer<SearchScope.Builder> searchScope)

      The search scope is all backup properties input into a search.

      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

      GetSearchJobResponse.Builder itemFilters(ItemFilters itemFilters)

      Item Filters represent all input item properties specified when the search was created.

      Parameters:
      itemFilters - Item Filters represent all input item properties specified when the search was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • itemFilters

      default GetSearchJobResponse.Builder itemFilters(Consumer<ItemFilters.Builder> itemFilters)

      Item Filters represent all input item properties specified when the search was created.

      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:

    • creationTime

      GetSearchJobResponse.Builder creationTime(Instant creationTime)

      The date and time that a search job was created, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime 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 a search job was created, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime 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.

    • searchJobIdentifier

      GetSearchJobResponse.Builder searchJobIdentifier(String searchJobIdentifier)

      The unique string that identifies the specified search job.

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

    • searchJobArn

      GetSearchJobResponse.Builder searchJobArn(String 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.