software.amazon.awssdk.services.alexaforbusiness.model

Class CreateProfileRequest

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

All Implemented Interfaces:

ToCopyableBuilder<CreateProfileRequest.Builder,CreateProfileRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateProfileRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	address() The valid address for the room.
static CreateProfileRequest.Builder	builder()
String	clientRequestToken() The user-specified token that is used during the creation of a profile.
DistanceUnit	distanceUnit() The distance unit to be used by devices in the profile.
String	distanceUnitAsString() The distance unit to be used by devices in the profile.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maxVolumeLimit() The maximum volume limit for a room profile.
String	profileName() The name of a room profile.
Boolean	pstnEnabled() Whether PSTN calling is enabled.
static Class<? extends CreateProfileRequest.Builder>	serializableBuilderClass()
Boolean	setupModeDisabled() Whether room profile setup is enabled.
TemperatureUnit	temperatureUnit() The temperature unit to be used by devices in the profile.
String	temperatureUnitAsString() The temperature unit to be used by devices in the profile.
String	timezone() The time zone used by a room profile.
CreateProfileRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
WakeWord	wakeWord() A wake word for Alexa, Echo, Amazon, or a computer.
String	wakeWordAsString() A wake word for Alexa, Echo, Amazon, or a computer.

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

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

profileName

public String profileName()

The name of a room profile.

Returns:

The name of a room profile.

timezone

public String timezone()

The time zone used by a room profile.

Returns:

The time zone used by a room profile.

address

public String address()

The valid address for the room.

Returns:

The valid address for the room.

distanceUnit

public DistanceUnit distanceUnit()

The distance unit to be used by devices in the profile.

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

Returns:

The distance unit to be used by devices in the profile.

See Also:

DistanceUnit

distanceUnitAsString

public String distanceUnitAsString()

The distance unit to be used by devices in the profile.

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

Returns:

The distance unit to be used by devices in the profile.

See Also:

DistanceUnit

temperatureUnit

public TemperatureUnit temperatureUnit()

The temperature unit to be used by devices in the profile.

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

Returns:

The temperature unit to be used by devices in the profile.

See Also:

TemperatureUnit

temperatureUnitAsString

public String temperatureUnitAsString()

The temperature unit to be used by devices in the profile.

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

Returns:

The temperature unit to be used by devices in the profile.

See Also:

TemperatureUnit

wakeWord

public WakeWord wakeWord()

A wake word for Alexa, Echo, Amazon, or a computer.

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

Returns:

A wake word for Alexa, Echo, Amazon, or a computer.

See Also:

WakeWord

wakeWordAsString

public String wakeWordAsString()

A wake word for Alexa, Echo, Amazon, or a computer.

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

Returns:

A wake word for Alexa, Echo, Amazon, or a computer.

See Also:

WakeWord

clientRequestToken

public String clientRequestToken()

The user-specified token that is used during the creation of a profile.

Returns:

The user-specified token that is used during the creation of a profile.

setupModeDisabled

public Boolean setupModeDisabled()

Whether room profile setup is enabled.

Returns:

Whether room profile setup is enabled.

maxVolumeLimit

public Integer maxVolumeLimit()

The maximum volume limit for a room profile.

Returns:

The maximum volume limit for a room profile.

pstnEnabled

public Boolean pstnEnabled()

Whether PSTN calling is enabled.

Returns:

Whether PSTN calling is enabled.

toBuilder

public CreateProfileRequest.Builder 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 interface ToCopyableBuilder<CreateProfileRequest.Builder,CreateProfileRequest>

Specified by:

toBuilder in class AlexaForBusinessRequest

Returns:

a builder for type T

builder

public static CreateProfileRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateProfileRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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