Package software.amazon.awssdk.services.bedrockruntime.model

Class StartAsyncInvokeRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.bedrockruntime.model.BedrockRuntimeRequest

software.amazon.awssdk.services.bedrockruntime.model.StartAsyncInvokeRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartAsyncInvokeRequest.Builder,StartAsyncInvokeRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartAsyncInvokeRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartAsyncInvokeRequest.Builder	builder()
String	clientRequestToken()	Specify idempotency token to ensure that requests are not duplicated.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	modelId()	The model to invoke.
Document	modelInput()	Input to send to the model.
AsyncInvokeOutputDataConfig	outputDataConfig()	Where to store the output.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StartAsyncInvokeRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	Tags to apply to the invocation.
StartAsyncInvokeRequest.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

clientRequestToken

public final String clientRequestToken()

Specify idempotency token to ensure that requests are not duplicated.

Returns:

Specify idempotency token to ensure that requests are not duplicated.

modelId

public final String modelId()

The model to invoke.

Returns:

The model to invoke.

modelInput

public final Document modelInput()

Input to send to the model.

Returns:

Input to send to the model.

outputDataConfig

public final AsyncInvokeOutputDataConfig outputDataConfig()

Where to store the output.

Returns:

Where to store the output.

hasTags

public final boolean hasTags()

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

tags

public final List<Tag> tags()

Tags to apply to the invocation.

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

Returns:

Tags to apply to the invocation.

toBuilder

public StartAsyncInvokeRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartAsyncInvokeRequest.Builder,StartAsyncInvokeRequest>

Specified by:

toBuilder in class BedrockRuntimeRequest

builder

public static StartAsyncInvokeRequest.Builder builder()

serializableBuilderClass

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