GetQuantumTaskResponse (AWS Java SDK :: Services

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetQuantumTaskResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetQuantumTaskResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GetQuantumTaskResponse.Builder`	`builder()`
`Instant`	`createdAt()` The time at which the task was created.
`String`	`deviceArn()` The ARN of the device the task was run on.
`String`	`deviceParameters()` The parameters for the device on which the task ran.
`Instant`	`endedAt()` The time at which the task ended.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`failureReason()` The reason that a task failed.
`<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`	`jobArn()` The ARN of the Amazon Braket job associated with the quantum task.
`String`	`outputS3Bucket()` The S3 bucket where task results are stored.
`String`	`outputS3Directory()` The folder in the S3 bucket where task results are stored.
`String`	`quantumTaskArn()` The ARN of the task.
`QuantumTaskQueueInfo`	`queueInfo()` Queue information for the requested quantum task.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetQuantumTaskResponse.Builder>`	`serializableBuilderClass()`
`Long`	`shots()` The number of shots used in the task.
`QuantumTaskStatus`	`status()` The status of the task.
`String`	`statusAsString()` The status of the task.
`Map<String,String>`	`tags()` The tags that belong to this task.
`GetQuantumTaskResponse.Builder`	`toBuilder()`
`String`	`toString()` 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
  - 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 QueueInfo is specified in the additionalAttributeNames" field in the GetQuantumTask API request.
    
    Returns:
    
    Queue information for the requested quantum task. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetQuantumTask API 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, 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()
```
    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:
    
    toBuilder in interface ToCopyableBuilder<GetQuantumTaskResponse.Builder,GetQuantumTaskResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static GetQuantumTaskResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetQuantumTaskResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - 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 SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetQuantumTaskResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.braket.model.BraketResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

createdAt

deviceArn

deviceParameters

endedAt

failureReason

jobArn

outputS3Bucket

outputS3Directory

quantumTaskArn

queueInfo

shots

status

statusAsString

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields