Class ListChannelsRequest

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

  • Method Details

    • appInstanceArn

      public final String appInstanceArn()

      The ARN of the AppInstance.

      Returns:
      The ARN of the AppInstance.

    • privacy

      public final ChannelPrivacy privacy()

      The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.

      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 privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.
      See Also:

    • privacyAsString

      public final String privacyAsString()

      The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.

      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 privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.
      See Also:

    • maxResults

      public final Integer maxResults()

      The maximum number of channels that you want to return.

      Returns:
      The maximum number of channels that you want to return.

    • nextToken

      public final String nextToken()

      The token passed by previous API calls until all requested channels are returned.

      Returns:
      The token passed by previous API calls until all requested channels are returned.

    • chimeBearer

      public final String chimeBearer()

      The AppInstanceUserArn of the user that makes the API call.

      Returns:
      The AppInstanceUserArn of the user that makes the API call.

    • toBuilder

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

    • builder

      public static ListChannelsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListChannelsRequest.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.