Class ExportJobSummary

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

This is the summary of an export job.

See Also:

  • Method Details

    • exportJobIdentifier

      public final String exportJobIdentifier()

      This is the unique string that identifies a specific export job.

      Returns:
      This is the unique string that identifies a specific export job.

    • exportJobArn

      public final String exportJobArn()

      This is the unique ARN (Amazon Resource Name) that belongs to the new export job.

      Returns:
      This is the unique ARN (Amazon Resource Name) that belongs to the new export job.

    • status

      public final ExportJobStatus status()

      The status of the export job is one of the following:

      CREATED; RUNNING; FAILED; or COMPLETED.

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

      Returns:
      The status of the export job is one of the following:

      CREATED; RUNNING; FAILED; or COMPLETED.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the export job is one of the following:

      CREATED; RUNNING; FAILED; or COMPLETED.

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

      Returns:
      The status of the export job is one of the following:

      CREATED; RUNNING; FAILED; or COMPLETED.

      See Also:

    • creationTime

      public final Instant creationTime()

      This is a timestamp of the time the export job was created.

      Returns:
      This is a timestamp of the time the export job was created.

    • completionTime

      public final Instant completionTime()

      This is a timestamp of the time the export job compeleted.

      Returns:
      This is a timestamp of the time the export job compeleted.

    • statusMessage

      public final String statusMessage()

      A status message is a string that is returned for an export job.

      A status message is included for any status other than COMPLETED without issues.

      Returns:
      A status message is a string that is returned for an export job.

      A status message is included for any status other than COMPLETED without issues.

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

    • builder

      public static ExportJobSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ExportJobSummary.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.