Class CreateProfileRequest

    • Method Detail

      • 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.
      • 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:
        DistanceUnit
      • 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:
        WakeWord
      • 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:
        WakeWord
      • 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.
      • 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