Class GuardrailTopicConfig
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<GuardrailTopicConfig.Builder,
GuardrailTopicConfig>
Details about topics for the guardrail to identify and deny.
This data type is used in the following API operations:
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic GuardrailTopicConfig.Builder
builder()
final String
A definition of the topic to deny.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.examples()
A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Examples property.final int
hashCode()
final String
name()
The name of the topic to deny.static Class
<? extends GuardrailTopicConfig.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final GuardrailTopicType
type()
Specifies to deny the topic.final String
Specifies to deny the topic.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the topic to deny.
- Returns:
- The name of the topic to deny.
-
definition
A definition of the topic to deny.
- Returns:
- A definition of the topic to deny.
-
hasExamples
public final boolean hasExamples()For responses, this returns true if the service returned a value for the Examples property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
examples
A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
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
hasExamples()
method.- Returns:
- A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
-
type
Specifies to deny the topic.
If the service returns an enum value that is not available in the current SDK version,
type
will returnGuardrailTopicType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Specifies to deny the topic.
- See Also:
-
typeAsString
Specifies to deny the topic.
If the service returns an enum value that is not available in the current SDK version,
type
will returnGuardrailTopicType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Specifies to deny the topic.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GuardrailTopicConfig.Builder,
GuardrailTopicConfig> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-