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

Class CreatePromptResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.bedrockagent.model.BedrockAgentResponse

software.amazon.awssdk.services.bedrockagent.model.CreatePromptResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreatePromptResponse.Builder,CreatePromptResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreatePromptResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the prompt.
static CreatePromptResponse.Builder	builder()
Instant	createdAt()	The time at which the prompt was created.
String	customerEncryptionKeyArn()	The Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
String	defaultVariant()	The name of the default variant for your prompt.
String	description()	The description of 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	id()	The unique identifier of the prompt.
String	name()	The name of the prompt.
List<SdkField<?>>	sdkFields()
static Class<? extends CreatePromptResponse.Builder>	serializableBuilderClass()
CreatePromptResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	updatedAt()	The time at which the prompt was last updated.
List<PromptVariant>	variants()	A list of objects, each containing details about a variant of the prompt.
String	version()	The version of the prompt.

Methods inherited from class software.amazon.awssdk.services.bedrockagent.model.BedrockAgentResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

arn

public final String arn()

The Amazon Resource Name (ARN) of the prompt.

Returns:

The Amazon Resource Name (ARN) of the prompt.

createdAt

public final Instant createdAt()

The time at which the prompt was created.

Returns:

The time at which the prompt was created.

customerEncryptionKeyArn

public final String customerEncryptionKeyArn()

The Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.

Returns:

The Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.

defaultVariant

public final String defaultVariant()

The name of the default variant for your prompt.

Returns:

The name of the default variant for your prompt.

description

public final String description()

The description of the prompt.

Returns:

The description of the prompt.

id

public final String id()

The unique identifier of the prompt.

Returns:

The unique identifier of the prompt.

name

public final String name()

The name of the prompt.

Returns:

The name of the prompt.

updatedAt

public final Instant updatedAt()

The time at which the prompt was last updated.

Returns:

The time at which the prompt was last updated.

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.

version

public final String version()

The version of the prompt. When you create a prompt, the version created is the DRAFT version.

Returns:

The version of the prompt. When you create a prompt, the version created is the DRAFT version.

toBuilder

public CreatePromptResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePromptResponse.Builder,CreatePromptResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static CreatePromptResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo