Package software.amazon.awssdk.services.sagemakerruntime.model

Class InvokeEndpointWithResponseStreamResponse

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.InvokeEndpointWithResponseStreamResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<InvokeEndpointWithResponseStreamResponse.Builder,InvokeEndpointWithResponseStreamResponse>
@Generated("software.amazon.awssdk:codegen") public final class InvokeEndpointWithResponseStreamResponse extends SageMakerRuntimeResponse implements ToCopyableBuilder<InvokeEndpointWithResponseStreamResponse.Builder,InvokeEndpointWithResponseStreamResponse>

  • Method Details

    • contentType

      public final String contentType()

      The MIME type of the inference returned from the model container.

      Returns:
      The MIME type of the inference returned from the model container.

    • 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 AI 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 Amazon Web Services SDKs but not in the Amazon SageMaker AI Python SDK.

      Returns:
      Provides additional information in the response about the inference returned by a model hosted at an Amazon SageMaker AI 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 Amazon Web Services SDKs but not in the Amazon SageMaker AI Python SDK.

    • toBuilder

      public InvokeEndpointWithResponseStreamResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<InvokeEndpointWithResponseStreamResponse.Builder,InvokeEndpointWithResponseStreamResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static InvokeEndpointWithResponseStreamResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InvokeEndpointWithResponseStreamResponse.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)
      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 SdkResponse

    • 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