Package software.amazon.awssdk.services.braket.model

Class QuantumTaskSummary

java.lang.Object

software.amazon.awssdk.services.braket.model.QuantumTaskSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<QuantumTaskSummary.Builder,QuantumTaskSummary>

@Generated("software.amazon.awssdk:codegen")
public final class QuantumTaskSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<QuantumTaskSummary.Builder,QuantumTaskSummary>

Includes information about a quantum task.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QuantumTaskSummary.Builder

Method Summary

Modifier and Type	Method	Description
static QuantumTaskSummary.Builder	builder()
Instant	createdAt()	The time at which the task was created.
String	deviceArn()	The ARN of the device the task ran on.
Instant	endedAt()	The time at which the task finished.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	outputS3Bucket()	The S3 bucket where the task result file is stored..
String	outputS3Directory()	The folder in the S3 bucket where the task result file is stored.
String	quantumTaskArn()	The ARN of the task.
List<SdkField<?>>	sdkFields()
static Class<? extends QuantumTaskSummary.Builder>	serializableBuilderClass()
Long	shots()	The shots used for the task.
QuantumTaskStatus	status()	The status of the task.
String	statusAsString()	The status of the task.
Map<String,String>	tags()	Displays the key, value pairs of tags associated with this quantum task.
QuantumTaskSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

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 ran on.

Returns:

The ARN of the device the task ran on.

endedAt

public final Instant endedAt()

The time at which the task finished.

Returns:

The time at which the task finished.

outputS3Bucket

public final String outputS3Bucket()

The S3 bucket where the task result file is stored..

Returns:

The S3 bucket where the task result file is stored..

outputS3Directory

public final String 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

public final String quantumTaskArn()

The ARN of the task.

Returns:

The ARN of the task.

shots

public final Long shots()

The shots used for the task.

Returns:

The shots used for 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, status will return QuantumTaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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, status will return QuantumTaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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

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

public QuantumTaskSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QuantumTaskSummary.Builder,QuantumTaskSummary>

builder

public static QuantumTaskSummary.Builder builder()

serializableBuilderClass

public static Class<? extends QuantumTaskSummary.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo