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

Class CreateRoomRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ivschat.model.IvschatRequest
software.amazon.awssdk.services.ivschat.model.CreateRoomRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateRoomRequest.Builder,CreateRoomRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateRoomRequest extends IvschatRequest implements ToCopyableBuilder<CreateRoomRequest.Builder,CreateRoomRequest>

  • Method Details

    • 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-configuration identifiers 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-configuration identifiers attached to the room.

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

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

    • messageReviewHandler

      public final MessageReviewHandler messageReviewHandler()

      Configuration information for optional review of messages.

      Returns:
      Configuration information for optional review of messages.

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

    • 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 to attach to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.

      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 to attach to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.

    • toBuilder

      public CreateRoomRequest.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<CreateRoomRequest.Builder,CreateRoomRequest>
      Specified by:
      toBuilder in class IvschatRequest
      Returns:
      a builder for type T

    • builder

      public static CreateRoomRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateRoomRequest.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.