@Generated(value="software.amazon.awssdk:codegen") public final class CreateChannelRequest extends ChimeSdkMessagingRequest implements ToCopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateChannelRequest.Builder |
| 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()
For responses, this returns true if the service returned a value for the Tags property.
|
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.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String appInstanceArn()
The ARN of the channel request.
public final String name()
The name of the channel.
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().
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.ChannelModepublic 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().
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.ChannelModepublic 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().
PUBLIC or PRIVATE. Private channels aren't
discoverable by users outside the channel. Public channels are discoverable by anyone in the
AppInstance.ChannelPrivacypublic 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().
PUBLIC or PRIVATE. Private channels aren't
discoverable by users outside the channel. Public channels are discoverable by anyone in the
AppInstance.ChannelPrivacypublic final String metadata()
The metadata of the creation request. Limited to 1KB and UTF-8.
public final String clientRequestToken()
The client token for the request. An Idempotency token.
Idempotency token.public final boolean hasTags()
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.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.
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.
public final String chimeBearer()
The AppInstanceUserArn of the user that makes the API call.
AppInstanceUserArn of the user that makes the API call.public CreateChannelRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>toBuilder in class ChimeSdkMessagingRequestpublic static CreateChannelRequest.Builder builder()
public static Class<? extends CreateChannelRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2022. All rights reserved.