software.amazon.awssdk.services.iam.model.ListPoliciesRequest Maven / Gradle / Ivy
Show all versions of iam Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.iam.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class ListPoliciesRequest extends IamRequest implements
ToCopyableBuilder {
private static final SdkField SCOPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Scope")
.getter(getter(ListPoliciesRequest::scopeAsString)).setter(setter(Builder::scope))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Scope").build()).build();
private static final SdkField ONLY_ATTACHED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("OnlyAttached").getter(getter(ListPoliciesRequest::onlyAttached)).setter(setter(Builder::onlyAttached))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OnlyAttached").build()).build();
private static final SdkField PATH_PREFIX_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PathPrefix").getter(getter(ListPoliciesRequest::pathPrefix)).setter(setter(Builder::pathPrefix))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PathPrefix").build()).build();
private static final SdkField POLICY_USAGE_FILTER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PolicyUsageFilter").getter(getter(ListPoliciesRequest::policyUsageFilterAsString))
.setter(setter(Builder::policyUsageFilter))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PolicyUsageFilter").build()).build();
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Marker")
.getter(getter(ListPoliciesRequest::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final SdkField MAX_ITEMS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxItems").getter(getter(ListPoliciesRequest::maxItems)).setter(setter(Builder::maxItems))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxItems").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SCOPE_FIELD,
ONLY_ATTACHED_FIELD, PATH_PREFIX_FIELD, POLICY_USAGE_FILTER_FIELD, MARKER_FIELD, MAX_ITEMS_FIELD));
private final String scope;
private final Boolean onlyAttached;
private final String pathPrefix;
private final String policyUsageFilter;
private final String marker;
private final Integer maxItems;
private ListPoliciesRequest(BuilderImpl builder) {
super(builder);
this.scope = builder.scope;
this.onlyAttached = builder.onlyAttached;
this.pathPrefix = builder.pathPrefix;
this.policyUsageFilter = builder.policyUsageFilter;
this.marker = builder.marker;
this.maxItems = builder.maxItems;
}
/**
*
* The scope to use for filtering the results.
*
*
* To list only Amazon Web Services managed policies, set Scope to AWS. To list only the
* customer managed policies in your Amazon Web Services account, set Scope to Local.
*
*
* This parameter is optional. If it is not included, or if it is set to All, all policies are
* returned.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #scope} will return
* {@link PolicyScopeType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #scopeAsString}.
*
*
* @return The scope to use for filtering the results.
*
* To list only Amazon Web Services managed policies, set Scope to AWS. To list
* only the customer managed policies in your Amazon Web Services account, set Scope to
* Local.
*
*
* This parameter is optional. If it is not included, or if it is set to All, all policies are
* returned.
* @see PolicyScopeType
*/
public final PolicyScopeType scope() {
return PolicyScopeType.fromValue(scope);
}
/**
*
* The scope to use for filtering the results.
*
*
* To list only Amazon Web Services managed policies, set Scope to AWS. To list only the
* customer managed policies in your Amazon Web Services account, set Scope to Local.
*
*
* This parameter is optional. If it is not included, or if it is set to All, all policies are
* returned.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #scope} will return
* {@link PolicyScopeType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #scopeAsString}.
*
*
* @return The scope to use for filtering the results.
*
* To list only Amazon Web Services managed policies, set Scope to AWS. To list
* only the customer managed policies in your Amazon Web Services account, set Scope to
* Local.
*
*
* This parameter is optional. If it is not included, or if it is set to All, all policies are
* returned.
* @see PolicyScopeType
*/
public final String scopeAsString() {
return scope;
}
/**
*
* A flag to filter the results to only the attached policies.
*
*
* When OnlyAttached is true, the returned list contains only the policies that are
* attached to an IAM user, group, or role. When OnlyAttached is false, or when the
* parameter is not included, all policies are returned.
*
*
* @return A flag to filter the results to only the attached policies.
*
* When OnlyAttached is true, the returned list contains only the policies that
* are attached to an IAM user, group, or role. When OnlyAttached is false, or
* when the parameter is not included, all policies are returned.
*/
public final Boolean onlyAttached() {
return onlyAttached;
}
/**
*
* The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a
* slash (/), listing all policies. This parameter allows (through its regex pattern) a string of characters consisting of either a forward
* slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any
* ASCII character from the ! (\u0021) through the DEL character (\u007F), including most
* punctuation characters, digits, and upper and lowercased letters.
*
*
* @return The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults
* to a slash (/), listing all policies. This parameter allows (through its regex pattern) a string of characters consisting of either a
* forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can
* contain any ASCII character from the ! (\u0021) through the DEL character (
* \u007F), including most punctuation characters, digits, and upper and lowercased letters.
*/
public final String pathPrefix() {
return pathPrefix;
}
/**
*
* The policy usage method to use for filtering the results.
*
*
* To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list
* only the policies used to set permissions boundaries, set the value to PermissionsBoundary.
*
*
* This parameter is optional. If it is not included, all policies are returned.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #policyUsageFilter}
* will return {@link PolicyUsageType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #policyUsageFilterAsString}.
*
*
* @return The policy usage method to use for filtering the results.
*
* To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy.
* To list only the policies used to set permissions boundaries, set the value to
* PermissionsBoundary.
*
*
* This parameter is optional. If it is not included, all policies are returned.
* @see PolicyUsageType
*/
public final PolicyUsageType policyUsageFilter() {
return PolicyUsageType.fromValue(policyUsageFilter);
}
/**
*
* The policy usage method to use for filtering the results.
*
*
* To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list
* only the policies used to set permissions boundaries, set the value to PermissionsBoundary.
*
*
* This parameter is optional. If it is not included, all policies are returned.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #policyUsageFilter}
* will return {@link PolicyUsageType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #policyUsageFilterAsString}.
*
*
* @return The policy usage method to use for filtering the results.
*
* To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy.
* To list only the policies used to set permissions boundaries, set the value to
* PermissionsBoundary.
*
*
* This parameter is optional. If it is not included, all policies are returned.
* @see PolicyUsageType
*/
public final String policyUsageFilterAsString() {
return policyUsageFilter;
}
/**
*
* Use this parameter only when paginating results and only after you receive a response indicating that the results
* are truncated. Set it to the value of the Marker element in the response that you received to
* indicate where the next call should start.
*
*
* @return Use this parameter only when paginating results and only after you receive a response indicating that the
* results are truncated. Set it to the value of the Marker element in the response that you
* received to indicate where the next call should start.
*/
public final String marker() {
return marker;
}
/**
*
* Use this only when paginating results to indicate the maximum number of items you want in the response. If
* additional items exist beyond the maximum you specify, the IsTruncated response element is
* true.
*
*
* If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
* results, even when there are more results available. In that case, the IsTruncated response element
* returns true, and Marker contains a value to include in the subsequent call that tells
* the service where to continue from.
*
*
* @return Use this only when paginating results to indicate the maximum number of items you want in the response.
* If additional items exist beyond the maximum you specify, the IsTruncated response element
* is true.
*
* If you do not include this parameter, the number of items defaults to 100. Note that IAM might return
* fewer results, even when there are more results available. In that case, the IsTruncated
* response element returns true, and Marker contains a value to include in the
* subsequent call that tells the service where to continue from.
*/
public final Integer maxItems() {
return maxItems;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(scopeAsString());
hashCode = 31 * hashCode + Objects.hashCode(onlyAttached());
hashCode = 31 * hashCode + Objects.hashCode(pathPrefix());
hashCode = 31 * hashCode + Objects.hashCode(policyUsageFilterAsString());
hashCode = 31 * hashCode + Objects.hashCode(marker());
hashCode = 31 * hashCode + Objects.hashCode(maxItems());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ListPoliciesRequest)) {
return false;
}
ListPoliciesRequest other = (ListPoliciesRequest) obj;
return Objects.equals(scopeAsString(), other.scopeAsString()) && Objects.equals(onlyAttached(), other.onlyAttached())
&& Objects.equals(pathPrefix(), other.pathPrefix())
&& Objects.equals(policyUsageFilterAsString(), other.policyUsageFilterAsString())
&& Objects.equals(marker(), other.marker()) && Objects.equals(maxItems(), other.maxItems());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("ListPoliciesRequest").add("Scope", scopeAsString()).add("OnlyAttached", onlyAttached())
.add("PathPrefix", pathPrefix()).add("PolicyUsageFilter", policyUsageFilterAsString()).add("Marker", marker())
.add("MaxItems", maxItems()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Scope":
return Optional.ofNullable(clazz.cast(scopeAsString()));
case "OnlyAttached":
return Optional.ofNullable(clazz.cast(onlyAttached()));
case "PathPrefix":
return Optional.ofNullable(clazz.cast(pathPrefix()));
case "PolicyUsageFilter":
return Optional.ofNullable(clazz.cast(policyUsageFilterAsString()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
case "MaxItems":
return Optional.ofNullable(clazz.cast(maxItems()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListPoliciesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IamRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The scope to use for filtering the results.
*
*
* To list only Amazon Web Services managed policies, set Scope to AWS. To list only
* the customer managed policies in your Amazon Web Services account, set Scope to
* Local.
*
*
* This parameter is optional. If it is not included, or if it is set to All, all policies are
* returned.
*
*
* @param scope
* The scope to use for filtering the results.
*
* To list only Amazon Web Services managed policies, set Scope to AWS. To list
* only the customer managed policies in your Amazon Web Services account, set Scope to
* Local.
*
*
* This parameter is optional. If it is not included, or if it is set to All, all policies
* are returned.
* @see PolicyScopeType
* @return Returns a reference to this object so that method calls can be chained together.
* @see PolicyScopeType
*/
Builder scope(String scope);
/**
*
* The scope to use for filtering the results.
*
*
* To list only Amazon Web Services managed policies, set Scope to AWS. To list only
* the customer managed policies in your Amazon Web Services account, set Scope to
* Local.
*
*
* This parameter is optional. If it is not included, or if it is set to All, all policies are
* returned.
*
*
* @param scope
* The scope to use for filtering the results.
*
* To list only Amazon Web Services managed policies, set Scope to AWS. To list
* only the customer managed policies in your Amazon Web Services account, set Scope to
* Local.
*
*
* This parameter is optional. If it is not included, or if it is set to All, all policies
* are returned.
* @see PolicyScopeType
* @return Returns a reference to this object so that method calls can be chained together.
* @see PolicyScopeType
*/
Builder scope(PolicyScopeType scope);
/**
*
* A flag to filter the results to only the attached policies.
*
*
* When OnlyAttached is true, the returned list contains only the policies that are
* attached to an IAM user, group, or role. When OnlyAttached is false, or when the
* parameter is not included, all policies are returned.
*
*
* @param onlyAttached
* A flag to filter the results to only the attached policies.
*
* When OnlyAttached is true, the returned list contains only the policies that
* are attached to an IAM user, group, or role. When OnlyAttached is false, or
* when the parameter is not included, all policies are returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder onlyAttached(Boolean onlyAttached);
/**
*
* The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to
* a slash (/), listing all policies. This parameter allows (through its regex pattern) a string of characters consisting of either a
* forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can
* contain any ASCII character from the ! (\u0021) through the DEL character (\u007F),
* including most punctuation characters, digits, and upper and lowercased letters.
*
*
* @param pathPrefix
* The path prefix for filtering the results. This parameter is optional. If it is not included, it
* defaults to a slash (/), listing all policies. This parameter allows (through its regex pattern) a string of characters consisting of either
* a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition,
* it can contain any ASCII character from the ! (\u0021) through the DEL character (
* \u007F), including most punctuation characters, digits, and upper and lowercased letters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pathPrefix(String pathPrefix);
/**
*
* The policy usage method to use for filtering the results.
*
*
* To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To
* list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.
*
*
* This parameter is optional. If it is not included, all policies are returned.
*
*
* @param policyUsageFilter
* The policy usage method to use for filtering the results.
*
* To list only permissions policies, set PolicyUsageFilter to
* PermissionsPolicy. To list only the policies used to set permissions boundaries, set the
* value to PermissionsBoundary.
*
*
* This parameter is optional. If it is not included, all policies are returned.
* @see PolicyUsageType
* @return Returns a reference to this object so that method calls can be chained together.
* @see PolicyUsageType
*/
Builder policyUsageFilter(String policyUsageFilter);
/**
*
* The policy usage method to use for filtering the results.
*
*
* To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To
* list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.
*
*
* This parameter is optional. If it is not included, all policies are returned.
*
*
* @param policyUsageFilter
* The policy usage method to use for filtering the results.
*
* To list only permissions policies, set PolicyUsageFilter to
* PermissionsPolicy. To list only the policies used to set permissions boundaries, set the
* value to PermissionsBoundary.
*
*
* This parameter is optional. If it is not included, all policies are returned.
* @see PolicyUsageType
* @return Returns a reference to this object so that method calls can be chained together.
* @see PolicyUsageType
*/
Builder policyUsageFilter(PolicyUsageType policyUsageFilter);
/**
*
* Use this parameter only when paginating results and only after you receive a response indicating that the
* results are truncated. Set it to the value of the Marker element in the response that you
* received to indicate where the next call should start.
*
*
* @param marker
* Use this parameter only when paginating results and only after you receive a response indicating that
* the results are truncated. Set it to the value of the Marker element in the response that
* you received to indicate where the next call should start.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder marker(String marker);
/**
*
* Use this only when paginating results to indicate the maximum number of items you want in the response. If
* additional items exist beyond the maximum you specify, the IsTruncated response element is
* true.
*
*
* If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
* results, even when there are more results available. In that case, the IsTruncated response
* element returns true, and Marker contains a value to include in the subsequent call
* that tells the service where to continue from.
*
*
* @param maxItems
* Use this only when paginating results to indicate the maximum number of items you want in the
* response. If additional items exist beyond the maximum you specify, the IsTruncated
* response element is true.
*
* If you do not include this parameter, the number of items defaults to 100. Note that IAM might return
* fewer results, even when there are more results available. In that case, the IsTruncated
* response element returns true, and Marker contains a value to include in the
* subsequent call that tells the service where to continue from.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxItems(Integer maxItems);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends IamRequest.BuilderImpl implements Builder {
private String scope;
private Boolean onlyAttached;
private String pathPrefix;
private String policyUsageFilter;
private String marker;
private Integer maxItems;
private BuilderImpl() {
}
private BuilderImpl(ListPoliciesRequest model) {
super(model);
scope(model.scope);
onlyAttached(model.onlyAttached);
pathPrefix(model.pathPrefix);
policyUsageFilter(model.policyUsageFilter);
marker(model.marker);
maxItems(model.maxItems);
}
public final String getScope() {
return scope;
}
public final void setScope(String scope) {
this.scope = scope;
}
@Override
public final Builder scope(String scope) {
this.scope = scope;
return this;
}
@Override
public final Builder scope(PolicyScopeType scope) {
this.scope(scope == null ? null : scope.toString());
return this;
}
public final Boolean getOnlyAttached() {
return onlyAttached;
}
public final void setOnlyAttached(Boolean onlyAttached) {
this.onlyAttached = onlyAttached;
}
@Override
public final Builder onlyAttached(Boolean onlyAttached) {
this.onlyAttached = onlyAttached;
return this;
}
public final String getPathPrefix() {
return pathPrefix;
}
public final void setPathPrefix(String pathPrefix) {
this.pathPrefix = pathPrefix;
}
@Override
public final Builder pathPrefix(String pathPrefix) {
this.pathPrefix = pathPrefix;
return this;
}
public final String getPolicyUsageFilter() {
return policyUsageFilter;
}
public final void setPolicyUsageFilter(String policyUsageFilter) {
this.policyUsageFilter = policyUsageFilter;
}
@Override
public final Builder policyUsageFilter(String policyUsageFilter) {
this.policyUsageFilter = policyUsageFilter;
return this;
}
@Override
public final Builder policyUsageFilter(PolicyUsageType policyUsageFilter) {
this.policyUsageFilter(policyUsageFilter == null ? null : policyUsageFilter.toString());
return this;
}
public final String getMarker() {
return marker;
}
public final void setMarker(String marker) {
this.marker = marker;
}
@Override
public final Builder marker(String marker) {
this.marker = marker;
return this;
}
public final Integer getMaxItems() {
return maxItems;
}
public final void setMaxItems(Integer maxItems) {
this.maxItems = maxItems;
}
@Override
public final Builder maxItems(Integer maxItems) {
this.maxItems = maxItems;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ListPoliciesRequest build() {
return new ListPoliciesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}