software.amazon.awssdk.services.chime.model

Class CreateChannelRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.chime.model.ChimeRequest

software.amazon.awssdk.services.chime.model.CreateChannelRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateChannelRequest
extends ChimeRequest
implements ToCopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateChannelRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	appInstanceArn() The ARN of the channel request.
static CreateChannelRequest.Builder	builder()
String	chimeBearer() The AppInstanceUserArn of the user that makes the API call.
String	clientRequestToken() The client token for the request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	metadata() The metadata of the creation request.
ChannelMode	mode() The channel mode: UNRESTRICTED or RESTRICTED.
String	modeAsString() The channel mode: UNRESTRICTED or RESTRICTED.
String	name() The name of the channel.
ChannelPrivacy	privacy() The channel's privacy level: PUBLIC or PRIVATE.
String	privacyAsString() The channel's privacy level: PUBLIC or PRIVATE.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateChannelRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() The tags for the creation request.
CreateChannelRequest.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

appInstanceArn

public final String appInstanceArn()

The ARN of the channel request.

Returns:

The ARN of the channel request.

name

public final String name()

The name of the channel.

Returns:

The name of the channel.

mode

public final ChannelMode mode()

The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.

If the service returns an enum value that is not available in the current SDK version, mode will return ChannelMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

Returns:

The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.

See Also:

ChannelMode

modeAsString

public final String modeAsString()

The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.

If the service returns an enum value that is not available in the current SDK version, mode will return ChannelMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

Returns:

The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.

See Also:

ChannelMode

privacy

public final ChannelPrivacy privacy()

The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.

If the service returns an enum value that is not available in the current SDK version, privacy will return ChannelPrivacy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from privacyAsString().

Returns:

The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.

See Also:

ChannelPrivacy

privacyAsString

public final String privacyAsString()

The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.

If the service returns an enum value that is not available in the current SDK version, privacy will return ChannelPrivacy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from privacyAsString().

Returns:

The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.

See Also:

ChannelPrivacy

metadata

public final String metadata()

The metadata of the creation request. Limited to 1KB and UTF-8.

Returns:

The metadata of the creation request. Limited to 1KB and UTF-8.

clientRequestToken

public final String clientRequestToken()

The client token for the request. An Idempotency token.

Returns:

The client token for the request. An Idempotency token.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final List<Tag> tags()

The tags for the creation request.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

The tags for the creation request.

chimeBearer

public final String chimeBearer()

The AppInstanceUserArn of the user that makes the API call.

Returns:

The AppInstanceUserArn of the user that makes the API call.

toBuilder

public CreateChannelRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>

Specified by:

toBuilder in class ChimeRequest

builder

public static CreateChannelRequest.Builder builder()

serializableBuilderClass

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