Class GetQuantumTaskResponse

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

  • Method Details

    • quantumTaskArn

      public final String quantumTaskArn()

      The ARN of the quantum task.

      Returns:
      The ARN of the quantum task.

    • status

      public final QuantumTaskStatus status()

      The status of the quantum task.

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

      Returns:
      The status of the quantum task.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the quantum task.

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

      Returns:
      The status of the quantum task.
      See Also:

    • failureReason

      public final String failureReason()

      The reason that a quantum task failed.

      Returns:
      The reason that a quantum task failed.

    • deviceArn

      public final String deviceArn()

      The ARN of the device the quantum task was run on.

      Returns:
      The ARN of the device the quantum task was run on.

    • deviceParameters

      public final String deviceParameters()

      The parameters for the device on which the quantum task ran.

      Returns:
      The parameters for the device on which the quantum task ran.

    • shots

      public final Long shots()

      The number of shots used in the quantum task.

      Returns:
      The number of shots used in the quantum task.

    • outputS3Bucket

      public final String outputS3Bucket()

      The S3 bucket where quantum task results are stored.

      Returns:
      The S3 bucket where quantum task results are stored.

    • outputS3Directory

      public final String outputS3Directory()

      The folder in the S3 bucket where quantum task results are stored.

      Returns:
      The folder in the S3 bucket where quantum task results are stored.

    • createdAt

      public final Instant createdAt()

      The time at which the quantum task was created.

      Returns:
      The time at which the quantum task was created.

    • endedAt

      public final Instant endedAt()

      The time at which the quantum task ended.

      Returns:
      The time at which the quantum task ended.

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

      The tags that belong to this quantum task.

      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:
      The tags that belong to this quantum task.

    • jobArn

      public final String jobArn()

      The ARN of the Amazon Braket job associated with the quantum task.

      Returns:
      The ARN of the Amazon Braket job associated with the quantum task.

    • queueInfo

      public final QuantumTaskQueueInfo queueInfo()

      Queue information for the requested quantum task. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetQuantumTask API request.

      Returns:
      Queue information for the requested quantum task. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetQuantumTask API request.

    • hasAssociations

      public final boolean hasAssociations()
      For responses, this returns true if the service returned a value for the Associations 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.

    • associations

      public final List<Association> associations()

      The list of Amazon Braket resources associated with the quantum task.

      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 hasAssociations() method.

      Returns:
      The list of Amazon Braket resources associated with the quantum task.

    • numSuccessfulShots

      public final Long numSuccessfulShots()

      The number of successful shots for the quantum task. This is available after a successfully completed quantum task.

      Returns:
      The number of successful shots for the quantum task. This is available after a successfully completed quantum task.

    • actionMetadata

      public final ActionMetadata actionMetadata()

      Metadata about the action performed by the quantum task, including information about the type of action and program counts.

      Returns:
      Metadata about the action performed by the quantum task, including information about the type of action and program counts.

    • toBuilder

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

    • builder

      public static GetQuantumTaskResponse.Builder builder()

    • serializableBuilderClass

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