Class CreateChannelRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateChannelRequest.Builder,
CreateChannelRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ARN of the channel request.static CreateChannelRequest.Builder
builder()
final String
TheAppInstanceUserArn
of the user that makes the API call.final String
The client token for the request.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
metadata()
The metadata of the creation request.final ChannelMode
mode()
The channel mode:UNRESTRICTED
orRESTRICTED
.final String
The channel mode:UNRESTRICTED
orRESTRICTED
.final String
name()
The name of the channel.final ChannelPrivacy
privacy()
The channel's privacy level:PUBLIC
orPRIVATE
.final String
The channel's privacy level:PUBLIC
orPRIVATE
.static Class
<? extends CreateChannelRequest.Builder> tags()
The tags for the creation request.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
appInstanceArn
The ARN of the channel request.
- Returns:
- The ARN of the channel request.
-
name
The name of the channel.
- Returns:
- The name of the channel.
-
mode
The channel mode:
UNRESTRICTED
orRESTRICTED
. 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 returnChannelMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommodeAsString()
.- Returns:
- The channel mode:
UNRESTRICTED
orRESTRICTED
. 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:
-
modeAsString
The channel mode:
UNRESTRICTED
orRESTRICTED
. 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 returnChannelMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommodeAsString()
.- Returns:
- The channel mode:
UNRESTRICTED
orRESTRICTED
. 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:
-
privacy
The channel's privacy level:
PUBLIC
orPRIVATE
. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in theAppInstance
.If the service returns an enum value that is not available in the current SDK version,
privacy
will returnChannelPrivacy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprivacyAsString()
.- Returns:
- The channel's privacy level:
PUBLIC
orPRIVATE
. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in theAppInstance
. - See Also:
-
privacyAsString
The channel's privacy level:
PUBLIC
orPRIVATE
. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in theAppInstance
.If the service returns an enum value that is not available in the current SDK version,
privacy
will returnChannelPrivacy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprivacyAsString()
.- Returns:
- The channel's privacy level:
PUBLIC
orPRIVATE
. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in theAppInstance
. - See Also:
-
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
The client token for the request. An
Idempotency
token.- Returns:
- The client token for the request. An
Idempotency
token.
-
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 theisEmpty()
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
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.- Returns:
- The tags for the creation request.
-
chimeBearer
The
AppInstanceUserArn
of the user that makes the API call.- Returns:
- The
AppInstanceUserArn
of the user that makes the API call.
-
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 interfaceToCopyableBuilder<CreateChannelRequest.Builder,
CreateChannelRequest> - Specified by:
toBuilder
in classChimeRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-