Interface ListPoliciesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListPoliciesRequest.Builder,ListPoliciesRequest>, SdkBuilder<ListPoliciesRequest.Builder,ListPoliciesRequest>, SdkPojo, SdkRequest.Builder, VerifiedPermissionsRequest.Builder
Enclosing class:
ListPoliciesRequest
@Mutable @NotThreadSafe public static interface ListPoliciesRequest.Builder extends VerifiedPermissionsRequest.Builder, SdkPojo, CopyableBuilder<ListPoliciesRequest.Builder,ListPoliciesRequest>

  • Method Details

    • 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 NextToken response 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's NextToken response 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 a NextToken response 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's NextToken response 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 NextToken response element is returned with a value (not null). Include the specified value as the NextToken request 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 check NextToken after 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, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request 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 check NextToken after 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 the PolicyFilter.Builder avoiding the need to create one manually via PolicyFilter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filter(PolicyFilter).

      Parameters:
      filter - a consumer that will call methods on PolicyFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      ListPoliciesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListPoliciesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.