Package software.amazon.awssdk.services.bedrockagent.model

Class UpdatePromptRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.bedrockagent.model.BedrockAgentRequest

software.amazon.awssdk.services.bedrockagent.model.UpdatePromptRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdatePromptRequest.Builder,UpdatePromptRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdatePromptRequest
extends BedrockAgentRequest
implements ToCopyableBuilder<UpdatePromptRequest.Builder,UpdatePromptRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdatePromptRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdatePromptRequest.Builder	builder()
String	customerEncryptionKeyArn()	The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
String	defaultVariant()	The name of the default variant for the prompt.
String	description()	A description for the prompt.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasVariants()	For responses, this returns true if the service returned a value for the Variants property.
String	name()	A name for the prompt.
String	promptIdentifier()	The unique identifier of the prompt.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdatePromptRequest.Builder>	serializableBuilderClass()
UpdatePromptRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<PromptVariant>	variants()	A list of objects, each containing details about a variant of the prompt.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

customerEncryptionKeyArn

public final String customerEncryptionKeyArn()

The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.

Returns:

The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.

defaultVariant

public final String defaultVariant()

The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.

Returns:

The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.

description

public final String description()

A description for the prompt.

Returns:

A description for the prompt.

name

public final String name()

A name for the prompt.

Returns:

A name for the prompt.

promptIdentifier

public final String promptIdentifier()

The unique identifier of the prompt.

Returns:

The unique identifier of the prompt.

hasVariants

public final boolean hasVariants()

For responses, this returns true if the service returned a value for the Variants property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

variants

public final List<PromptVariant> variants()

A list of objects, each containing details about a variant of the prompt.

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 hasVariants() method.

Returns:

A list of objects, each containing details about a variant of the prompt.

toBuilder

public UpdatePromptRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdatePromptRequest.Builder,UpdatePromptRequest>

Specified by:

toBuilder in class BedrockAgentRequest

builder

public static UpdatePromptRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdatePromptRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo