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

Class InvocationOutput

java.lang.Object

software.amazon.awssdk.services.iotsitewise.model.InvocationOutput

All Implemented Interfaces:

Serializable, SdkPojo, ResponseStream, ToCopyableBuilder<InvocationOutput.Builder,InvocationOutput>

Direct Known Subclasses:

DefaultOutput

@Generated("software.amazon.awssdk:codegen")
public class InvocationOutput
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InvocationOutput.Builder,InvocationOutput>, ResponseStream

This contains the SiteWise Assistant's response and the corresponding citation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InvocationOutput.Builder
protected static class	InvocationOutput.BuilderImpl

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.iotsitewise.model.ResponseStream

ResponseStream.EventType

Field Summary

Fields inherited from interface software.amazon.awssdk.services.iotsitewise.model.ResponseStream

UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InvocationOutput(InvocationOutput.BuilderImpl builder)

Method Summary

Modifier and Type	Method	Description
void	accept(InvokeAssistantResponseHandler.Visitor visitor)	Calls the appropriate visit method depending on the subtype of InvocationOutput.
static InvocationOutput.Builder	builder()
List<Citation>	citations()	A list of citations, and related information for the SiteWise Assistant's response.
InvocationOutput	copy(Consumer<? super InvocationOutput.Builder> modifier)
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCitations()	For responses, this returns true if the service returned a value for the Citations property.
int	hashCode()
String	message()	The text message of the SiteWise Assistant's response.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends InvocationOutput.Builder>	serializableBuilderClass()
InvocationOutput.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.services.iotsitewise.model.ResponseStream

sdkEventType

Constructor Detail

InvocationOutput

protected InvocationOutput(InvocationOutput.BuilderImpl builder)

Method Detail

message

public final String message()

The text message of the SiteWise Assistant's response.

Returns:

The text message of the SiteWise Assistant's response.

hasCitations

public final boolean hasCitations()

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

citations

public final List<Citation> citations()

A list of citations, and related information for the SiteWise Assistant's response.

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

Returns:

A list of citations, and related information for the SiteWise Assistant's response.

toBuilder

public InvocationOutput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InvocationOutput.Builder,InvocationOutput>

builder

public static InvocationOutput.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

copy

public final InvocationOutput copy(Consumer<? super InvocationOutput.Builder> modifier)

Specified by:

copy in interface ToCopyableBuilder<InvocationOutput.Builder,InvocationOutput>

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

accept

public void accept(InvokeAssistantResponseHandler.Visitor visitor)

Calls the appropriate visit method depending on the subtype of InvocationOutput.

Specified by:

accept in interface ResponseStream

Parameters:

visitor - Visitor to invoke.