Class GetSearchJobResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.backupsearch.model.BackupSearchResponse
software.amazon.awssdk.services.backupsearch.model.GetSearchJobResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetSearchJobResponse.Builder,GetSearchJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetSearchJobResponse extends BackupSearchResponse implements ToCopyableBuilder<GetSearchJobResponse.Builder,GetSearchJobResponse>

  • Method Details

    • name

      public final String name()

      Returned name of the specified search job.

      Returns:
      Returned name of the specified search job.

    • searchScopeSummary

      public final 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.

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

    • currentSearchProgress

      public final CurrentSearchProgress currentSearchProgress()

      Returns numbers representing BackupsScannedCount, ItemsScanned, and ItemsMatched.

      Returns:
      Returns numbers representing BackupsScannedCount, ItemsScanned, and ItemsMatched.

    • statusMessage

      public final 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.

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

    • encryptionKeyArn

      public final String encryptionKeyArn()

      The encryption key for the specified search job.

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

      Returns:
      The encryption key for the specified search job.

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

    • completionTime

      public final 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.

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

    • status

      public final 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 .

      If the service returns an enum value that is not available in the current SDK version, status will return SearchJobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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

      See Also:

    • statusAsString

      public final String statusAsString()

      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 .

      If the service returns an enum value that is not available in the current SDK version, status will return SearchJobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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

      See Also:

    • searchScope

      public final SearchScope searchScope()

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

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

    • itemFilters

      public final ItemFilters itemFilters()

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

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

    • creationTime

      public final 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.

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

    • searchJobIdentifier

      public final String searchJobIdentifier()

      The unique string that identifies the specified search job.

      Returns:
      The unique string that identifies the specified search job.

    • searchJobArn

      public final String searchJobArn()

      The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.

      Returns:
      The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.

    • toBuilder

      public GetSearchJobResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetSearchJobResponse.Builder,GetSearchJobResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetSearchJobResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetSearchJobResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.