Package software.amazon.awssdk.services.chimesdkmessaging.model

Class CreateChannelRequest

    • 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()
        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 the 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.

      • 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.

        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

        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.

      • channelId

        public final String channelId()

        The ID of the channel in the request.

        Returns:
        The ID of the channel in the request.

      • hasMemberArns

        public final boolean hasMemberArns()
        For responses, this returns true if the service returned a value for the MemberArns property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

      • memberArns

        public final List<String> memberArns()

        The ARNs of the channel members in the 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 hasMemberArns() method.

        Returns:
        The ARNs of the channel members in the request.

      • hasModeratorArns

        public final boolean hasModeratorArns()
        For responses, this returns true if the service returned a value for the ModeratorArns property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

      • moderatorArns

        public final List<String> moderatorArns()

        The ARNs of the channel moderators in the 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 hasModeratorArns() method.

        Returns:
        The ARNs of the channel moderators in the request.

      • elasticChannelConfiguration

        public final ElasticChannelConfiguration elasticChannelConfiguration()

        The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.

        Returns:
        The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.

      • expirationSettings

        public final ExpirationSettings expirationSettings()

        Settings that control the interval after which the channel is automatically deleted.

        Returns:
        Settings that control the interval after which the channel is automatically deleted.

      • 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