Interface ListStreamsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListStreamsRequest.Builder,
,ListStreamsRequest> KinesisVideoRequest.Builder
,SdkBuilder<ListStreamsRequest.Builder,
,ListStreamsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListStreamsRequest
public static interface ListStreamsRequest.Builder
extends KinesisVideoRequest.Builder, SdkPojo, CopyableBuilder<ListStreamsRequest.Builder,ListStreamsRequest>
-
Method Summary
Modifier and TypeMethodDescriptionmaxResults
(Integer maxResults) The maximum number of streams to return in the response.If you specify this parameter, when the result of aListStreams
operation is truncated, the call returns theNextToken
in the response.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default ListStreamsRequest.Builder
streamNameCondition
(Consumer<StreamNameCondition.Builder> streamNameCondition) Optional: Returns only streams that satisfy a specific condition.streamNameCondition
(StreamNameCondition streamNameCondition) Optional: Returns only streams that satisfy a specific condition.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.kinesisvideo.model.KinesisVideoRequest.Builder
build
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
-
maxResults
The maximum number of streams to return in the response. The default is 10,000.
- Parameters:
maxResults
- The maximum number of streams to return in the response. The default is 10,000.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
If you specify this parameter, when the result of a
ListStreams
operation is truncated, the call returns theNextToken
in the response. To get another batch of streams, provide this token in your next request.- Parameters:
nextToken
- If you specify this parameter, when the result of aListStreams
operation is truncated, the call returns theNextToken
in the response. To get another batch of streams, provide this token in your next request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
streamNameCondition
Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.
- Parameters:
streamNameCondition
- Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
streamNameCondition
default ListStreamsRequest.Builder streamNameCondition(Consumer<StreamNameCondition.Builder> streamNameCondition) Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.
This is a convenience method that creates an instance of theStreamNameCondition.Builder
avoiding the need to create one manually viaStreamNameCondition.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostreamNameCondition(StreamNameCondition)
.- Parameters:
streamNameCondition
- a consumer that will call methods onStreamNameCondition.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
ListStreamsRequest.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
ListStreamsRequest.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.
-