Class GetBatchResponse

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

  • Method Details

    • id

      public final String id()

      The identifier portion of the run batch ARN.

      Returns:
      The identifier portion of the run batch ARN.

    • arn

      public final String arn()

      The unique ARN of the run batch.

      Returns:
      The unique ARN of the run batch.

    • uuid

      public final String uuid()

      The universally unique identifier (UUID) for the run batch.

      Returns:
      The universally unique identifier (UUID) for the run batch.

    • name

      public final String name()

      The optional user-friendly name of the batch.

      Returns:
      The optional user-friendly name of the batch.

    • status

      public final BatchStatus status()

      The current status of the run batch.

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

      Returns:
      The current status of the run batch.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the run batch.

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

      Returns:
      The current status of the run batch.
      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      AWS tags associated with the run batch.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      AWS tags associated with the run batch.

    • totalRuns

      public final Integer totalRuns()

      The total number of runs in the batch.

      Returns:
      The total number of runs in the batch.

    • defaultRunSetting

      public final DefaultRunSetting defaultRunSetting()

      The shared configuration applied to all runs in the batch. See DefaultRunSetting.

      Returns:
      The shared configuration applied to all runs in the batch. See DefaultRunSetting.

    • submissionSummary

      public final SubmissionSummary submissionSummary()

      A summary of run submission outcomes. See SubmissionSummary.

      Returns:
      A summary of run submission outcomes. See SubmissionSummary.

    • runSummary

      public final RunSummary runSummary()

      A summary of run execution states. Run execution counts are eventually consistent and may lag behind actual run states. Final counts are accurate once the batch reaches PROCESSED status. See RunSummary.

      Returns:
      A summary of run execution states. Run execution counts are eventually consistent and may lag behind actual run states. Final counts are accurate once the batch reaches PROCESSED status. See RunSummary.

    • creationTime

      public final Instant creationTime()

      The timestamp when the batch was created.

      Returns:
      The timestamp when the batch was created.

    • submittedTime

      public final Instant submittedTime()

      The timestamp when all run submissions completed.

      Returns:
      The timestamp when all run submissions completed.

    • processedTime

      public final Instant processedTime()

      The timestamp when all run executions completed.

      Returns:
      The timestamp when all run executions completed.

    • failedTime

      public final Instant failedTime()

      The timestamp when the batch transitioned to a FAILED status.

      Returns:
      The timestamp when the batch transitioned to a FAILED status.

    • failureReason

      public final String failureReason()

      A description of the batch failure. Present only when status is FAILED.

      Returns:
      A description of the batch failure. Present only when status is FAILED.

    • toBuilder

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

    • builder

      public static GetBatchResponse.Builder builder()

    • serializableBuilderClass

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