Interface ListHandshakesForOrganizationRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<ListHandshakesForOrganizationRequest.Builder,,ListHandshakesForOrganizationRequest> OrganizationsRequest.Builder,SdkBuilder<ListHandshakesForOrganizationRequest.Builder,,ListHandshakesForOrganizationRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
ListHandshakesForOrganizationRequest
-
Method Summary
Modifier and TypeMethodDescriptionfilter(Consumer<HandshakeFilter.Builder> filter) A filter of the handshakes that you want included in the response.filter(HandshakeFilter filter) A filter of the handshakes that you want included in the response.maxResults(Integer maxResults) The total number of results that you want included on each page of the response.The parameter for receiving additional results if you receive aNextTokenresponse in a previous request.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.organizations.model.OrganizationsRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
filter
A filter of the handshakes that you want included in the response. The default is all types. Use the
ActionTypeelement to limit the output to only a specified type, such asINVITE,ENABLE-ALL-FEATURES, orAPPROVE-ALL-FEATURES. Alternatively, for theENABLE-ALL-FEATUREShandshake that generates a separate child handshake for each member account, you can specify theParentHandshakeIdto see only the handshakes that were generated by that parent request.- Parameters:
filter- A filter of the handshakes that you want included in the response. The default is all types. Use theActionTypeelement to limit the output to only a specified type, such asINVITE,ENABLE-ALL-FEATURES, orAPPROVE-ALL-FEATURES. Alternatively, for theENABLE-ALL-FEATUREShandshake that generates a separate child handshake for each member account, you can specify theParentHandshakeIdto see only the handshakes that were generated by that parent request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filter
default ListHandshakesForOrganizationRequest.Builder filter(Consumer<HandshakeFilter.Builder> filter) A filter of the handshakes that you want included in the response. The default is all types. Use the
This is a convenience method that creates an instance of theActionTypeelement to limit the output to only a specified type, such asINVITE,ENABLE-ALL-FEATURES, orAPPROVE-ALL-FEATURES. Alternatively, for theENABLE-ALL-FEATUREShandshake that generates a separate child handshake for each member account, you can specify theParentHandshakeIdto see only the handshakes that were generated by that parent request.HandshakeFilter.Builderavoiding the need to create one manually viaHandshakeFilter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofilter(HandshakeFilter).- Parameters:
filter- a consumer that will call methods onHandshakeFilter.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
nextToken
The parameter for receiving additional results if you receive a
NextTokenresponse in a previous request. ANextTokenresponse indicates that more output is available. Set this parameter to the value of the previous call'sNextTokenresponse to indicate where the output should continue from.- Parameters:
nextToken- The parameter for receiving additional results if you receive aNextTokenresponse in a previous request. ANextTokenresponse indicates that more output is available. Set this parameter to the value of the previous call'sNextTokenresponse to indicate where the output should continue from.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the
NextTokenresponse element is present and has a value (is not null). Include that value as theNextTokenrequest parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should checkNextTokenafter every operation to ensure that you receive all of the results.- Parameters:
maxResults- The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, theNextTokenresponse element is present and has a value (is not null). Include that value as theNextTokenrequest parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should checkNextTokenafter every operation to ensure that you receive all of the results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListHandshakesForOrganizationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ListHandshakesForOrganizationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-