software.amazon.awssdk.services.braket.model

Class CreateQuantumTaskRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.braket.model.BraketRequest

software.amazon.awssdk.services.braket.model.CreateQuantumTaskRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateQuantumTaskRequest.Builder,CreateQuantumTaskRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateQuantumTaskRequest
extends BraketRequest
implements ToCopyableBuilder<CreateQuantumTaskRequest.Builder,CreateQuantumTaskRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateQuantumTaskRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	action() The action associated with the task.
static CreateQuantumTaskRequest.Builder	builder()
String	clientToken() The client token associated with the request.
String	deviceArn() The ARN of the device to run the task on.
String	deviceParameters() The parameters for the device to run the task on.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	outputS3Bucket() The S3 bucket to store task result files in.
String	outputS3KeyPrefix() The key prefix for the location in the S3 bucket to store task results in.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateQuantumTaskRequest.Builder>	serializableBuilderClass()
Long	shots() The number of shots to use for the task.
Map<String,String>	tags() Tags to be added to the quantum task you're creating.
CreateQuantumTaskRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

action

public final String action()

The action associated with the task.

Returns:

The action associated with the task.

clientToken

public final String clientToken()

The client token associated with the request.

Returns:

The client token associated with the request.

deviceArn

public final String deviceArn()

The ARN of the device to run the task on.

Returns:

The ARN of the device to run the task on.

deviceParameters

public final String deviceParameters()

The parameters for the device to run the task on.

Returns:

The parameters for the device to run the task on.

outputS3Bucket

public final String outputS3Bucket()

The S3 bucket to store task result files in.

Returns:

The S3 bucket to store task result files in.

outputS3KeyPrefix

public final String outputS3KeyPrefix()

The key prefix for the location in the S3 bucket to store task results in.

Returns:

The key prefix for the location in the S3 bucket to store task results in.

shots

public final Long shots()

The number of shots to use for the task.

Returns:

The number of shots to use for the task.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final Map<String,String> tags()

Tags to be added to the quantum task you're creating.

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

You can use hasTags() to see if a value was sent in this field.

Returns:

Tags to be added to the quantum task you're creating.

toBuilder

public CreateQuantumTaskRequest.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<CreateQuantumTaskRequest.Builder,CreateQuantumTaskRequest>

Specified by:

toBuilder in class BraketRequest

Returns:

a builder for type T

builder

public static CreateQuantumTaskRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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.