Interface ListPipesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListPipesRequest.Builder,
,ListPipesRequest> PipesRequest.Builder
,SdkBuilder<ListPipesRequest.Builder,
,ListPipesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListPipesRequest
-
Method Summary
Modifier and TypeMethodDescriptioncurrentState
(String currentState) The state the pipe is in.currentState
(PipeState currentState) The state the pipe is in.desiredState
(String desiredState) The state the pipe should be in.desiredState
(RequestedPipeState desiredState) The state the pipe should be in.The maximum number of pipes to include in the response.namePrefix
(String namePrefix) A value that will return a subset of the pipes associated with this account.IfnextToken
is returned, there are more results available.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.sourcePrefix
(String sourcePrefix) The prefix matching the pipe source.targetPrefix
(String targetPrefix) The prefix matching the pipe target.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.pipes.model.PipesRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
namePrefix
A value that will return a subset of the pipes associated with this account. For example,
"NamePrefix": "ABC"
will return all endpoints with "ABC" in the name.- Parameters:
namePrefix
- A value that will return a subset of the pipes associated with this account. For example,"NamePrefix": "ABC"
will return all endpoints with "ABC" in the name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
desiredState
The state the pipe should be in.
- Parameters:
desiredState
- The state the pipe should be in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
desiredState
The state the pipe should be in.
- Parameters:
desiredState
- The state the pipe should be in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
currentState
The state the pipe is in.
- Parameters:
currentState
- The state the pipe is in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
currentState
The state the pipe is in.
- Parameters:
currentState
- The state the pipe is in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sourcePrefix
The prefix matching the pipe source.
- Parameters:
sourcePrefix
- The prefix matching the pipe source.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetPrefix
The prefix matching the pipe target.
- Parameters:
targetPrefix
- The prefix matching the pipe target.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
If
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.- Parameters:
nextToken
- IfnextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
limit
The maximum number of pipes to include in the response.
- Parameters:
limit
- The maximum number of pipes to include in the response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListPipesRequest.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
ListPipesRequest.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.
-