Package software.amazon.awssdk.services.alexaforbusiness.model

Class RegisterAvsDeviceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.alexaforbusiness.model.AlexaForBusinessRequest

software.amazon.awssdk.services.alexaforbusiness.model.RegisterAvsDeviceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RegisterAvsDeviceRequest.Builder,RegisterAvsDeviceRequest>

@Generated("software.amazon.awssdk:codegen")
public final class RegisterAvsDeviceRequest
extends AlexaForBusinessRequest
implements ToCopyableBuilder<RegisterAvsDeviceRequest.Builder,RegisterAvsDeviceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RegisterAvsDeviceRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	amazonId()	The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.
static RegisterAvsDeviceRequest.Builder	builder()
String	clientId()	The client ID of the OEM used for code-based linking authorization on an AVS device.
String	deviceSerialNumber()	The key generated by the OEM that uniquely identifies a specified instance of your AVS device.
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	productId()	The product ID used to identify your AVS device during authorization.
String	roomArn()	The Amazon Resource Name (ARN) of the room with which to associate your AVS device.
List<SdkField<?>>	sdkFields()
static Class<? extends RegisterAvsDeviceRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	The tags to be added to the specified resource.
RegisterAvsDeviceRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userCode()	The code that is obtained after your AVS device has made a POST request to LWA as a part of the Device Authorization Request component of the OAuth code-based linking specification.

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

clientId

public final String clientId()

The client ID of the OEM used for code-based linking authorization on an AVS device.

Returns:

The client ID of the OEM used for code-based linking authorization on an AVS device.

userCode

public final String userCode()

The code that is obtained after your AVS device has made a POST request to LWA as a part of the Device Authorization Request component of the OAuth code-based linking specification.

Returns:

The code that is obtained after your AVS device has made a POST request to LWA as a part of the Device Authorization Request component of the OAuth code-based linking specification.

productId

public final String productId()

The product ID used to identify your AVS device during authorization.

Returns:

The product ID used to identify your AVS device during authorization.

deviceSerialNumber

public final String deviceSerialNumber()

The key generated by the OEM that uniquely identifies a specified instance of your AVS device.

Returns:

The key generated by the OEM that uniquely identifies a specified instance of your AVS device.

amazonId

public final String amazonId()

The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.

Returns:

The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.

roomArn

public final String roomArn()

The Amazon Resource Name (ARN) of the room with which to associate your AVS device.

Returns:

The Amazon Resource Name (ARN) of the room with which to associate your AVS device.

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 List<Tag> tags()

The tags to be added to the specified resource. Do not provide system tags.

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 to be added to the specified resource. Do not provide system tags.

toBuilder

public RegisterAvsDeviceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RegisterAvsDeviceRequest.Builder,RegisterAvsDeviceRequest>

Specified by:

toBuilder in class AlexaForBusinessRequest

builder

public static RegisterAvsDeviceRequest.Builder builder()

serializableBuilderClass

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