Package 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:
SdkPojo, ToCopyableBuilder<CreateProfileRequest.Builder,CreateProfileRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateProfileRequest extends AlexaForBusinessRequest implements ToCopyableBuilder<CreateProfileRequest.Builder,CreateProfileRequest>

  • Method Details

    • profileName

      public final String profileName()

      The name of a room profile.

      Returns:
      The name of a room profile.

    • timezone

      public final String timezone()

      The time zone used by a room profile.

      Returns:
      The time zone used by a room profile.

    • address

      public final String address()

      The valid address for the room.

      Returns:
      The valid address for the room.

    • distanceUnit

      public final 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:

    • distanceUnitAsString

      public final 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:

    • temperatureUnit

      public final 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:

    • temperatureUnitAsString

      public final 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:

    • wakeWord

      public final 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:

    • wakeWordAsString

      public final 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:

    • locale

      public final String locale()

      The locale of the room profile. (This is currently only available to a limited preview audience.)

      Returns:
      The locale of the room profile. (This is currently only available to a limited preview audience.)

    • clientRequestToken

      public final 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 final Boolean setupModeDisabled()

      Whether room profile setup is enabled.

      Returns:
      Whether room profile setup is enabled.

    • maxVolumeLimit

      public final Integer maxVolumeLimit()

      The maximum volume limit for a room profile.

      Returns:
      The maximum volume limit for a room profile.

    • pstnEnabled

      public final Boolean pstnEnabled()

      Whether PSTN calling is enabled.

      Returns:
      Whether PSTN calling is enabled.

    • dataRetentionOptIn

      public final Boolean dataRetentionOptIn()

      Whether data retention of the profile is enabled.

      Returns:
      Whether data retention of the profile is enabled.

    • meetingRoomConfiguration

      public final CreateMeetingRoomConfiguration meetingRoomConfiguration()

      The meeting room settings of a room profile.

      Returns:
      The meeting room settings of a room profile.

    • 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 for the profile.

      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 for the profile.

    • 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 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.