Class CreateChannelMembershipRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.chimesdkmessaging.model.ChimeSdkMessagingRequest
software.amazon.awssdk.services.chimesdkmessaging.model.CreateChannelMembershipRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateChannelMembershipRequest.Builder,CreateChannelMembershipRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateChannelMembershipRequest extends ChimeSdkMessagingRequest implements ToCopyableBuilder<CreateChannelMembershipRequest.Builder,CreateChannelMembershipRequest>

  • Method Details

    • channelArn

      public final String 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

      public final String 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

      public final ChannelMembershipType type()

      The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. 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 return ChannelMembershipType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.
      See Also:

    • typeAsString

      public final String typeAsString()

      The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. 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 return ChannelMembershipType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.
      See Also:

    • chimeBearer

      public final String chimeBearer()

      The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

      Returns:
      The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    • subChannelId

      public final String 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

      public CreateChannelMembershipRequest.Builder 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 interface ToCopyableBuilder<CreateChannelMembershipRequest.Builder,CreateChannelMembershipRequest>
      Specified by:
      toBuilder in class ChimeSdkMessagingRequest
      Returns:
      a builder for type T

    • builder

      public static CreateChannelMembershipRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateChannelMembershipRequest.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.