software.amazon.awssdk.services.verifiedpermissions.model.ListPoliciesRequest Maven / Gradle / Ivy
Show all versions of verifiedpermissions 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.verifiedpermissions.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 VerifiedPermissionsRequest implements
ToCopyableBuilder {
private static final SdkField POLICY_STORE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("policyStoreId").getter(getter(ListPoliciesRequest::policyStoreId))
.setter(setter(Builder::policyStoreId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("policyStoreId").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("nextToken").getter(getter(ListPoliciesRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("nextToken").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("maxResults").getter(getter(ListPoliciesRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("maxResults").build()).build();
private static final SdkField FILTER_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("filter").getter(getter(ListPoliciesRequest::filter)).setter(setter(Builder::filter))
.constructor(PolicyFilter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("filter").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(POLICY_STORE_ID_FIELD,
NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD, FILTER_FIELD));
private final String policyStoreId;
private final String nextToken;
private final Integer maxResults;
private final PolicyFilter filter;
private ListPoliciesRequest(BuilderImpl builder) {
super(builder);
this.policyStoreId = builder.policyStoreId;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
this.filter = builder.filter;
}
/**
*
* Specifies the ID of the policy store you want to list policies from.
*
*
* @return Specifies the ID of the policy store you want to list policies from.
*/
public final String policyStoreId() {
return policyStoreId;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final PolicyFilter filter() {
return filter;
}
@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(policyStoreId());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(filter());
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(policyStoreId(), other.policyStoreId()) && Objects.equals(nextToken(), other.nextToken())
&& Objects.equals(maxResults(), other.maxResults()) && Objects.equals(filter(), other.filter());
}
/**
* 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("PolicyStoreId", policyStoreId()).add("NextToken", nextToken())
.add("MaxResults", maxResults()).add("Filter", filter()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "policyStoreId":
return Optional.ofNullable(clazz.cast(policyStoreId()));
case "nextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "maxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "filter":
return Optional.ofNullable(clazz.cast(filter()));
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 VerifiedPermissionsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* Specifies the ID of the policy store you want to list policies from.
*
*
* @param policyStoreId
* Specifies the ID of the policy store you want to list policies from.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder policyStoreId(String policyStoreId);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
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.
*
* This is a convenience method that creates an instance of the {@link PolicyFilter.Builder} avoiding the need
* to create one manually via {@link PolicyFilter#builder()}.
*
*
* When the {@link Consumer} completes, {@link PolicyFilter.Builder#build()} is called immediately and its
* result is passed to {@link #filter(PolicyFilter)}.
*
* @param filter
* a consumer that will call methods on {@link PolicyFilter.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #filter(PolicyFilter)
*/
default Builder filter(Consumer filter) {
return filter(PolicyFilter.builder().applyMutation(filter).build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends VerifiedPermissionsRequest.BuilderImpl implements Builder {
private String policyStoreId;
private String nextToken;
private Integer maxResults;
private PolicyFilter filter;
private BuilderImpl() {
}
private BuilderImpl(ListPoliciesRequest model) {
super(model);
policyStoreId(model.policyStoreId);
nextToken(model.nextToken);
maxResults(model.maxResults);
filter(model.filter);
}
public final String getPolicyStoreId() {
return policyStoreId;
}
public final void setPolicyStoreId(String policyStoreId) {
this.policyStoreId = policyStoreId;
}
@Override
public final Builder policyStoreId(String policyStoreId) {
this.policyStoreId = policyStoreId;
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final PolicyFilter.Builder getFilter() {
return filter != null ? filter.toBuilder() : null;
}
public final void setFilter(PolicyFilter.BuilderImpl filter) {
this.filter = filter != null ? filter.build() : null;
}
@Override
public final Builder filter(PolicyFilter filter) {
this.filter = filter;
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;
}
}
}