software.amazon.awssdk.services.bedrockruntime.model.GuardrailCustomWord Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of bedrockruntime Show documentation
Show all versions of bedrockruntime Show documentation
The AWS Java SDK for Bedrock Runtime module holds the client classes that are used for
communicating with Bedrock Runtime.
/*
* 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.bedrockruntime.model;
import java.io.Serializable;
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.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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A custom word configured in a guardrail.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class GuardrailCustomWord implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField MATCH_FIELD = SdkField. builder(MarshallingType.STRING).memberName("match")
.getter(getter(GuardrailCustomWord::match)).setter(setter(Builder::match))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("match").build()).build();
private static final SdkField ACTION_FIELD = SdkField. builder(MarshallingType.STRING).memberName("action")
.getter(getter(GuardrailCustomWord::actionAsString)).setter(setter(Builder::action))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("action").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(MATCH_FIELD, ACTION_FIELD));
private static final long serialVersionUID = 1L;
private final String match;
private final String action;
private GuardrailCustomWord(BuilderImpl builder) {
this.match = builder.match;
this.action = builder.action;
}
/**
*
* The match for the custom word.
*
*
* @return The match for the custom word.
*/
public final String match() {
return match;
}
/**
*
* The action for the custom word.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #action} will
* return {@link GuardrailWordPolicyAction#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #actionAsString}.
*
*
* @return The action for the custom word.
* @see GuardrailWordPolicyAction
*/
public final GuardrailWordPolicyAction action() {
return GuardrailWordPolicyAction.fromValue(action);
}
/**
*
* The action for the custom word.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #action} will
* return {@link GuardrailWordPolicyAction#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #actionAsString}.
*
*
* @return The action for the custom word.
* @see GuardrailWordPolicyAction
*/
public final String actionAsString() {
return action;
}
@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(match());
hashCode = 31 * hashCode + Objects.hashCode(actionAsString());
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 GuardrailCustomWord)) {
return false;
}
GuardrailCustomWord other = (GuardrailCustomWord) obj;
return Objects.equals(match(), other.match()) && Objects.equals(actionAsString(), other.actionAsString());
}
/**
* 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("GuardrailCustomWord").add("Match", match()).add("Action", actionAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "match":
return Optional.ofNullable(clazz.cast(match()));
case "action":
return Optional.ofNullable(clazz.cast(actionAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GuardrailCustomWord) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The match for the custom word.
*
*
* @param match
* The match for the custom word.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder match(String match);
/**
*
* The action for the custom word.
*
*
* @param action
* The action for the custom word.
* @see GuardrailWordPolicyAction
* @return Returns a reference to this object so that method calls can be chained together.
* @see GuardrailWordPolicyAction
*/
Builder action(String action);
/**
*
* The action for the custom word.
*
*
* @param action
* The action for the custom word.
* @see GuardrailWordPolicyAction
* @return Returns a reference to this object so that method calls can be chained together.
* @see GuardrailWordPolicyAction
*/
Builder action(GuardrailWordPolicyAction action);
}
static final class BuilderImpl implements Builder {
private String match;
private String action;
private BuilderImpl() {
}
private BuilderImpl(GuardrailCustomWord model) {
match(model.match);
action(model.action);
}
public final String getMatch() {
return match;
}
public final void setMatch(String match) {
this.match = match;
}
@Override
public final Builder match(String match) {
this.match = match;
return this;
}
public final String getAction() {
return action;
}
public final void setAction(String action) {
this.action = action;
}
@Override
public final Builder action(String action) {
this.action = action;
return this;
}
@Override
public final Builder action(GuardrailWordPolicyAction action) {
this.action(action == null ? null : action.toString());
return this;
}
@Override
public GuardrailCustomWord build() {
return new GuardrailCustomWord(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}