software.amazon.awssdk.services.iam.model.ContextEntry Maven / Gradle / Ivy
Show all versions of iam Show documentation
/*
* Copyright 2014-2019 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.io.Serializable;
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.Function;
import software.amazon.awssdk.annotations.Generated;
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.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains information about a condition context key. It includes the name of the key and specifies the value (or
* values, if the context key supports multiple values) to use in the simulation. This information is used when
* evaluating the Condition elements of the input policies.
*
*
* This data type is used as an input parameter to SimulateCustomPolicy and
* SimulateCustomPolicy .
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ContextEntry implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField CONTEXT_KEY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(ContextEntry::contextKeyName)).setter(setter(Builder::contextKeyName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ContextKeyName").build()).build();
private static final SdkField> CONTEXT_KEY_VALUES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(ContextEntry::contextKeyValues))
.setter(setter(Builder::contextKeyValues))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ContextKeyValues").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 CONTEXT_KEY_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(ContextEntry::contextKeyTypeAsString)).setter(setter(Builder::contextKeyType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ContextKeyType").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CONTEXT_KEY_NAME_FIELD,
CONTEXT_KEY_VALUES_FIELD, CONTEXT_KEY_TYPE_FIELD));
private static final long serialVersionUID = 1L;
private final String contextKeyName;
private final List contextKeyValues;
private final String contextKeyType;
private ContextEntry(BuilderImpl builder) {
this.contextKeyName = builder.contextKeyName;
this.contextKeyValues = builder.contextKeyValues;
this.contextKeyType = builder.contextKeyType;
}
/**
*
* The full name of a condition context key, including the service prefix. For example, aws:SourceIp or
* s3:VersionId.
*
*
* @return The full name of a condition context key, including the service prefix. For example,
* aws:SourceIp or s3:VersionId.
*/
public String contextKeyName() {
return contextKeyName;
}
/**
*
* The value (or values, if the condition context key supports multiple values) to provide to the simulation when
* the key is referenced by a Condition element in an input policy.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return The value (or values, if the condition context key supports multiple values) to provide to the simulation
* when the key is referenced by a Condition element in an input policy.
*/
public List contextKeyValues() {
return contextKeyValues;
}
/**
*
* The data type of the value (or values) specified in the ContextKeyValues parameter.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #contextKeyType}
* will return {@link ContextKeyTypeEnum#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #contextKeyTypeAsString}.
*
*
* @return The data type of the value (or values) specified in the ContextKeyValues parameter.
* @see ContextKeyTypeEnum
*/
public ContextKeyTypeEnum contextKeyType() {
return ContextKeyTypeEnum.fromValue(contextKeyType);
}
/**
*
* The data type of the value (or values) specified in the ContextKeyValues parameter.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #contextKeyType}
* will return {@link ContextKeyTypeEnum#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #contextKeyTypeAsString}.
*
*
* @return The data type of the value (or values) specified in the ContextKeyValues parameter.
* @see ContextKeyTypeEnum
*/
public String contextKeyTypeAsString() {
return contextKeyType;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(contextKeyName());
hashCode = 31 * hashCode + Objects.hashCode(contextKeyValues());
hashCode = 31 * hashCode + Objects.hashCode(contextKeyTypeAsString());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ContextEntry)) {
return false;
}
ContextEntry other = (ContextEntry) obj;
return Objects.equals(contextKeyName(), other.contextKeyName())
&& Objects.equals(contextKeyValues(), other.contextKeyValues())
&& Objects.equals(contextKeyTypeAsString(), other.contextKeyTypeAsString());
}
/**
* 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 String toString() {
return ToString.builder("ContextEntry").add("ContextKeyName", contextKeyName())
.add("ContextKeyValues", contextKeyValues()).add("ContextKeyType", contextKeyTypeAsString()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ContextKeyName":
return Optional.ofNullable(clazz.cast(contextKeyName()));
case "ContextKeyValues":
return Optional.ofNullable(clazz.cast(contextKeyValues()));
case "ContextKeyType":
return Optional.ofNullable(clazz.cast(contextKeyTypeAsString()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ContextEntry) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The full name of a condition context key, including the service prefix. For example,
* aws:SourceIp or s3:VersionId.
*
*
* @param contextKeyName
* The full name of a condition context key, including the service prefix. For example,
* aws:SourceIp or s3:VersionId.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder contextKeyName(String contextKeyName);
/**
*
* The value (or values, if the condition context key supports multiple values) to provide to the simulation
* when the key is referenced by a Condition element in an input policy.
*
*
* @param contextKeyValues
* The value (or values, if the condition context key supports multiple values) to provide to the
* simulation when the key is referenced by a Condition element in an input policy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder contextKeyValues(Collection contextKeyValues);
/**
*
* The value (or values, if the condition context key supports multiple values) to provide to the simulation
* when the key is referenced by a Condition element in an input policy.
*
*
* @param contextKeyValues
* The value (or values, if the condition context key supports multiple values) to provide to the
* simulation when the key is referenced by a Condition element in an input policy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder contextKeyValues(String... contextKeyValues);
/**
*
* The data type of the value (or values) specified in the ContextKeyValues parameter.
*
*
* @param contextKeyType
* The data type of the value (or values) specified in the ContextKeyValues parameter.
* @see ContextKeyTypeEnum
* @return Returns a reference to this object so that method calls can be chained together.
* @see ContextKeyTypeEnum
*/
Builder contextKeyType(String contextKeyType);
/**
*
* The data type of the value (or values) specified in the ContextKeyValues parameter.
*
*
* @param contextKeyType
* The data type of the value (or values) specified in the ContextKeyValues parameter.
* @see ContextKeyTypeEnum
* @return Returns a reference to this object so that method calls can be chained together.
* @see ContextKeyTypeEnum
*/
Builder contextKeyType(ContextKeyTypeEnum contextKeyType);
}
static final class BuilderImpl implements Builder {
private String contextKeyName;
private List contextKeyValues = DefaultSdkAutoConstructList.getInstance();
private String contextKeyType;
private BuilderImpl() {
}
private BuilderImpl(ContextEntry model) {
contextKeyName(model.contextKeyName);
contextKeyValues(model.contextKeyValues);
contextKeyType(model.contextKeyType);
}
public final String getContextKeyName() {
return contextKeyName;
}
@Override
public final Builder contextKeyName(String contextKeyName) {
this.contextKeyName = contextKeyName;
return this;
}
public final void setContextKeyName(String contextKeyName) {
this.contextKeyName = contextKeyName;
}
public final Collection getContextKeyValues() {
return contextKeyValues;
}
@Override
public final Builder contextKeyValues(Collection contextKeyValues) {
this.contextKeyValues = ContextKeyValueListTypeCopier.copy(contextKeyValues);
return this;
}
@Override
@SafeVarargs
public final Builder contextKeyValues(String... contextKeyValues) {
contextKeyValues(Arrays.asList(contextKeyValues));
return this;
}
public final void setContextKeyValues(Collection contextKeyValues) {
this.contextKeyValues = ContextKeyValueListTypeCopier.copy(contextKeyValues);
}
public final String getContextKeyTypeAsString() {
return contextKeyType;
}
@Override
public final Builder contextKeyType(String contextKeyType) {
this.contextKeyType = contextKeyType;
return this;
}
@Override
public final Builder contextKeyType(ContextKeyTypeEnum contextKeyType) {
this.contextKeyType(contextKeyType.toString());
return this;
}
public final void setContextKeyType(String contextKeyType) {
this.contextKeyType = contextKeyType;
}
@Override
public ContextEntry build() {
return new ContextEntry(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}