Class RegisterAvsDeviceRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<RegisterAvsDeviceRequest.Builder,
RegisterAvsDeviceRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal 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.builder()
final String
clientId()
The client ID of the OEM used for code-based linking authorization on an AVS device.final String
The key generated by the OEM that uniquely identifies a specified instance of your AVS device.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The product ID used to identify your AVS device during authorization.final String
roomArn()
The Amazon Resource Name (ARN) of the room with which to associate your AVS device.static Class
<? extends RegisterAvsDeviceRequest.Builder> tags()
The tags to be added to the specified resource.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.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.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
The product ID used to identify your AVS device during authorization.
- Returns:
- The product ID used to identify your AVS device during authorization.
-
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
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
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<RegisterAvsDeviceRequest.Builder,
RegisterAvsDeviceRequest> - Specified by:
toBuilder
in classAlexaForBusinessRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-