Interface ListChannelsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,ChimeRequest.Builder
,CopyableBuilder<ListChannelsRequest.Builder,
,ListChannelsRequest> SdkBuilder<ListChannelsRequest.Builder,
,ListChannelsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListChannelsRequest
public static interface ListChannelsRequest.Builder
extends ChimeRequest.Builder, SdkPojo, CopyableBuilder<ListChannelsRequest.Builder,ListChannelsRequest>
-
Method Summary
Modifier and TypeMethodDescriptionappInstanceArn
(String appInstanceArn) The ARN of theAppInstance
.chimeBearer
(String chimeBearer) TheAppInstanceUserArn
of the user that makes the API call.maxResults
(Integer maxResults) The maximum number of channels that you want to return.The token passed by previous API calls until all requested channels are returned.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The privacy setting.privacy
(ChannelPrivacy privacy) The privacy setting.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.chime.model.ChimeRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
appInstanceArn
The ARN of the
AppInstance
.- Parameters:
appInstanceArn
- The ARN of theAppInstance
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
privacy
The privacy setting.
PUBLIC
retrieves all the public channels.PRIVATE
retrieves private channels. Only anAppInstanceAdmin
can retrieve private channels.- Parameters:
privacy
- The privacy setting.PUBLIC
retrieves all the public channels.PRIVATE
retrieves private channels. Only anAppInstanceAdmin
can retrieve private channels.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
privacy
The privacy setting.
PUBLIC
retrieves all the public channels.PRIVATE
retrieves private channels. Only anAppInstanceAdmin
can retrieve private channels.- Parameters:
privacy
- The privacy setting.PUBLIC
retrieves all the public channels.PRIVATE
retrieves private channels. Only anAppInstanceAdmin
can retrieve private channels.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
maxResults
The maximum number of channels that you want to return.
- Parameters:
maxResults
- The maximum number of channels that you want to return.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
The token passed by previous API calls until all requested channels are returned.
- Parameters:
nextToken
- The token passed by previous API calls until all requested channels are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
chimeBearer
The
AppInstanceUserArn
of the user that makes the API call.- Parameters:
chimeBearer
- TheAppInstanceUserArn
of the user that makes the API call.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListChannelsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ListChannelsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-