Class QuantumTaskSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<QuantumTaskSummary.Builder,
QuantumTaskSummary>
Includes information about a quantum task.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic QuantumTaskSummary.Builder
builder()
final Instant
The time at which the task was created.final String
The ARN of the device the task ran on.final Instant
endedAt()
The time at which the task finished.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The S3 bucket where the task result file is stored..final String
The folder in the S3 bucket where the task result file is stored.final String
The ARN of the task.static Class
<? extends QuantumTaskSummary.Builder> final Long
shots()
The shots used for the task.final QuantumTaskStatus
status()
The status of the task.final String
The status of the task.tags()
Displays the key, value pairs of tags associated with this quantum task.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
createdAt
The time at which the task was created.
- Returns:
- The time at which the task was created.
-
deviceArn
The ARN of the device the task ran on.
- Returns:
- The ARN of the device the task ran on.
-
endedAt
The time at which the task finished.
- Returns:
- The time at which the task finished.
-
outputS3Bucket
The S3 bucket where the task result file is stored..
- Returns:
- The S3 bucket where the task result file is stored..
-
outputS3Directory
The folder in the S3 bucket where the task result file is stored.
- Returns:
- The folder in the S3 bucket where the task result file is stored.
-
quantumTaskArn
The ARN of the task.
- Returns:
- The ARN of the task.
-
shots
The shots used for the task.
- Returns:
- The shots used for the task.
-
status
The status of the task.
If the service returns an enum value that is not available in the current SDK version,
status
will returnQuantumTaskStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the task.
- See Also:
-
statusAsString
The status of the task.
If the service returns an enum value that is not available in the current SDK version,
status
will returnQuantumTaskStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the task.
- 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 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
Displays the key, value pairs of tags associated with 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:
- Displays the key, value pairs of tags associated with this quantum task.
-
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 interfaceToCopyableBuilder<QuantumTaskSummary.Builder,
QuantumTaskSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
-
sdkFields
-