Interface ListPoliciesRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<ListPoliciesRequest.Builder,ListPoliciesRequest>,SdkBuilder<ListPoliciesRequest.Builder,ListPoliciesRequest>,SdkPojo,SdkRequest.Builder,VerifiedPermissionsRequest.Builder
- Enclosing class:
- ListPoliciesRequest
public static interface ListPoliciesRequest.Builder extends VerifiedPermissionsRequest.Builder, SdkPojo, CopyableBuilder<ListPoliciesRequest.Builder,ListPoliciesRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default ListPoliciesRequest.Builderfilter(Consumer<PolicyFilter.Builder> filter)Specifies a filter that limits the response to only policies that match the specified criteria.ListPoliciesRequest.Builderfilter(PolicyFilter filter)Specifies a filter that limits the response to only policies that match the specified criteria.ListPoliciesRequest.BuildermaxResults(Integer maxResults)Specifies the total number of results that you want included in each response.ListPoliciesRequest.BuildernextToken(String nextToken)Specifies that you want to receive the next page of results.ListPoliciesRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)ListPoliciesRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)ListPoliciesRequest.BuilderpolicyStoreId(String policyStoreId)Specifies the ID of the policy store you want to list policies from.-
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.verifiedpermissions.model.VerifiedPermissionsRequest.Builder
build
-
-
-
-
Method Detail
-
policyStoreId
ListPoliciesRequest.Builder policyStoreId(String policyStoreId)
Specifies the ID of the policy store you want to list policies from.
- Parameters:
policyStoreId- Specifies the ID of the policy store you want to list policies from.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
ListPoliciesRequest.Builder nextToken(String nextToken)
Specifies that you want to receive the next page of results. Valid only if you received a
NextTokenresponse in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call'sNextTokenresponse to request the next page of results.- Parameters:
nextToken- Specifies that you want to receive the next page of results. Valid only if you received aNextTokenresponse in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call'sNextTokenresponse to request the next page of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
ListPoliciesRequest.Builder maxResults(Integer maxResults)
Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the
NextTokenresponse element is returned with a value (not null). Include the specified value as theNextTokenrequest parameter in the next call to the operation to get the next set of results. Note that the service 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.If you do not specify this parameter, the operation defaults to 10 policies per response. You can specify a maximum of 50 policies per response.
- Parameters:
maxResults- Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, theNextTokenresponse element is returned with a value (not null). Include the specified value as theNextTokenrequest parameter in the next call to the operation to get the next set of results. Note that the service 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.If you do not specify this parameter, the operation defaults to 10 policies per response. You can specify a maximum of 50 policies per response.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filter
ListPoliciesRequest.Builder filter(PolicyFilter filter)
Specifies a filter that limits the response to only policies that match the specified criteria. For example, you list only the policies that reference a specified principal.
- Parameters:
filter- Specifies a filter that limits the response to only policies that match the specified criteria. For example, you list only the policies that reference a specified principal.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filter
default ListPoliciesRequest.Builder filter(Consumer<PolicyFilter.Builder> filter)
Specifies a filter that limits the response to only policies that match the specified criteria. For example, you list only the policies that reference a specified principal.
This is a convenience method that creates an instance of thePolicyFilter.Builderavoiding the need to create one manually viaPolicyFilter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofilter(PolicyFilter).- Parameters:
filter- a consumer that will call methods onPolicyFilter.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
filter(PolicyFilter)
-
overrideConfiguration
ListPoliciesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
ListPoliciesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-