Package software.amazon.awssdk.services.qconnect.model

Class UpdateAiPromptRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.qconnect.model.QConnectRequest

software.amazon.awssdk.services.qconnect.model.UpdateAiPromptRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateAiPromptRequest.Builder,UpdateAiPromptRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateAiPromptRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	aiPromptId()	The identifier of the Amazon Q in Connect AI Prompt.
String	assistantId()	The identifier of the Amazon Q in Connect assistant.
static UpdateAiPromptRequest.Builder	builder()
String	clientToken()	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	description()	The description of the Amazon Q in Connect AI Prompt.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateAiPromptRequest.Builder>	serializableBuilderClass()
AIPromptTemplateConfiguration	templateConfiguration()	The configuration of the prompt template for this AI Prompt.
UpdateAiPromptRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
VisibilityStatus	visibilityStatus()	The visibility status of the Amazon Q in Connect AI prompt.
String	visibilityStatusAsString()	The visibility status of the Amazon Q in Connect AI 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

aiPromptId

public final String aiPromptId()

The identifier of the Amazon Q in Connect AI Prompt.

Returns:

The identifier of the Amazon Q in Connect AI Prompt.

assistantId

public final String assistantId()

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

clientToken

public final String clientToken()

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..

Returns:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..

description

public final String description()

The description of the Amazon Q in Connect AI Prompt.

Returns:

The description of the Amazon Q in Connect AI Prompt.

templateConfiguration

public final AIPromptTemplateConfiguration templateConfiguration()

The configuration of the prompt template for this AI Prompt.

Returns:

The configuration of the prompt template for this AI Prompt.

visibilityStatus

public final VisibilityStatus visibilityStatus()

The visibility status of the Amazon Q in Connect AI prompt.

If the service returns an enum value that is not available in the current SDK version, visibilityStatus will return VisibilityStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityStatusAsString().

Returns:

The visibility status of the Amazon Q in Connect AI prompt.

See Also:

VisibilityStatus

visibilityStatusAsString

public final String visibilityStatusAsString()

The visibility status of the Amazon Q in Connect AI prompt.

If the service returns an enum value that is not available in the current SDK version, visibilityStatus will return VisibilityStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityStatusAsString().

Returns:

The visibility status of the Amazon Q in Connect AI prompt.

See Also:

VisibilityStatus

toBuilder

public UpdateAiPromptRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateAiPromptRequest.Builder,UpdateAiPromptRequest>

Specified by:

toBuilder in class QConnectRequest

builder

public static UpdateAiPromptRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo