Package software.amazon.awssdk.services.ivschat.model

Class GetRoomResponse

    • Method Detail

      • arn

        public final String arn()

        Room ARN, from the request (if identifier was an ARN).

        Returns:
        Room ARN, from the request (if identifier was an ARN).

      • id

        public final String id()

        Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.

        Returns:
        Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.

      • name

        public final String name()

        Room name. The value does not need to be unique.

        Returns:
        Room name. The value does not need to be unique.

      • createTime

        public final Instant createTime()

        Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.

        Returns:
        Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.

      • updateTime

        public final Instant updateTime()

        Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.

        Returns:
        Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.

      • maximumMessageRatePerSecond

        public final Integer maximumMessageRatePerSecond()

        Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.

        Returns:
        Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.

      • maximumMessageLength

        public final Integer maximumMessageLength()

        Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.

        Returns:
        Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.

      • messageReviewHandler

        public final MessageReviewHandler messageReviewHandler()

        Configuration information for optional review of messages.

        Returns:
        Configuration information for optional review of messages.

      • 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 Map<String,​String> tags()

        Tags attached to the resource. Array of maps, each of the form string:string (key:value).

        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:
        Tags attached to the resource. Array of maps, each of the form string:string (key:value).

      • hasLoggingConfigurationIdentifiers

        public final boolean hasLoggingConfigurationIdentifiers()
        For responses, this returns true if the service returned a value for the LoggingConfigurationIdentifiers 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.

      • loggingConfigurationIdentifiers

        public final List<String> loggingConfigurationIdentifiers()

        Array of logging configurations attached to the room.

        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 hasLoggingConfigurationIdentifiers() method.

        Returns:
        Array of logging configurations attached to the room.

      • 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