software.amazon.awssdk.services.ram.model.GetResourcePoliciesRequest Maven / Gradle / Ivy
/*
* 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.ram.model;
import java.util.Arrays;
import java.util.Collection;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
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 GetResourcePoliciesRequest extends RamRequest implements
ToCopyableBuilder {
private static final SdkField> RESOURCE_ARNS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("resourceArns")
.getter(getter(GetResourcePoliciesRequest::resourceArns))
.setter(setter(Builder::resourceArns))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("resourceArns").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField PRINCIPAL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("principal").getter(getter(GetResourcePoliciesRequest::principal)).setter(setter(Builder::principal))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("principal").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("nextToken").getter(getter(GetResourcePoliciesRequest::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(GetResourcePoliciesRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("maxResults").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RESOURCE_ARNS_FIELD,
PRINCIPAL_FIELD, NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD));
private final List resourceArns;
private final String principal;
private final String nextToken;
private final Integer maxResults;
private GetResourcePoliciesRequest(BuilderImpl builder) {
super(builder);
this.resourceArns = builder.resourceArns;
this.principal = builder.principal;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
}
/**
* For responses, this returns true if the service returned a value for the ResourceArns property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasResourceArns() {
return resourceArns != null && !(resourceArns instanceof SdkAutoConstructList);
}
/**
*
* Specifies the Amazon
* Resource Names (ARNs) of the resources whose policies you want to retrieve.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasResourceArns} method.
*
*
* @return Specifies the Amazon
* Resource Names (ARNs) of the resources whose policies you want to retrieve.
*/
public final List resourceArns() {
return resourceArns;
}
/**
*
* Specifies the principal.
*
*
* @return Specifies the principal.
*/
public final String principal() {
return principal;
}
/**
*
* 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 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
* 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
* part of the 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.
*
*
* @return Specifies 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 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 part of the 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.
*/
public final Integer maxResults() {
return maxResults;
}
@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(hasResourceArns() ? resourceArns() : null);
hashCode = 31 * hashCode + Objects.hashCode(principal());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
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 GetResourcePoliciesRequest)) {
return false;
}
GetResourcePoliciesRequest other = (GetResourcePoliciesRequest) obj;
return hasResourceArns() == other.hasResourceArns() && Objects.equals(resourceArns(), other.resourceArns())
&& Objects.equals(principal(), other.principal()) && Objects.equals(nextToken(), other.nextToken())
&& Objects.equals(maxResults(), other.maxResults());
}
/**
* 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("GetResourcePoliciesRequest").add("ResourceArns", hasResourceArns() ? resourceArns() : null)
.add("Principal", principal()).add("NextToken", nextToken()).add("MaxResults", maxResults()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "resourceArns":
return Optional.ofNullable(clazz.cast(resourceArns()));
case "principal":
return Optional.ofNullable(clazz.cast(principal()));
case "nextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "maxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetResourcePoliciesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends RamRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* Specifies the Amazon
* Resource Names (ARNs) of the resources whose policies you want to retrieve.
*
*
* @param resourceArns
* Specifies the Amazon Resource
* Names (ARNs) of the resources whose policies you want to retrieve.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceArns(Collection resourceArns);
/**
*
* Specifies the Amazon
* Resource Names (ARNs) of the resources whose policies you want to retrieve.
*
*
* @param resourceArns
* Specifies the Amazon Resource
* Names (ARNs) of the resources whose policies you want to retrieve.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceArns(String... resourceArns);
/**
*
* Specifies the principal.
*
*
* @param principal
* Specifies the principal.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder principal(String principal);
/**
*
* 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 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 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 part of the 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.
*
*
* @param maxResults
* Specifies 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 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 part of the 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RamRequest.BuilderImpl implements Builder {
private List resourceArns = DefaultSdkAutoConstructList.getInstance();
private String principal;
private String nextToken;
private Integer maxResults;
private BuilderImpl() {
}
private BuilderImpl(GetResourcePoliciesRequest model) {
super(model);
resourceArns(model.resourceArns);
principal(model.principal);
nextToken(model.nextToken);
maxResults(model.maxResults);
}
public final Collection getResourceArns() {
if (resourceArns instanceof SdkAutoConstructList) {
return null;
}
return resourceArns;
}
public final void setResourceArns(Collection resourceArns) {
this.resourceArns = ResourceArnListCopier.copy(resourceArns);
}
@Override
public final Builder resourceArns(Collection resourceArns) {
this.resourceArns = ResourceArnListCopier.copy(resourceArns);
return this;
}
@Override
@SafeVarargs
public final Builder resourceArns(String... resourceArns) {
resourceArns(Arrays.asList(resourceArns));
return this;
}
public final String getPrincipal() {
return principal;
}
public final void setPrincipal(String principal) {
this.principal = principal;
}
@Override
public final Builder principal(String principal) {
this.principal = principal;
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;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public GetResourcePoliciesRequest build() {
return new GetResourcePoliciesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy