software.amazon.awssdk.services.sagemakerruntime.model

Class InvokeEndpointResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.sagemakerruntime.model.SageMakerRuntimeResponse

software.amazon.awssdk.services.sagemakerruntime.model.InvokeEndpointResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<InvokeEndpointResponse.Builder,InvokeEndpointResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class InvokeEndpointResponse
extends SageMakerRuntimeResponse
implements ToCopyableBuilder<InvokeEndpointResponse.Builder,InvokeEndpointResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InvokeEndpointResponse.Builder

Method Summary

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.

Methods inherited from class software.amazon.awssdk.services.sagemakerruntime.model.SageMakerRuntimeResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

body

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.

Returns:

Includes the inference provided by the model.

For information about the format of the response body, see Common Data Formats-Inference.

contentType

public final String contentType()

The MIME type of the inference returned in the response body.

Returns:

The MIME type of the inference returned in the response body.

invokedProductionVariant

public final String invokedProductionVariant()

Identifies the production variant that was invoked.

Returns:

Identifies the production variant that was invoked.

customAttributes

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.

Returns:

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.

toBuilder

public InvokeEndpointResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<InvokeEndpointResponse.Builder,InvokeEndpointResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static InvokeEndpointResponse.Builder builder()

serializableBuilderClass

public static Class<? extends InvokeEndpointResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkResponse

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

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.