@Generated(value="software.amazon.awssdk:codegen") public final class InvokeEndpointResponse extends SageMakerRuntimeResponse implements ToCopyableBuilder<InvokeEndpointResponse.Builder,InvokeEndpointResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
InvokeEndpointResponse.Builder |
Modifier and Type | Method and Description |
---|---|
SdkBytes |
body()
Includes the inference provided by the model.
|
static InvokeEndpointResponse.Builder |
builder() |
String |
contentType()
The MIME type of the inference returned in the response body.
|
String |
customAttributes()
Provides additional information in the response about the inference returned by a model hosted at an Amazon
SageMaker endpoint.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
int |
hashCode() |
String |
invokedProductionVariant()
Identifies the production variant that was invoked.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends InvokeEndpointResponse.Builder> |
serializableBuilderClass() |
InvokeEndpointResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
responseMetadata
sdkHttpResponse
copy
public final SdkBytes body()
Includes the inference provided by the model.
For information about the format of the response body, see Common Data Formats-Inference.
For information about the format of the response body, see Common Data Formats-Inference.
public final String contentType()
The MIME type of the inference returned in the response body.
public final String invokedProductionVariant()
Identifies the production variant that was invoked.
public final String customAttributes()
Provides additional information in the response about the inference returned by a model hosted at an Amazon
SageMaker endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for
example, to return an ID received in the CustomAttributes
header of a request or other metadata that
a service endpoint was programmed to produce. The value must consist of no more than 1024 visible US-ASCII
characters as specified in Section 3.3.6. Field Value
Components of the Hypertext Transfer Protocol (HTTP/1.1). If the customer wants the custom attribute
returned, the model must set the custom attribute to be included on the way back.
The code in your model is responsible for setting or updating any custom attributes in the response. If your code
does not set this value in the response, an empty value is returned. For example, if a custom attribute
represents the trace ID, your model can prepend the custom attribute with Trace ID:
in your
post-processing function.
This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.
CustomAttributes
header of a
request or other metadata that a service endpoint was programmed to produce. The value must consist of no
more than 1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value Components of the
Hypertext Transfer Protocol (HTTP/1.1). If the customer wants the custom attribute returned, the model
must set the custom attribute to be included on the way back.
The code in your model is responsible for setting or updating any custom attributes in the response. If
your code does not set this value in the response, an empty value is returned. For example, if a custom
attribute represents the trace ID, your model can prepend the custom attribute with
Trace ID:
in your post-processing function.
This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.
public InvokeEndpointResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<InvokeEndpointResponse.Builder,InvokeEndpointResponse>
toBuilder
in class AwsResponse
public static InvokeEndpointResponse.Builder builder()
public static Class<? extends InvokeEndpointResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. 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, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.