Package software.amazon.awssdk.services.bedrockagentruntime.model

Class InvocationStepPayload

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.InvocationStepPayload

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InvocationStepPayload.Builder,InvocationStepPayload>

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

Payload content, such as text and images, for the invocation step.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InvocationStepPayload.Builder
static class	InvocationStepPayload.Type

Method Summary

Modifier and Type	Method	Description
static InvocationStepPayload.Builder	builder()
List<BedrockSessionContentBlock>	contentBlocks()	The content for the invocation step.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static InvocationStepPayload	fromContentBlocks(List<BedrockSessionContentBlock> contentBlocks)	Create an instance of this class with contentBlocks() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContentBlocks()	For responses, this returns true if the service returned a value for the ContentBlocks property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends InvocationStepPayload.Builder>	serializableBuilderClass()
InvocationStepPayload.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
InvocationStepPayload.Type	type()	Retrieve an enum value representing which member of this object is populated.

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

hasContentBlocks

public final boolean hasContentBlocks()

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

contentBlocks

public final List<BedrockSessionContentBlock> contentBlocks()

The content for the invocation step.

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

Returns:

The content for the invocation step.

toBuilder

public InvocationStepPayload.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InvocationStepPayload.Builder,InvocationStepPayload>

builder

public static InvocationStepPayload.Builder builder()

serializableBuilderClass

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

fromContentBlocks

public static InvocationStepPayload fromContentBlocks(List<BedrockSessionContentBlock> contentBlocks)

Create an instance of this class with contentBlocks() initialized to the given value.

The content for the invocation step.

Parameters:

contentBlocks - The content for the invocation step.

type

public InvocationStepPayload.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be InvocationStepPayload.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be InvocationStepPayload.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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