com.amazonaws.services.bedrockagent.model

Class UpdatePromptRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.bedrockagent.model.UpdatePromptRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdatePromptRequest()

Method Summary

Modifier and Type	Method and Description
UpdatePromptRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCustomerEncryptionKeyArn() The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
String	getDefaultVariant() The name of the default variant for the prompt.
String	getDescription() A description for the prompt.
String	getName() A name for the prompt.
String	getPromptIdentifier() The unique identifier of the prompt.
List<PromptVariant>	getVariants() A list of objects, each containing details about a variant of the prompt.
int	hashCode()
void	setCustomerEncryptionKeyArn(String customerEncryptionKeyArn) The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
void	setDefaultVariant(String defaultVariant) The name of the default variant for the prompt.
void	setDescription(String description) A description for the prompt.
void	setName(String name) A name for the prompt.
void	setPromptIdentifier(String promptIdentifier) The unique identifier of the prompt.
void	setVariants(Collection<PromptVariant> variants) A list of objects, each containing details about a variant of the prompt.
String	toString() Returns a string representation of this object.
UpdatePromptRequest	withCustomerEncryptionKeyArn(String customerEncryptionKeyArn) The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
UpdatePromptRequest	withDefaultVariant(String defaultVariant) The name of the default variant for the prompt.
UpdatePromptRequest	withDescription(String description) A description for the prompt.
UpdatePromptRequest	withName(String name) A name for the prompt.
UpdatePromptRequest	withPromptIdentifier(String promptIdentifier) The unique identifier of the prompt.
UpdatePromptRequest	withVariants(Collection<PromptVariant> variants) A list of objects, each containing details about a variant of the prompt.
UpdatePromptRequest	withVariants(PromptVariant... variants) A list of objects, each containing details about a variant of the prompt.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdatePromptRequest

public UpdatePromptRequest()

Method Detail

setCustomerEncryptionKeyArn

public void setCustomerEncryptionKeyArn(String customerEncryptionKeyArn)

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

Parameters:

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

getCustomerEncryptionKeyArn

public String getCustomerEncryptionKeyArn()

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.

withCustomerEncryptionKeyArn

public UpdatePromptRequest withCustomerEncryptionKeyArn(String customerEncryptionKeyArn)

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

Parameters:

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

Returns:

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

setDefaultVariant

public void setDefaultVariant(String defaultVariant)

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

Parameters:

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

getDefaultVariant

public String getDefaultVariant()

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.

withDefaultVariant

public UpdatePromptRequest withDefaultVariant(String defaultVariant)

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

Parameters:

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

Returns:

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

setDescription

public void setDescription(String description)

A description for the prompt.

Parameters:

description - A description for the prompt.

getDescription

public String getDescription()

A description for the prompt.

Returns:

A description for the prompt.

withDescription

public UpdatePromptRequest withDescription(String description)

A description for the prompt.

Parameters:

description - A description for the prompt.

Returns:

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

setName

public void setName(String name)

A name for the prompt.

Parameters:

name - A name for the prompt.

getName

public String getName()

A name for the prompt.

Returns:

A name for the prompt.

withName

public UpdatePromptRequest withName(String name)

A name for the prompt.

Parameters:

name - A name for the prompt.

Returns:

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

setPromptIdentifier

public void setPromptIdentifier(String promptIdentifier)

The unique identifier of the prompt.

Parameters:

promptIdentifier - The unique identifier of the prompt.

getPromptIdentifier

public String getPromptIdentifier()

The unique identifier of the prompt.

Returns:

The unique identifier of the prompt.

withPromptIdentifier

public UpdatePromptRequest withPromptIdentifier(String promptIdentifier)

The unique identifier of the prompt.

Parameters:

promptIdentifier - The unique identifier of the prompt.

Returns:

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

getVariants

public List<PromptVariant> getVariants()

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

Returns:

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

setVariants

public void setVariants(Collection<PromptVariant> variants)

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

Parameters:

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

withVariants

public UpdatePromptRequest withVariants(PromptVariant... variants)

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

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

Parameters:

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

Returns:

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

withVariants

public UpdatePromptRequest withVariants(Collection<PromptVariant> variants)

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

Parameters:

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

Returns:

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

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 UpdatePromptRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()