Class ListChannelsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListChannelsRequest.Builder,
ListChannelsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ARN of theAppInstance
.static ListChannelsRequest.Builder
builder()
final String
TheAppInstanceUserArn
of the user 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 Integer
The maximum number of channels that you want to return.final String
The token passed by previous API calls until all requested channels are returned.final ChannelPrivacy
privacy()
The privacy setting.final String
The privacy setting.static Class
<? extends ListChannelsRequest.Builder> 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
AppInstance
.- Returns:
- The ARN of the
AppInstance
.
-
privacy
The privacy setting.
PUBLIC
retrieves all the public channels.PRIVATE
retrieves private channels. Only anAppInstanceAdmin
can retrieve private channels.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 privacy setting.
PUBLIC
retrieves all the public channels.PRIVATE
retrieves private channels. Only anAppInstanceAdmin
can retrieve private channels. - See Also:
-
privacyAsString
The privacy setting.
PUBLIC
retrieves all the public channels.PRIVATE
retrieves private channels. Only anAppInstanceAdmin
can retrieve private channels.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 privacy setting.
PUBLIC
retrieves all the public channels.PRIVATE
retrieves private channels. Only anAppInstanceAdmin
can retrieve private channels. - See Also:
-
maxResults
The maximum number of channels that you want to return.
- Returns:
- The maximum number of channels that you want to return.
-
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
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<ListChannelsRequest.Builder,
ListChannelsRequest> - 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
-