Class InvokeGlobalInferenceGatewayRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<InvokeGlobalInferenceGatewayRequest.Builder,InvokeGlobalInferenceGatewayRequest>
The request for InvokeGlobalInferenceGateway.
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal Stringaccept()The MIME type you want for the response.final SdkBytesbody()The inference request body: one OpenAI JSON object, at most 10 MiB.builder()final StringThe MIME type of the request body.final StringPer-caller customer identity token (a JWT), forwarded unchanged to the inference gateway, which validates it.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final StringThe ID of the Global Inference Gateway to invoke.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()static Class<? extends InvokeGlobalInferenceGatewayRequest.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
-
gatewayId
The ID of the Global Inference Gateway to invoke. IAM policies refer to the gateway by its ARN,
arn:<partition>:sagemaker:<region>:<account>:global-inference-gateway/<id>.- Returns:
- The ID of the Global Inference Gateway to invoke. IAM policies refer to the gateway by its ARN,
arn:<partition>:sagemaker:<region>:<account>:global-inference-gateway/<id>.
-
accept
The MIME type you want for the response. It is passed to the model server.
- Returns:
- The MIME type you want for the response. It is passed to the model server.
-
contentType
The MIME type of the request body. Pass
application/json(parameters such ascharset=utf-8are allowed): the body is one OpenAI JSON object. The Global Inference Gateway rejects other content types with a 415 error.- Returns:
- The MIME type of the request body. Pass
application/json(parameters such ascharset=utf-8are allowed): the body is one OpenAI JSON object. The Global Inference Gateway rejects other content types with a 415 error.
-
customerIdentityToken
Per-caller customer identity token (a JWT), forwarded unchanged to the inference gateway, which validates it. The gateway does not use it to authorize the request. Include it in the SigV4 signed headers so it cannot be altered in transit. Redacted from logs, metrics and traces.
- Returns:
- Per-caller customer identity token (a JWT), forwarded unchanged to the inference gateway, which validates it. The gateway does not use it to authorize the request. Include it in the SigV4 signed headers so it cannot be altered in transit. Redacted from logs, metrics and traces.
-
body
The inference request body: one OpenAI JSON object, at most 10 MiB. Its content is passed to the model server unchanged, except that the request is always sent with
"stream": false: this operation returns one JSON document, so a"stream": truein the body is overridden (use InvokeGlobalInferenceGatewayWithResponseStream to stream). A body that is not one JSON object, or that repeats the top-levelmodelkey with different values, is rejected with a 400 validation error. A body larger than 10 MiB is rejected with PayloadTooLargeException (413). The gateway reads onlymodelandstream, and does not store the body.- Returns:
- The inference request body: one OpenAI JSON object, at most 10 MiB. Its content is passed to the model
server unchanged, except that the request is always sent with
"stream": false: this operation returns one JSON document, so a"stream": truein the body is overridden (use InvokeGlobalInferenceGatewayWithResponseStream to stream). A body that is not one JSON object, or that repeats the top-levelmodelkey with different values, is rejected with a 400 validation error. A body larger than 10 MiB is rejected with PayloadTooLargeException (413). The gateway reads onlymodelandstream, and does not store the body.
-
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<InvokeGlobalInferenceGatewayRequest.Builder,InvokeGlobalInferenceGatewayRequest> - Specified by:
toBuilderin classSageMakerGatewayRuntimeRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends InvokeGlobalInferenceGatewayRequest.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.
-