Class GetSearchResultExportJobResponse

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.GetSearchResultExportJobResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetSearchResultExportJobResponse.Builder,GetSearchResultExportJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetSearchResultExportJobResponse extends BackupSearchResponse implements ToCopyableBuilder<GetSearchResultExportJobResponse.Builder,GetSearchResultExportJobResponse>

  • Method Details

    • exportJobIdentifier

      public final String exportJobIdentifier()

      This is the unique string that identifies the specified export job.

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

    • exportJobArn

      public final String exportJobArn()

      The unique Amazon Resource Name (ARN) that uniquely identifies the export job.

      Returns:
      The unique Amazon Resource Name (ARN) that uniquely identifies the export job.

    • status

      public final ExportJobStatus status()

      This is the current status of the export job.

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

    • statusAsString

      public final String statusAsString()

      This is the current status of the export job.

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

    • creationTime

      public final Instant creationTime()

      The date and time that an export job was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime 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 an export job was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • completionTime

      public final Instant completionTime()

      The date and time that an export job completed, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime 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 an export job completed, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • statusMessage

      public final String statusMessage()

      A status message is a string that is returned for search job with a status of FAILED, along with steps to remedy and retry the operation.

      Returns:
      A status message is a string that is returned for search job with a status of FAILED, along with steps to remedy and retry the operation.

    • exportSpecification

      public final ExportSpecification exportSpecification()

      The export specification consists of the destination S3 bucket to which the search results were exported, along with the destination prefix.

      Returns:
      The export specification consists of the destination S3 bucket to which the search results were exported, along with the destination prefix.

    • 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 GetSearchResultExportJobResponse.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<GetSearchResultExportJobResponse.Builder,GetSearchResultExportJobResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetSearchResultExportJobResponse.Builder builder()

    • serializableBuilderClass

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