Interface SearchJobSummary.Builder

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

  • Method Details

    • searchJobIdentifier

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

    • searchJobArn

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

    • name

      SearchJobSummary.Builder name(String name)

      This is the name of the search job.

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

    • status

      SearchJobSummary.Builder status(String status)

      This is the status of the search job.

      Parameters:
      status - This is the status of the search job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      SearchJobSummary.Builder status(SearchJobState status)

      This is the status of the search job.

      Parameters:
      status - This is the status of the search job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • creationTime

      SearchJobSummary.Builder creationTime(Instant creationTime)

      This is the creation time of the search job.

      Parameters:
      creationTime - This is the creation time of the search job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • completionTime

      SearchJobSummary.Builder completionTime(Instant completionTime)

      This is the completion time of the search job.

      Parameters:
      completionTime - This is the completion time of the search job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchScopeSummary

      SearchJobSummary.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 SearchJobSummary.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:

    • statusMessage

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