Package software.amazon.awssdk.services.iotsitewise.model

Class InvokeAssistantRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseRequest

software.amazon.awssdk.services.iotsitewise.model.InvokeAssistantRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<InvokeAssistantRequest.Builder,InvokeAssistantRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InvokeAssistantRequest.Builder

Method Summary

Modifier and Type	Method	Description
static InvokeAssistantRequest.Builder	builder()
String	conversationId()	The ID assigned to a conversation.
Boolean	enableTrace()	Specifies if to turn trace on or not.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	message()	A text message sent to the SiteWise Assistant by the user.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends InvokeAssistantRequest.Builder>	serializableBuilderClass()
InvokeAssistantRequest.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

conversationId

public final String conversationId()

The ID assigned to a conversation. IoT SiteWise automatically generates a unique ID for you, and this parameter is never required. However, if you prefer to have your own ID, you must specify it here in UUID format. If you specify your own ID, it must be globally unique.

Returns:

The ID assigned to a conversation. IoT SiteWise automatically generates a unique ID for you, and this parameter is never required. However, if you prefer to have your own ID, you must specify it here in UUID format. If you specify your own ID, it must be globally unique.

message

public final String message()

A text message sent to the SiteWise Assistant by the user.

Returns:

A text message sent to the SiteWise Assistant by the user.

enableTrace

public final Boolean enableTrace()

Specifies if to turn trace on or not. It is used to track the SiteWise Assistant's reasoning, and data access process.

Returns:

Specifies if to turn trace on or not. It is used to track the SiteWise Assistant's reasoning, and data access process.

toBuilder

public InvokeAssistantRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InvokeAssistantRequest.Builder,InvokeAssistantRequest>

Specified by:

toBuilder in class IoTSiteWiseRequest

builder

public static InvokeAssistantRequest.Builder builder()

serializableBuilderClass

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