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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetQuantumTaskResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<Association>associations()The list of Amazon Braket resources associated with the quantum task.static GetQuantumTaskResponse.Builderbuilder()InstantcreatedAt()The time at which the task was created.StringdeviceArn()The ARN of the device the task was run on.StringdeviceParameters()The parameters for the device on which the task ran.InstantendedAt()The time at which the task ended.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfailureReason()The reason that a task failed.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAssociations()For responses, this returns true if the service returned a value for the Associations property.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringjobArn()The ARN of the Amazon Braket job associated with the quantum task.StringoutputS3Bucket()The S3 bucket where task results are stored.StringoutputS3Directory()The folder in the S3 bucket where task results are stored.StringquantumTaskArn()The ARN of the task.QuantumTaskQueueInfoqueueInfo()Queue information for the requested quantum task.List<SdkField<?>>sdkFields()static Class<? extends GetQuantumTaskResponse.Builder>serializableBuilderClass()Longshots()The number of shots used in the task.QuantumTaskStatusstatus()The status of the task.StringstatusAsString()The status of the task.Map<String,String>tags()The tags that belong to this task.GetQuantumTaskResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.services.braket.model.BraketResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 theisEmpty()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.
-
createdAt
public final Instant createdAt()
The time at which the task was created.
- Returns:
- The time at which the task was created.
-
deviceArn
public final String deviceArn()
The ARN of the device the task was run on.
- Returns:
- The ARN of the device the task was run on.
-
deviceParameters
public final String deviceParameters()
The parameters for the device on which the task ran.
- Returns:
- The parameters for the device on which the task ran.
-
endedAt
public final Instant endedAt()
The time at which the task ended.
- Returns:
- The time at which the task ended.
-
failureReason
public final String failureReason()
The reason that a task failed.
- Returns:
- The reason that a task failed.
-
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.
-
outputS3Bucket
public final String outputS3Bucket()
The S3 bucket where task results are stored.
- Returns:
- The S3 bucket where task results are stored.
-
outputS3Directory
public final String outputS3Directory()
The folder in the S3 bucket where task results are stored.
- Returns:
- The folder in the S3 bucket where task results are stored.
-
quantumTaskArn
public final String quantumTaskArn()
The ARN of the task.
- Returns:
- The ARN of the task.
-
queueInfo
public final QuantumTaskQueueInfo queueInfo()
Queue information for the requested quantum task. Only returned if
QueueInfois specified in theadditionalAttributeNames"field in theGetQuantumTaskAPI request.- Returns:
- Queue information for the requested quantum task. Only returned if
QueueInfois specified in theadditionalAttributeNames"field in theGetQuantumTaskAPI request.
-
shots
public final Long shots()
The number of shots used in the task.
- Returns:
- The number of shots used in the task.
-
status
public final QuantumTaskStatus status()
The status of the task.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnQuantumTaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the task.
- See Also:
QuantumTaskStatus
-
statusAsString
public final String statusAsString()
The status of the task.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnQuantumTaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the task.
- See Also:
QuantumTaskStatus
-
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 theisEmpty()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 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 task.
-
toBuilder
public GetQuantumTaskResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GetQuantumTaskResponse.Builder,GetQuantumTaskResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static GetQuantumTaskResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetQuantumTaskResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
-