Class SearchJobSummary

java.lang.Object
software.amazon.awssdk.services.backupsearch.model.SearchJobSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SearchJobSummary.Builder,SearchJobSummary>
@Generated("software.amazon.awssdk:codegen") public final class SearchJobSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SearchJobSummary.Builder,SearchJobSummary>

This is information pertaining to a search job.

See Also:

  • Method Details

    • searchJobIdentifier

      public final String searchJobIdentifier()

      The unique string that specifies the search job.

      Returns:
      The unique string that specifies the 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.

    • name

      public final String name()

      This is the name of the search job.

      Returns:
      This is the name of the search job.

    • status

      public final SearchJobState status()

      This is the status of the search job.

      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:
      This is the status of the search job.
      See Also:

    • statusAsString

      public final String statusAsString()

      This is the status of the search job.

      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:
      This is the status of the search job.
      See Also:

    • creationTime

      public final Instant creationTime()

      This is the creation time of the search job.

      Returns:
      This is the creation time of the search job.

    • completionTime

      public final Instant completionTime()

      This is the completion time of the search job.

      Returns:
      This is the completion time of the 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.

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

    • toBuilder

      public SearchJobSummary.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<SearchJobSummary.Builder,SearchJobSummary>
      Returns:
      a builder for type T

    • builder

      public static SearchJobSummary.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

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