software.amazon.awssdk.services.braket.model

Class GetDeviceResponse

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.GetDeviceResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetDeviceResponse.Builder,GetDeviceResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetDeviceResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetDeviceResponse.Builder	builder()
String	deviceArn() The ARN of the device.
String	deviceCapabilities() Details about the capabilities of the device.
String	deviceName() The name of the device.
List<DeviceQueueInfo>	deviceQueueInfo() List of information about tasks and jobs queued on a device.
DeviceStatus	deviceStatus() The status of the device.
String	deviceStatusAsString() The status of the device.
DeviceType	deviceType() The type of the device.
String	deviceTypeAsString() The type of the device.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDeviceQueueInfo() For responses, this returns true if the service returned a value for the DeviceQueueInfo property.
int	hashCode()
String	providerName() The name of the partner company for the device.
List<SdkField<?>>	sdkFields()
static Class<? extends GetDeviceResponse.Builder>	serializableBuilderClass()
GetDeviceResponse.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

deviceArn

public final String deviceArn()

The ARN of the device.

Returns:

The ARN of the device.

deviceCapabilities

public final String deviceCapabilities()

Details about the capabilities of the device.

Returns:

Details about the capabilities of the device.

deviceName

public final String deviceName()

The name of the device.

Returns:

The name of the device.

hasDeviceQueueInfo

public final boolean hasDeviceQueueInfo()

For responses, this returns true if the service returned a value for the DeviceQueueInfo 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.

deviceQueueInfo

public final List<DeviceQueueInfo> deviceQueueInfo()

List of information about tasks and jobs queued on a device.

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 hasDeviceQueueInfo() method.

Returns:

List of information about tasks and jobs queued on a device.

deviceStatus

public final DeviceStatus deviceStatus()

The status of the device.

If the service returns an enum value that is not available in the current SDK version, deviceStatus will return DeviceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deviceStatusAsString().

Returns:

The status of the device.

See Also:

DeviceStatus

deviceStatusAsString

public final String deviceStatusAsString()

The status of the device.

If the service returns an enum value that is not available in the current SDK version, deviceStatus will return DeviceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deviceStatusAsString().

Returns:

The status of the device.

See Also:

DeviceStatus

deviceType

public final DeviceType deviceType()

The type of the device.

If the service returns an enum value that is not available in the current SDK version, deviceType will return DeviceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deviceTypeAsString().

Returns:

The type of the device.

See Also:

DeviceType

deviceTypeAsString

public final String deviceTypeAsString()

The type of the device.

If the service returns an enum value that is not available in the current SDK version, deviceType will return DeviceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deviceTypeAsString().

Returns:

The type of the device.

See Also:

DeviceType

providerName

public final String providerName()

The name of the partner company for the device.

Returns:

The name of the partner company for the device.

toBuilder

public GetDeviceResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetDeviceResponse.Builder,GetDeviceResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetDeviceResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetDeviceResponse.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