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

Class CreatePromptVersionRequest

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.CreatePromptVersionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreatePromptVersionRequest.Builder,CreatePromptVersionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreatePromptVersionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreatePromptVersionRequest.Builder	builder()
String	clientToken()	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
String	description()	A description for the version of the prompt.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	promptIdentifier()	The unique identifier of the prompt that you want to create a version of.
List<SdkField<?>>	sdkFields()
static Class<? extends CreatePromptVersionRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	Any tags that you want to attach to the version of the prompt.
CreatePromptVersionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

clientToken

public final String clientToken()

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

Returns:

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

description

public final String description()

A description for the version of the prompt.

Returns:

A description for the version of the prompt.

promptIdentifier

public final String promptIdentifier()

The unique identifier of the prompt that you want to create a version of.

Returns:

The unique identifier of the prompt that you want to create a version of.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final Map<String,String> tags()

Any tags that you want to attach to the version of the prompt. For more information, see Tagging resources in Amazon Bedrock.

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

Returns:

Any tags that you want to attach to the version of the prompt. For more information, see Tagging resources in Amazon Bedrock.

toBuilder

public CreatePromptVersionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePromptVersionRequest.Builder,CreatePromptVersionRequest>

Specified by:

toBuilder in class BedrockAgentRequest

builder

public static CreatePromptVersionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreatePromptVersionRequest.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