Class InvokeInferenceRouterAsyncRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<InvokeInferenceRouterAsyncRequest.Builder,InvokeInferenceRouterAsyncRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal Stringaccept()The MIME type that you want for the inference response.builder()final StringThe MIME type of the input data in Amazon S3.final StringProvides additional information about the inference request.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Stringfilename()The file name of the inference response stored in Amazon S3.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final inthashCode()final StringAn identifier for the inference request.final StringThe name of the inference router to invoke.final StringThe Amazon S3 URI of the object that contains the input data for the inference.final IntegerThe maximum time, in seconds, that a destination can spend processing the request before the request is marked as expired.final IntegerThe time to live of the request, in seconds, measured from when the router accepts it.final StringThe name of the routing target in the inference router.final StringThe path extension that is appended to the routing target's Amazon S3 output path where the inference response is stored.static Class<? extends InvokeInferenceRouterAsyncRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
inferenceRouterName
The name of the inference router to invoke.
- Returns:
- The name of the inference router to invoke.
-
routingTargetName
The name of the routing target in the inference router. The routing target must be configured for asynchronous inference.
- Returns:
- The name of the routing target in the inference router. The routing target must be configured for asynchronous inference.
-
contentType
The MIME type of the input data in Amazon S3. The router passes it to the destination.
- Returns:
- The MIME type of the input data in Amazon S3. The router passes it to the destination.
-
accept
The MIME type that you want for the inference response. The router passes it to the destination.
- Returns:
- The MIME type that you want for the inference response. The router passes it to the destination.
-
customAttributes
Provides additional information about the inference request. The value is an opaque string that the router passes, unchanged, to the model container of the destination that serves the request. The value can contain up to 1,024 visible US-ASCII characters.
- Returns:
- Provides additional information about the inference request. The value is an opaque string that the router passes, unchanged, to the model container of the destination that serves the request. The value can contain up to 1,024 visible US-ASCII characters.
-
inferenceId
An identifier for the inference request. If you don't provide one, SageMaker AI generates one and returns it in the response.
- Returns:
- An identifier for the inference request. If you don't provide one, SageMaker AI generates one and returns it in the response.
-
inputLocation
The Amazon S3 URI of the object that contains the input data for the inference. The bucket must be in the inference router's Amazon Web Services Region and owned by the router's account. The destination endpoint's execution role reads the object, and the destination's asynchronous inference limits apply to it.
- Returns:
- The Amazon S3 URI of the object that contains the input data for the inference. The bucket must be in the inference router's Amazon Web Services Region and owned by the router's account. The destination endpoint's execution role reads the object, and the destination's asynchronous inference limits apply to it.
-
s3OutputPathExtension
The path extension that is appended to the routing target's Amazon S3 output path where the inference response is stored.
- Returns:
- The path extension that is appended to the routing target's Amazon S3 output path where the inference response is stored.
-
filename
The file name of the inference response stored in Amazon S3. If you don't provide one, SageMaker AI generates one.
- Returns:
- The file name of the inference response stored in Amazon S3. If you don't provide one, SageMaker AI generates one.
-
requestTTLSeconds
The time to live of the request, in seconds, measured from when the router accepts it. If no destination starts the request in this time, the request fails. The default is 21,600 seconds (6 hours).
- Returns:
- The time to live of the request, in seconds, measured from when the router accepts it. If no destination starts the request in this time, the request fails. The default is 21,600 seconds (6 hours).
-
invocationTimeoutSeconds
The maximum time, in seconds, that a destination can spend processing the request before the request is marked as expired. The default is 900 seconds (15 minutes).
- Returns:
- The maximum time, in seconds, that a destination can spend processing the request before the request is marked as expired. The default is 900 seconds (15 minutes).
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<InvokeInferenceRouterAsyncRequest.Builder,InvokeInferenceRouterAsyncRequest> - Specified by:
toBuilderin classSageMakerInferenceRouterRuntimeRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- Parameters:
fieldName- The name of the member to be retrieved.clazz- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-