software.amazon.awssdk.services.bedrock.model.GuardrailSensitiveInformationPolicyConfig Maven / Gradle / Ivy
Show all versions of bedrock 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.bedrock.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.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
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.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains details about PII entities and regular expressions to configure for the guardrail.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class GuardrailSensitiveInformationPolicyConfig implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> PII_ENTITIES_CONFIG_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("piiEntitiesConfig")
.getter(getter(GuardrailSensitiveInformationPolicyConfig::piiEntitiesConfig))
.setter(setter(Builder::piiEntitiesConfig))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("piiEntitiesConfig").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(GuardrailPiiEntityConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> REGEXES_CONFIG_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("regexesConfig")
.getter(getter(GuardrailSensitiveInformationPolicyConfig::regexesConfig))
.setter(setter(Builder::regexesConfig))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("regexesConfig").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(GuardrailRegexConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PII_ENTITIES_CONFIG_FIELD,
REGEXES_CONFIG_FIELD));
private static final long serialVersionUID = 1L;
private final List piiEntitiesConfig;
private final List regexesConfig;
private GuardrailSensitiveInformationPolicyConfig(BuilderImpl builder) {
this.piiEntitiesConfig = builder.piiEntitiesConfig;
this.regexesConfig = builder.regexesConfig;
}
/**
* For responses, this returns true if the service returned a value for the PiiEntitiesConfig 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 hasPiiEntitiesConfig() {
return piiEntitiesConfig != null && !(piiEntitiesConfig instanceof SdkAutoConstructList);
}
/**
*
* A list of PII entities to configure to the guardrail.
*
*
* 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 #hasPiiEntitiesConfig} method.
*
*
* @return A list of PII entities to configure to the guardrail.
*/
public final List piiEntitiesConfig() {
return piiEntitiesConfig;
}
/**
* For responses, this returns true if the service returned a value for the RegexesConfig 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 hasRegexesConfig() {
return regexesConfig != null && !(regexesConfig instanceof SdkAutoConstructList);
}
/**
*
* A list of regular expressions to configure to the guardrail.
*
*
* 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 #hasRegexesConfig} method.
*
*
* @return A list of regular expressions to configure to the guardrail.
*/
public final List regexesConfig() {
return regexesConfig;
}
@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 + Objects.hashCode(hasPiiEntitiesConfig() ? piiEntitiesConfig() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasRegexesConfig() ? regexesConfig() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof GuardrailSensitiveInformationPolicyConfig)) {
return false;
}
GuardrailSensitiveInformationPolicyConfig other = (GuardrailSensitiveInformationPolicyConfig) obj;
return hasPiiEntitiesConfig() == other.hasPiiEntitiesConfig()
&& Objects.equals(piiEntitiesConfig(), other.piiEntitiesConfig())
&& hasRegexesConfig() == other.hasRegexesConfig() && Objects.equals(regexesConfig(), other.regexesConfig());
}
/**
* 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("GuardrailSensitiveInformationPolicyConfig")
.add("PiiEntitiesConfig", hasPiiEntitiesConfig() ? piiEntitiesConfig() : null)
.add("RegexesConfig", hasRegexesConfig() ? regexesConfig() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "piiEntitiesConfig":
return Optional.ofNullable(clazz.cast(piiEntitiesConfig()));
case "regexesConfig":
return Optional.ofNullable(clazz.cast(regexesConfig()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GuardrailSensitiveInformationPolicyConfig) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A list of PII entities to configure to the guardrail.
*
*
* @param piiEntitiesConfig
* A list of PII entities to configure to the guardrail.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder piiEntitiesConfig(Collection piiEntitiesConfig);
/**
*
* A list of PII entities to configure to the guardrail.
*
*
* @param piiEntitiesConfig
* A list of PII entities to configure to the guardrail.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder piiEntitiesConfig(GuardrailPiiEntityConfig... piiEntitiesConfig);
/**
*
* A list of PII entities to configure to the guardrail.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.bedrock.model.GuardrailPiiEntityConfig.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.bedrock.model.GuardrailPiiEntityConfig#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.bedrock.model.GuardrailPiiEntityConfig.Builder#build()} is called
* immediately and its result is passed to {@link #piiEntitiesConfig(List)}.
*
* @param piiEntitiesConfig
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.bedrock.model.GuardrailPiiEntityConfig.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #piiEntitiesConfig(java.util.Collection)
*/
Builder piiEntitiesConfig(Consumer... piiEntitiesConfig);
/**
*
* A list of regular expressions to configure to the guardrail.
*
*
* @param regexesConfig
* A list of regular expressions to configure to the guardrail.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder regexesConfig(Collection regexesConfig);
/**
*
* A list of regular expressions to configure to the guardrail.
*
*
* @param regexesConfig
* A list of regular expressions to configure to the guardrail.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder regexesConfig(GuardrailRegexConfig... regexesConfig);
/**
*
* A list of regular expressions to configure to the guardrail.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.bedrock.model.GuardrailRegexConfig.Builder} avoiding the need to
* create one manually via {@link software.amazon.awssdk.services.bedrock.model.GuardrailRegexConfig#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.bedrock.model.GuardrailRegexConfig.Builder#build()} is called
* immediately and its result is passed to {@link #regexesConfig(List)}.
*
* @param regexesConfig
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.bedrock.model.GuardrailRegexConfig.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #regexesConfig(java.util.Collection)
*/
Builder regexesConfig(Consumer... regexesConfig);
}
static final class BuilderImpl implements Builder {
private List piiEntitiesConfig = DefaultSdkAutoConstructList.getInstance();
private List regexesConfig = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(GuardrailSensitiveInformationPolicyConfig model) {
piiEntitiesConfig(model.piiEntitiesConfig);
regexesConfig(model.regexesConfig);
}
public final List getPiiEntitiesConfig() {
List result = GuardrailPiiEntitiesConfigCopier
.copyToBuilder(this.piiEntitiesConfig);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setPiiEntitiesConfig(Collection piiEntitiesConfig) {
this.piiEntitiesConfig = GuardrailPiiEntitiesConfigCopier.copyFromBuilder(piiEntitiesConfig);
}
@Override
public final Builder piiEntitiesConfig(Collection piiEntitiesConfig) {
this.piiEntitiesConfig = GuardrailPiiEntitiesConfigCopier.copy(piiEntitiesConfig);
return this;
}
@Override
@SafeVarargs
public final Builder piiEntitiesConfig(GuardrailPiiEntityConfig... piiEntitiesConfig) {
piiEntitiesConfig(Arrays.asList(piiEntitiesConfig));
return this;
}
@Override
@SafeVarargs
public final Builder piiEntitiesConfig(Consumer... piiEntitiesConfig) {
piiEntitiesConfig(Stream.of(piiEntitiesConfig).map(c -> GuardrailPiiEntityConfig.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getRegexesConfig() {
List result = GuardrailRegexesConfigCopier.copyToBuilder(this.regexesConfig);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setRegexesConfig(Collection regexesConfig) {
this.regexesConfig = GuardrailRegexesConfigCopier.copyFromBuilder(regexesConfig);
}
@Override
public final Builder regexesConfig(Collection regexesConfig) {
this.regexesConfig = GuardrailRegexesConfigCopier.copy(regexesConfig);
return this;
}
@Override
@SafeVarargs
public final Builder regexesConfig(GuardrailRegexConfig... regexesConfig) {
regexesConfig(Arrays.asList(regexesConfig));
return this;
}
@Override
@SafeVarargs
public final Builder regexesConfig(Consumer... regexesConfig) {
regexesConfig(Stream.of(regexesConfig).map(c -> GuardrailRegexConfig.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public GuardrailSensitiveInformationPolicyConfig build() {
return new GuardrailSensitiveInformationPolicyConfig(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}