com.amazonaws.services.bedrock.model

Class GuardrailTopic

java.lang.Object

com.amazonaws.services.bedrock.model.GuardrailTopic

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GuardrailTopic
extends Object
implements Serializable, Cloneable, StructuredPojo

Details about topics for the guardrail to identify and deny.

This data type is used in the following API operations:

• GetGuardrail response body

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GuardrailTopic()

Method Summary

Modifier and Type	Method and Description
GuardrailTopic	clone()
boolean	equals(Object obj)
String	getDefinition() A definition of the topic to deny.
List<String>	getExamples() A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
String	getName() The name of the topic to deny.
String	getType() Specifies to deny the topic.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setDefinition(String definition) A definition of the topic to deny.
void	setExamples(Collection<String> examples) A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
void	setName(String name) The name of the topic to deny.
void	setType(String type) Specifies to deny the topic.
String	toString() Returns a string representation of this object.
GuardrailTopic	withDefinition(String definition) A definition of the topic to deny.
GuardrailTopic	withExamples(Collection<String> examples) A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
GuardrailTopic	withExamples(String... examples) A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
GuardrailTopic	withName(String name) The name of the topic to deny.
GuardrailTopic	withType(GuardrailTopicType type) Specifies to deny the topic.
GuardrailTopic	withType(String type) Specifies to deny the topic.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GuardrailTopic

public GuardrailTopic()

Method Detail

setName

public void setName(String name)

The name of the topic to deny.

Parameters:

name - The name of the topic to deny.

getName

public String getName()

The name of the topic to deny.

Returns:

The name of the topic to deny.

withName

public GuardrailTopic withName(String name)

The name of the topic to deny.

Parameters:

name - The name of the topic to deny.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDefinition

public void setDefinition(String definition)

A definition of the topic to deny.

Parameters:

definition - A definition of the topic to deny.

getDefinition

public String getDefinition()

A definition of the topic to deny.

Returns:

A definition of the topic to deny.

withDefinition

public GuardrailTopic withDefinition(String definition)

A definition of the topic to deny.

Parameters:

definition - A definition of the topic to deny.

Returns:

Returns a reference to this object so that method calls can be chained together.

getExamples

public List<String> getExamples()

A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

Returns:

A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

setExamples

public void setExamples(Collection<String> examples)

A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

Parameters:

examples - A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

withExamples

public GuardrailTopic withExamples(String... examples)

A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

NOTE: This method appends the values to the existing list (if any). Use setExamples(java.util.Collection) or withExamples(java.util.Collection) if you want to override the existing values.

Parameters:

examples - A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

Returns:

Returns a reference to this object so that method calls can be chained together.

withExamples

public GuardrailTopic withExamples(Collection<String> examples)

A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

Parameters:

examples - A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

Returns:

Returns a reference to this object so that method calls can be chained together.

setType

public void setType(String type)

Specifies to deny the topic.

Parameters:

type - Specifies to deny the topic.

See Also:

GuardrailTopicType

getType

public String getType()

Specifies to deny the topic.

Returns:

Specifies to deny the topic.

See Also:

GuardrailTopicType

withType

public GuardrailTopic withType(String type)

Specifies to deny the topic.

Parameters:

type - Specifies to deny the topic.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GuardrailTopicType

withType

public GuardrailTopic withType(GuardrailTopicType type)

Specifies to deny the topic.

Parameters:

type - Specifies to deny the topic.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GuardrailTopicType

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GuardrailTopic clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo