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("software.amazon.awssdk:codegen")
public final class CreateQuantumTaskRequest
extends BraketRequest
implements ToCopyableBuilder<CreateQuantumTaskRequest.Builder,CreateQuantumTaskRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateQuantumTaskRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`action()`	The action associated with the task.
`List<Association>`	`associations()`	The list of Amazon Braket resources associated with the quantum 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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAssociations()`	For responses, this returns true if the service returned a value for the Associations property.
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`jobToken()`	The token for an Amazon Braket job that associates it with the quantum task.
`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()`
`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
clone, finalize, 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.
  - 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.
  - 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.
  - jobToken
```
public final String jobToken()
```
    The token for an Amazon Braket job that associates it with the quantum task.
    
    Returns:
    
    The token for an Amazon Braket job that associates it with the quantum task.
  - 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()
```
    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()
```
    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.
    
    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:
    
    Tags to be added to the quantum task you're creating.
  - toBuilder
```
public CreateQuantumTaskRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateQuantumTaskRequest.Builder,CreateQuantumTaskRequest>
    
    Specified by:
    
    toBuilder in class BraketRequest
  - 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)
```
    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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateQuantumTaskRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

action

hasAssociations

associations

clientToken

deviceArn

deviceParameters

jobToken

outputS3Bucket

outputS3KeyPrefix

shots

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields