software.amazon.awssdk.services.iam.model.GetContextKeysForPrincipalPolicyRequest 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.iam.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 GetContextKeysForPrincipalPolicyRequest extends IamRequest implements
ToCopyableBuilder {
private static final SdkField POLICY_SOURCE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PolicySourceArn").getter(getter(GetContextKeysForPrincipalPolicyRequest::policySourceArn))
.setter(setter(Builder::policySourceArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PolicySourceArn").build()).build();
private static final SdkField> POLICY_INPUT_LIST_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("PolicyInputList")
.getter(getter(GetContextKeysForPrincipalPolicyRequest::policyInputList))
.setter(setter(Builder::policyInputList))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PolicyInputList").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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(POLICY_SOURCE_ARN_FIELD,
POLICY_INPUT_LIST_FIELD));
private final String policySourceArn;
private final List policyInputList;
private GetContextKeysForPrincipalPolicyRequest(BuilderImpl builder) {
super(builder);
this.policySourceArn = builder.policySourceArn;
this.policyInputList = builder.policyInputList;
}
/**
*
* The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a
* user, the list includes context keys that are found in all policies that are attached to the user. The list also
* includes all groups that the user is a member of. If you pick a group or a role, then it includes only those
* context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded
* form here for clarity, but must be URL encoded to be included as a part of a real HTML request.
*
*
* For more information about ARNs, see Amazon Resource Names
* (ARNs) in the Amazon Web Services General Reference.
*
*
* @return The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you
* specify a user, the list includes context keys that are found in all policies that are attached to the
* user. The list also includes all groups that the user is a member of. If you pick a group or a role, then
* it includes only those context keys that are found in policies attached to that entity. Note that all
* parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part
* of a real HTML request.
*
* For more information about ARNs, see Amazon Resource Names
* (ARNs) in the Amazon Web Services General Reference.
*/
public final String policySourceArn() {
return policySourceArn;
}
/**
* For responses, this returns true if the service returned a value for the PolicyInputList 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 hasPolicyInputList() {
return policyInputList != null && !(policyInputList instanceof SdkAutoConstructList);
}
/**
*
* An optional list of additional policies for which you want the list of context keys that are referenced.
*
*
* The regex pattern used to validate this parameter is a string of
* characters consisting of the following:
*
*
* -
*
* Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII
* character range
*
*
* -
*
* The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
*
*
* -
*
* The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D
* )
*
*
*
*
* 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 #hasPolicyInputList} method.
*
*
* @return An optional list of additional policies for which you want the list of context keys that are
* referenced.
*
* The regex pattern used to validate this parameter is a
* string of characters consisting of the following:
*
*
* -
*
* Any printable ASCII character ranging from the space character (\u0020) through the end of
* the ASCII character range
*
*
* -
*
* The printable characters in the Basic Latin and Latin-1 Supplement character set (through
* \u00FF)
*
*
* -
*
* The special characters tab (\u0009), line feed (\u000A), and carriage return (
* \u000D)
*
*
*/
public final List policyInputList() {
return policyInputList;
}
@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(policySourceArn());
hashCode = 31 * hashCode + Objects.hashCode(hasPolicyInputList() ? policyInputList() : null);
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 GetContextKeysForPrincipalPolicyRequest)) {
return false;
}
GetContextKeysForPrincipalPolicyRequest other = (GetContextKeysForPrincipalPolicyRequest) obj;
return Objects.equals(policySourceArn(), other.policySourceArn()) && hasPolicyInputList() == other.hasPolicyInputList()
&& Objects.equals(policyInputList(), other.policyInputList());
}
/**
* 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("GetContextKeysForPrincipalPolicyRequest").add("PolicySourceArn", policySourceArn())
.add("PolicyInputList", hasPolicyInputList() ? policyInputList() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "PolicySourceArn":
return Optional.ofNullable(clazz.cast(policySourceArn()));
case "PolicyInputList":
return Optional.ofNullable(clazz.cast(policyInputList()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetContextKeysForPrincipalPolicyRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IamRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you
* specify a user, the list includes context keys that are found in all policies that are attached to the user.
* The list also includes all groups that the user is a member of. If you pick a group or a role, then it
* includes only those context keys that are found in policies attached to that entity. Note that all parameters
* are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML
* request.
*
*
* For more information about ARNs, see Amazon Resource Names
* (ARNs) in the Amazon Web Services General Reference.
*
*
* @param policySourceArn
* The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you
* specify a user, the list includes context keys that are found in all policies that are attached to the
* user. The list also includes all groups that the user is a member of. If you pick a group or a role,
* then it includes only those context keys that are found in policies attached to that entity. Note that
* all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as
* a part of a real HTML request.
*
* For more information about ARNs, see Amazon Resource
* Names (ARNs) in the Amazon Web Services General Reference.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder policySourceArn(String policySourceArn);
/**
*
* An optional list of additional policies for which you want the list of context keys that are referenced.
*
*
* The regex pattern used to validate this parameter is a string
* of characters consisting of the following:
*
*
* -
*
* Any printable ASCII character ranging from the space character (\u0020) through the end of the
* ASCII character range
*
*
* -
*
* The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF
* )
*
*
* -
*
* The special characters tab (\u0009), line feed (\u000A), and carriage return (
* \u000D)
*
*
*
*
* @param policyInputList
* An optional list of additional policies for which you want the list of context keys that are
* referenced.
*
* The regex pattern used to validate this parameter is a
* string of characters consisting of the following:
*
*
* -
*
* Any printable ASCII character ranging from the space character (\u0020) through the end
* of the ASCII character range
*
*
* -
*
* The printable characters in the Basic Latin and Latin-1 Supplement character set (through
* \u00FF)
*
*
* -
*
* The special characters tab (\u0009), line feed (\u000A), and carriage return
* (\u000D)
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder policyInputList(Collection policyInputList);
/**
*
* An optional list of additional policies for which you want the list of context keys that are referenced.
*
*
* The regex pattern used to validate this parameter is a string
* of characters consisting of the following:
*
*
* -
*
* Any printable ASCII character ranging from the space character (\u0020) through the end of the
* ASCII character range
*
*
* -
*
* The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF
* )
*
*
* -
*
* The special characters tab (\u0009), line feed (\u000A), and carriage return (
* \u000D)
*
*
*
*
* @param policyInputList
* An optional list of additional policies for which you want the list of context keys that are
* referenced.
*
* The regex pattern used to validate this parameter is a
* string of characters consisting of the following:
*
*
* -
*
* Any printable ASCII character ranging from the space character (\u0020) through the end
* of the ASCII character range
*
*
* -
*
* The printable characters in the Basic Latin and Latin-1 Supplement character set (through
* \u00FF)
*
*
* -
*
* The special characters tab (\u0009), line feed (\u000A), and carriage return
* (\u000D)
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder policyInputList(String... policyInputList);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends IamRequest.BuilderImpl implements Builder {
private String policySourceArn;
private List policyInputList = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(GetContextKeysForPrincipalPolicyRequest model) {
super(model);
policySourceArn(model.policySourceArn);
policyInputList(model.policyInputList);
}
public final String getPolicySourceArn() {
return policySourceArn;
}
public final void setPolicySourceArn(String policySourceArn) {
this.policySourceArn = policySourceArn;
}
@Override
public final Builder policySourceArn(String policySourceArn) {
this.policySourceArn = policySourceArn;
return this;
}
public final Collection getPolicyInputList() {
if (policyInputList instanceof SdkAutoConstructList) {
return null;
}
return policyInputList;
}
public final void setPolicyInputList(Collection policyInputList) {
this.policyInputList = SimulationPolicyListTypeCopier.copy(policyInputList);
}
@Override
public final Builder policyInputList(Collection policyInputList) {
this.policyInputList = SimulationPolicyListTypeCopier.copy(policyInputList);
return this;
}
@Override
@SafeVarargs
public final Builder policyInputList(String... policyInputList) {
policyInputList(Arrays.asList(policyInputList));
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 GetContextKeysForPrincipalPolicyRequest build() {
return new GetContextKeysForPrincipalPolicyRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}