software.amazon.awssdk.services.sagemakerruntime.model.InvokeEndpointRequest Maven / Gradle / Ivy
Show all versions of sagemakerruntime Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.sagemakerruntime.model;
import java.beans.Transient;
import java.nio.ByteBuffer;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkBytes;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.PayloadTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class InvokeEndpointRequest extends SageMakerRuntimeRequest implements
ToCopyableBuilder {
private static final SdkField ENDPOINT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EndpointName").getter(getter(InvokeEndpointRequest::endpointName)).setter(setter(Builder::endpointName))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("EndpointName").build()).build();
private static final SdkField BODY_FIELD = SdkField
. builder(MarshallingType.SDK_BYTES)
.memberName("Body")
.getter(getter(InvokeEndpointRequest::body))
.setter(setter(Builder::body))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Body").build(),
PayloadTrait.create()).build();
private static final SdkField CONTENT_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ContentType").getter(getter(InvokeEndpointRequest::contentType)).setter(setter(Builder::contentType))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Content-Type").build()).build();
private static final SdkField ACCEPT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Accept")
.getter(getter(InvokeEndpointRequest::accept)).setter(setter(Builder::accept))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Accept").build()).build();
private static final SdkField CUSTOM_ATTRIBUTES_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("CustomAttributes")
.getter(getter(InvokeEndpointRequest::customAttributes))
.setter(setter(Builder::customAttributes))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("X-Amzn-SageMaker-Custom-Attributes")
.build()).build();
private static final SdkField TARGET_MODEL_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("TargetModel")
.getter(getter(InvokeEndpointRequest::targetModel))
.setter(setter(Builder::targetModel))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("X-Amzn-SageMaker-Target-Model")
.build()).build();
private static final SdkField TARGET_VARIANT_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("TargetVariant")
.getter(getter(InvokeEndpointRequest::targetVariant))
.setter(setter(Builder::targetVariant))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("X-Amzn-SageMaker-Target-Variant")
.build()).build();
private static final SdkField TARGET_CONTAINER_HOSTNAME_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("TargetContainerHostname")
.getter(getter(InvokeEndpointRequest::targetContainerHostname))
.setter(setter(Builder::targetContainerHostname))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER)
.locationName("X-Amzn-SageMaker-Target-Container-Hostname").build()).build();
private static final SdkField INFERENCE_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("InferenceId")
.getter(getter(InvokeEndpointRequest::inferenceId))
.setter(setter(Builder::inferenceId))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("X-Amzn-SageMaker-Inference-Id")
.build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ENDPOINT_NAME_FIELD,
BODY_FIELD, CONTENT_TYPE_FIELD, ACCEPT_FIELD, CUSTOM_ATTRIBUTES_FIELD, TARGET_MODEL_FIELD, TARGET_VARIANT_FIELD,
TARGET_CONTAINER_HOSTNAME_FIELD, INFERENCE_ID_FIELD));
private final String endpointName;
private final SdkBytes body;
private final String contentType;
private final String accept;
private final String customAttributes;
private final String targetModel;
private final String targetVariant;
private final String targetContainerHostname;
private final String inferenceId;
private InvokeEndpointRequest(BuilderImpl builder) {
super(builder);
this.endpointName = builder.endpointName;
this.body = builder.body;
this.contentType = builder.contentType;
this.accept = builder.accept;
this.customAttributes = builder.customAttributes;
this.targetModel = builder.targetModel;
this.targetVariant = builder.targetVariant;
this.targetContainerHostname = builder.targetContainerHostname;
this.inferenceId = builder.inferenceId;
}
/**
*
* The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
*
*
* @return The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
*/
public final String endpointName() {
return endpointName;
}
/**
*
* Provides input data, in the format specified in the ContentType request header. Amazon SageMaker
* passes all of the data in the body to the model.
*
*
* For information about the format of the request body, see Common Data Formats-Inference.
*
*
* @return Provides input data, in the format specified in the ContentType request header. Amazon
* SageMaker passes all of the data in the body to the model.
*
* For information about the format of the request body, see Common Data
* Formats-Inference.
*/
public final SdkBytes body() {
return body;
}
/**
*
* The MIME type of the input data in the request body.
*
*
* @return The MIME type of the input data in the request body.
*/
public final String contentType() {
return contentType;
}
/**
*
* The desired MIME type of the inference in the response.
*
*
* @return The desired MIME type of the inference in the response.
*/
public final String accept() {
return accept;
}
/**
*
* Provides additional information about a request for an inference submitted to 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 provide an ID that you can use to track a request or to provide other metadata that a service
* endpoint was programmed to process. 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).
*
*
* 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.
*
*
* @return Provides additional information about a request for an inference submitted to 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 provide an ID that you can use to track a request or to provide other metadata
* that a service endpoint was programmed to process. 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).
*
* 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 final String customAttributes() {
return customAttributes;
}
/**
*
* The model to request for inference when invoking a multi-model endpoint.
*
*
* @return The model to request for inference when invoking a multi-model endpoint.
*/
public final String targetModel() {
return targetModel;
}
/**
*
* Specify the production variant to send the inference request to when invoking an endpoint that is running two or
* more variants. Note that this parameter overrides the default behavior for the endpoint, which is to distribute
* the invocation traffic based on the variant weights.
*
*
* For information about how to use variant targeting to perform a/b testing, see Test models in production
*
*
* @return Specify the production variant to send the inference request to when invoking an endpoint that is running
* two or more variants. Note that this parameter overrides the default behavior for the endpoint, which is
* to distribute the invocation traffic based on the variant weights.
*
* For information about how to use variant targeting to perform a/b testing, see Test models in
* production
*/
public final String targetVariant() {
return targetVariant;
}
/**
*
* If the endpoint hosts multiple containers and is configured to use direct invocation, this parameter specifies
* the host name of the container to invoke.
*
*
* @return If the endpoint hosts multiple containers and is configured to use direct invocation, this parameter
* specifies the host name of the container to invoke.
*/
public final String targetContainerHostname() {
return targetContainerHostname;
}
/**
*
* If you provide a value, it is added to the captured data when you enable data capture on the endpoint. For
* information about data capture, see Capture Data.
*
*
* @return If you provide a value, it is added to the captured data when you enable data capture on the endpoint.
* For information about data capture, see Capture Data.
*/
public final String inferenceId() {
return inferenceId;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(endpointName());
hashCode = 31 * hashCode + Objects.hashCode(body());
hashCode = 31 * hashCode + Objects.hashCode(contentType());
hashCode = 31 * hashCode + Objects.hashCode(accept());
hashCode = 31 * hashCode + Objects.hashCode(customAttributes());
hashCode = 31 * hashCode + Objects.hashCode(targetModel());
hashCode = 31 * hashCode + Objects.hashCode(targetVariant());
hashCode = 31 * hashCode + Objects.hashCode(targetContainerHostname());
hashCode = 31 * hashCode + Objects.hashCode(inferenceId());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof InvokeEndpointRequest)) {
return false;
}
InvokeEndpointRequest other = (InvokeEndpointRequest) obj;
return Objects.equals(endpointName(), other.endpointName()) && Objects.equals(body(), other.body())
&& Objects.equals(contentType(), other.contentType()) && Objects.equals(accept(), other.accept())
&& Objects.equals(customAttributes(), other.customAttributes())
&& Objects.equals(targetModel(), other.targetModel()) && Objects.equals(targetVariant(), other.targetVariant())
&& Objects.equals(targetContainerHostname(), other.targetContainerHostname())
&& Objects.equals(inferenceId(), other.inferenceId());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("InvokeEndpointRequest").add("EndpointName", endpointName())
.add("Body", body() == null ? null : "*** Sensitive Data Redacted ***").add("ContentType", contentType())
.add("Accept", accept())
.add("CustomAttributes", customAttributes() == null ? null : "*** Sensitive Data Redacted ***")
.add("TargetModel", targetModel()).add("TargetVariant", targetVariant())
.add("TargetContainerHostname", targetContainerHostname()).add("InferenceId", inferenceId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "EndpointName":
return Optional.ofNullable(clazz.cast(endpointName()));
case "Body":
return Optional.ofNullable(clazz.cast(body()));
case "ContentType":
return Optional.ofNullable(clazz.cast(contentType()));
case "Accept":
return Optional.ofNullable(clazz.cast(accept()));
case "CustomAttributes":
return Optional.ofNullable(clazz.cast(customAttributes()));
case "TargetModel":
return Optional.ofNullable(clazz.cast(targetModel()));
case "TargetVariant":
return Optional.ofNullable(clazz.cast(targetVariant()));
case "TargetContainerHostname":
return Optional.ofNullable(clazz.cast(targetContainerHostname()));
case "InferenceId":
return Optional.ofNullable(clazz.cast(inferenceId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((InvokeEndpointRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerRuntimeRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
*
*
* @param endpointName
* The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder endpointName(String endpointName);
/**
*
* Provides input data, in the format specified in the ContentType request header. Amazon SageMaker
* passes all of the data in the body to the model.
*
*
* For information about the format of the request body, see Common Data Formats-Inference.
*
*
* @param body
* Provides input data, in the format specified in the ContentType request header. Amazon
* SageMaker passes all of the data in the body to the model.
*
* For information about the format of the request body, see Common Data
* Formats-Inference.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder body(SdkBytes body);
/**
*
* The MIME type of the input data in the request body.
*
*
* @param contentType
* The MIME type of the input data in the request body.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder contentType(String contentType);
/**
*
* The desired MIME type of the inference in the response.
*
*
* @param accept
* The desired MIME type of the inference in the response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder accept(String accept);
/**
*
* Provides additional information about a request for an inference submitted to 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 provide an ID that you can use to track a request or to provide other metadata that a service
* endpoint was programmed to process. 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).
*
*
* 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.
*
*
* @param customAttributes
* Provides additional information about a request for an inference submitted to 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 provide an ID that you can use to track a request or to provide other
* metadata that a service endpoint was programmed to process. 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).
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder customAttributes(String customAttributes);
/**
*
* The model to request for inference when invoking a multi-model endpoint.
*
*
* @param targetModel
* The model to request for inference when invoking a multi-model endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetModel(String targetModel);
/**
*
* Specify the production variant to send the inference request to when invoking an endpoint that is running two
* or more variants. Note that this parameter overrides the default behavior for the endpoint, which is to
* distribute the invocation traffic based on the variant weights.
*
*
* For information about how to use variant targeting to perform a/b testing, see Test models in production
*
*
* @param targetVariant
* Specify the production variant to send the inference request to when invoking an endpoint that is
* running two or more variants. Note that this parameter overrides the default behavior for the
* endpoint, which is to distribute the invocation traffic based on the variant weights.
*
* For information about how to use variant targeting to perform a/b testing, see Test models in
* production
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetVariant(String targetVariant);
/**
*
* If the endpoint hosts multiple containers and is configured to use direct invocation, this parameter
* specifies the host name of the container to invoke.
*
*
* @param targetContainerHostname
* If the endpoint hosts multiple containers and is configured to use direct invocation, this parameter
* specifies the host name of the container to invoke.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetContainerHostname(String targetContainerHostname);
/**
*
* If you provide a value, it is added to the captured data when you enable data capture on the endpoint. For
* information about data capture, see Capture Data.
*
*
* @param inferenceId
* If you provide a value, it is added to the captured data when you enable data capture on the endpoint.
* For information about data capture, see Capture
* Data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder inferenceId(String inferenceId);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SageMakerRuntimeRequest.BuilderImpl implements Builder {
private String endpointName;
private SdkBytes body;
private String contentType;
private String accept;
private String customAttributes;
private String targetModel;
private String targetVariant;
private String targetContainerHostname;
private String inferenceId;
private BuilderImpl() {
}
private BuilderImpl(InvokeEndpointRequest model) {
super(model);
endpointName(model.endpointName);
body(model.body);
contentType(model.contentType);
accept(model.accept);
customAttributes(model.customAttributes);
targetModel(model.targetModel);
targetVariant(model.targetVariant);
targetContainerHostname(model.targetContainerHostname);
inferenceId(model.inferenceId);
}
public final String getEndpointName() {
return endpointName;
}
public final void setEndpointName(String endpointName) {
this.endpointName = endpointName;
}
@Override
@Transient
public final Builder endpointName(String endpointName) {
this.endpointName = endpointName;
return this;
}
public final ByteBuffer getBody() {
return body == null ? null : body.asByteBuffer();
}
public final void setBody(ByteBuffer body) {
body(body == null ? null : SdkBytes.fromByteBuffer(body));
}
@Override
@Transient
public final Builder body(SdkBytes body) {
this.body = body;
return this;
}
public final String getContentType() {
return contentType;
}
public final void setContentType(String contentType) {
this.contentType = contentType;
}
@Override
@Transient
public final Builder contentType(String contentType) {
this.contentType = contentType;
return this;
}
public final String getAccept() {
return accept;
}
public final void setAccept(String accept) {
this.accept = accept;
}
@Override
@Transient
public final Builder accept(String accept) {
this.accept = accept;
return this;
}
public final String getCustomAttributes() {
return customAttributes;
}
public final void setCustomAttributes(String customAttributes) {
this.customAttributes = customAttributes;
}
@Override
@Transient
public final Builder customAttributes(String customAttributes) {
this.customAttributes = customAttributes;
return this;
}
public final String getTargetModel() {
return targetModel;
}
public final void setTargetModel(String targetModel) {
this.targetModel = targetModel;
}
@Override
@Transient
public final Builder targetModel(String targetModel) {
this.targetModel = targetModel;
return this;
}
public final String getTargetVariant() {
return targetVariant;
}
public final void setTargetVariant(String targetVariant) {
this.targetVariant = targetVariant;
}
@Override
@Transient
public final Builder targetVariant(String targetVariant) {
this.targetVariant = targetVariant;
return this;
}
public final String getTargetContainerHostname() {
return targetContainerHostname;
}
public final void setTargetContainerHostname(String targetContainerHostname) {
this.targetContainerHostname = targetContainerHostname;
}
@Override
@Transient
public final Builder targetContainerHostname(String targetContainerHostname) {
this.targetContainerHostname = targetContainerHostname;
return this;
}
public final String getInferenceId() {
return inferenceId;
}
public final void setInferenceId(String inferenceId) {
this.inferenceId = inferenceId;
}
@Override
@Transient
public final Builder inferenceId(String inferenceId) {
this.inferenceId = inferenceId;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public InvokeEndpointRequest build() {
return new InvokeEndpointRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}