Class InvokeGlobalInferenceGatewayWithResponseStreamRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<InvokeGlobalInferenceGatewayWithResponseStreamRequest.Builder,InvokeGlobalInferenceGatewayWithResponseStreamRequest>

@Generated("software.amazon.awssdk:codegen") public final class InvokeGlobalInferenceGatewayWithResponseStreamRequest extends SageMakerGatewayRuntimeRequest implements ToCopyableBuilder<InvokeGlobalInferenceGatewayWithResponseStreamRequest.Builder,InvokeGlobalInferenceGatewayWithResponseStreamRequest>

The request for InvokeGlobalInferenceGatewayWithResponseStream. It has the same members as the InvokeGlobalInferenceGateway request.

  • Method Details

    • gatewayId

      public final String gatewayId()

      The ID of the Global Inference Gateway to invoke, as for InvokeGlobalInferenceGateway.

      Returns:
      The ID of the Global Inference Gateway to invoke, as for InvokeGlobalInferenceGateway.
    • accept

      public final String 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

      public final String contentType()

      The MIME type of the request body, as for InvokeGlobalInferenceGateway. Pass application/json.

      Returns:
      The MIME type of the request body, as for InvokeGlobalInferenceGateway. Pass application/json.
    • customerIdentityToken

      public final String customerIdentityToken()

      The customer identity token (a JWT), as for InvokeGlobalInferenceGateway. It is passed unchanged to the inference gateway, which validates it.

      Returns:
      The customer identity token (a JWT), as for InvokeGlobalInferenceGateway. It is passed unchanged to the inference gateway, which validates it.
    • body

      public final SdkBytes body()

      The inference request body, as for InvokeGlobalInferenceGateway, except that the request is always sent with "stream": true: this operation returns an event stream, so a "stream": false in the body (or no stream key) is overridden. A body larger than 10 MiB is rejected with PayloadTooLargeException (413).

      Returns:
      The inference request body, as for InvokeGlobalInferenceGateway, except that the request is always sent with "stream": true: this operation returns an event stream, so a "stream": false in the body (or no stream key) is overridden. A body larger than 10 MiB is rejected with PayloadTooLargeException (413).
    • 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<InvokeGlobalInferenceGatewayWithResponseStreamRequest.Builder,InvokeGlobalInferenceGatewayWithResponseStreamRequest>
      Specified by:
      toBuilder in class SageMakerGatewayRuntimeRequest
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

      public static Class<? extends InvokeGlobalInferenceGatewayWithResponseStreamRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.