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(value="software.amazon.awssdk:codegen")
public final class CreateRoomRequest
extends IvschatRequest
implements ToCopyableBuilder<CreateRoomRequest.Builder,CreateRoomRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateRoomRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateRoomRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLoggingConfigurationIdentifiers() For responses, this returns true if the service returned a value for the LoggingConfigurationIdentifiers property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<String>	loggingConfigurationIdentifiers() Array of logging-configuration identifiers attached to the room.
Integer	maximumMessageLength() Maximum number of characters in a single message.
Integer	maximumMessageRatePerSecond() Maximum number of messages per second that can be sent to the room (by all clients).
MessageReviewHandler	messageReviewHandler() Configuration information for optional review of messages.
String	name() Room name.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateRoomRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() Tags to attach to the resource.
CreateRoomRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

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

Specified by:

toBuilder in interface ToCopyableBuilder<CreateRoomRequest.Builder,CreateRoomRequest>

Specified by:

toBuilder in class IvschatRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo