Class CreateChannelMembershipRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateChannelMembershipRequest.Builder,
CreateChannelMembershipRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The ARN of the channel to which you're adding users.final String
The ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call.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 String
TheAppInstanceUserArn
of the member you want to add to the channel.static Class
<? extends CreateChannelMembershipRequest.Builder> final String
The ID of the SubChannel in the 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.final ChannelMembershipType
type()
The membership type of a user,DEFAULT
orHIDDEN
.final String
The membership type of a user,DEFAULT
orHIDDEN
.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
channelArn
The ARN of the channel to which you're adding users.
- Returns:
- The ARN of the channel to which you're adding users.
-
memberArn
The
AppInstanceUserArn
of the member you want to add to the channel.- Returns:
- The
AppInstanceUserArn
of the member you want to add to the channel.
-
type
The membership type of a user,
DEFAULT
orHIDDEN
. Default members are always returned as part ofListChannelMemberships
. Hidden members are only returned if the type filter inListChannelMemberships
equalsHIDDEN
. Otherwise hidden members are not returned. This is only supported by moderators.If the service returns an enum value that is not available in the current SDK version,
type
will returnChannelMembershipType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The membership type of a user,
DEFAULT
orHIDDEN
. Default members are always returned as part ofListChannelMemberships
. Hidden members are only returned if the type filter inListChannelMemberships
equalsHIDDEN
. Otherwise hidden members are not returned. This is only supported by moderators. - See Also:
-
typeAsString
The membership type of a user,
DEFAULT
orHIDDEN
. Default members are always returned as part ofListChannelMemberships
. Hidden members are only returned if the type filter inListChannelMemberships
equalsHIDDEN
. Otherwise hidden members are not returned. This is only supported by moderators.If the service returns an enum value that is not available in the current SDK version,
type
will returnChannelMembershipType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The membership type of a user,
DEFAULT
orHIDDEN
. Default members are always returned as part ofListChannelMemberships
. Hidden members are only returned if the type filter inListChannelMemberships
equalsHIDDEN
. Otherwise hidden members are not returned. This is only supported by moderators. - See Also:
-
chimeBearer
The ARN of the
AppInstanceUser
orAppInstanceBot
that makes the API call.- Returns:
- The ARN of the
AppInstanceUser
orAppInstanceBot
that makes the API call.
-
subChannelId
The ID of the SubChannel in the request.
Only required when creating membership in a SubChannel for a moderator in an elastic channel.
- Returns:
- The ID of the SubChannel in the request.
Only required when creating membership in a SubChannel for a moderator in an elastic channel.
-
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<CreateChannelMembershipRequest.Builder,
CreateChannelMembershipRequest> - Specified by:
toBuilder
in classChimeSdkMessagingRequest
- 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
-