Interface ListAgreementsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListAgreementsRequest.Builder,
,ListAgreementsRequest> SdkBuilder<ListAgreementsRequest.Builder,
,ListAgreementsRequest> SdkPojo
,SdkRequest.Builder
,TransferRequest.Builder
- Enclosing class:
ListAgreementsRequest
public static interface ListAgreementsRequest.Builder
extends TransferRequest.Builder, SdkPojo, CopyableBuilder<ListAgreementsRequest.Builder,ListAgreementsRequest>
-
Method Summary
Modifier and TypeMethodDescriptionmaxResults
(Integer maxResults) The maximum number of agreements to return.When you can get additional results from theListAgreements
call, aNextToken
parameter is returned in the output.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The identifier of the server for which you want a list of agreements.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.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.transfer.model.TransferRequest.Builder
build
-
Method Details
-
maxResults
The maximum number of agreements to return.
- Parameters:
maxResults
- The maximum number of agreements to return.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
When you can get additional results from the
ListAgreements
call, aNextToken
parameter is returned in the output. You can then pass in a subsequent command to theNextToken
parameter to continue listing additional agreements.- Parameters:
nextToken
- When you can get additional results from theListAgreements
call, aNextToken
parameter is returned in the output. You can then pass in a subsequent command to theNextToken
parameter to continue listing additional agreements.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serverId
The identifier of the server for which you want a list of agreements.
- Parameters:
serverId
- The identifier of the server for which you want a list of agreements.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListAgreementsRequest.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
ListAgreementsRequest.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.
-