com.amazonaws.services.sagemakerruntime.model

Class InvokeEndpointAsyncRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sagemakerruntime.model.InvokeEndpointAsyncRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class InvokeEndpointAsyncRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
InvokeEndpointAsyncRequest()

Method Summary

Modifier and Type	Method and Description
InvokeEndpointAsyncRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAccept() The desired MIME type of the inference response from the model container.
String	getContentType() The MIME type of the input data in the request body.
String	getCustomAttributes() Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker endpoint.
String	getEndpointName() The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
String	getInferenceId() The identifier for the inference request.
String	getInputLocation() The Amazon S3 URI where the inference request payload is stored.
Integer	getInvocationTimeoutSeconds() Maximum amount of time in seconds a request can be processed before it is marked as expired.
Integer	getRequestTTLSeconds() Maximum age in seconds a request can be in the queue before it is marked as expired.
int	hashCode()
void	setAccept(String accept) The desired MIME type of the inference response from the model container.
void	setContentType(String contentType) The MIME type of the input data in the request body.
void	setCustomAttributes(String customAttributes) Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker endpoint.
void	setEndpointName(String endpointName) The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
void	setInferenceId(String inferenceId) The identifier for the inference request.
void	setInputLocation(String inputLocation) The Amazon S3 URI where the inference request payload is stored.
void	setInvocationTimeoutSeconds(Integer invocationTimeoutSeconds) Maximum amount of time in seconds a request can be processed before it is marked as expired.
void	setRequestTTLSeconds(Integer requestTTLSeconds) Maximum age in seconds a request can be in the queue before it is marked as expired.
String	toString() Returns a string representation of this object.
InvokeEndpointAsyncRequest	withAccept(String accept) The desired MIME type of the inference response from the model container.
InvokeEndpointAsyncRequest	withContentType(String contentType) The MIME type of the input data in the request body.
InvokeEndpointAsyncRequest	withCustomAttributes(String customAttributes) Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker endpoint.
InvokeEndpointAsyncRequest	withEndpointName(String endpointName) The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
InvokeEndpointAsyncRequest	withInferenceId(String inferenceId) The identifier for the inference request.
InvokeEndpointAsyncRequest	withInputLocation(String inputLocation) The Amazon S3 URI where the inference request payload is stored.
InvokeEndpointAsyncRequest	withInvocationTimeoutSeconds(Integer invocationTimeoutSeconds) Maximum amount of time in seconds a request can be processed before it is marked as expired.
InvokeEndpointAsyncRequest	withRequestTTLSeconds(Integer requestTTLSeconds) Maximum age in seconds a request can be in the queue before it is marked as expired.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InvokeEndpointAsyncRequest

public InvokeEndpointAsyncRequest()

Method Detail

setEndpointName

public void setEndpointName(String endpointName)

The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.

Parameters:

endpointName - The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.

getEndpointName

public String getEndpointName()

The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.

Returns:

The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.

withEndpointName

public InvokeEndpointAsyncRequest withEndpointName(String endpointName)

The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.

Parameters:

endpointName - The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.

Returns:

Returns a reference to this object so that method calls can be chained together.

setContentType

public void setContentType(String contentType)

The MIME type of the input data in the request body.

Parameters:

contentType - The MIME type of the input data in the request body.

getContentType

public String getContentType()

The MIME type of the input data in the request body.

Returns:

The MIME type of the input data in the request body.

withContentType

public InvokeEndpointAsyncRequest withContentType(String contentType)

The MIME type of the input data in the request body.

Parameters:

contentType - The MIME type of the input data in the request body.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAccept

public void setAccept(String accept)

The desired MIME type of the inference response from the model container.

Parameters:

accept - The desired MIME type of the inference response from the model container.

getAccept

public String getAccept()

The desired MIME type of the inference response from the model container.

Returns:

The desired MIME type of the inference response from the model container.

withAccept

public InvokeEndpointAsyncRequest withAccept(String accept)

The desired MIME type of the inference response from the model container.

Parameters:

accept - The desired MIME type of the inference response from the model container.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCustomAttributes

public void setCustomAttributes(String 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 Amazon Web Services SDKs but not in the Amazon SageMaker Python SDK.

Parameters:

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

getCustomAttributes

public String getCustomAttributes()

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

Returns:

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

withCustomAttributes

public InvokeEndpointAsyncRequest withCustomAttributes(String 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 Amazon Web Services SDKs but not in the Amazon SageMaker Python SDK.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setInferenceId

public void setInferenceId(String inferenceId)

The identifier for the inference request. Amazon SageMaker will generate an identifier for you if none is specified.

Parameters:

inferenceId - The identifier for the inference request. Amazon SageMaker will generate an identifier for you if none is specified.

getInferenceId

public String getInferenceId()

The identifier for the inference request. Amazon SageMaker will generate an identifier for you if none is specified.

Returns:

The identifier for the inference request. Amazon SageMaker will generate an identifier for you if none is specified.

withInferenceId

public InvokeEndpointAsyncRequest withInferenceId(String inferenceId)

The identifier for the inference request. Amazon SageMaker will generate an identifier for you if none is specified.

Parameters:

inferenceId - The identifier for the inference request. Amazon SageMaker will generate an identifier for you if none is specified.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInputLocation

public void setInputLocation(String inputLocation)

The Amazon S3 URI where the inference request payload is stored.

Parameters:

inputLocation - The Amazon S3 URI where the inference request payload is stored.

getInputLocation

public String getInputLocation()

The Amazon S3 URI where the inference request payload is stored.

Returns:

The Amazon S3 URI where the inference request payload is stored.

withInputLocation

public InvokeEndpointAsyncRequest withInputLocation(String inputLocation)

The Amazon S3 URI where the inference request payload is stored.

Parameters:

inputLocation - The Amazon S3 URI where the inference request payload is stored.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRequestTTLSeconds

public void setRequestTTLSeconds(Integer requestTTLSeconds)

Maximum age in seconds a request can be in the queue before it is marked as expired. The default is 6 hours, or 21,600 seconds.

Parameters:

requestTTLSeconds - Maximum age in seconds a request can be in the queue before it is marked as expired. The default is 6 hours, or 21,600 seconds.

getRequestTTLSeconds

public Integer getRequestTTLSeconds()

Maximum age in seconds a request can be in the queue before it is marked as expired. The default is 6 hours, or 21,600 seconds.

Returns:

Maximum age in seconds a request can be in the queue before it is marked as expired. The default is 6 hours, or 21,600 seconds.

withRequestTTLSeconds

public InvokeEndpointAsyncRequest withRequestTTLSeconds(Integer requestTTLSeconds)

Maximum age in seconds a request can be in the queue before it is marked as expired. The default is 6 hours, or 21,600 seconds.

Parameters:

requestTTLSeconds - Maximum age in seconds a request can be in the queue before it is marked as expired. The default is 6 hours, or 21,600 seconds.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInvocationTimeoutSeconds

public void setInvocationTimeoutSeconds(Integer invocationTimeoutSeconds)

Maximum amount of time in seconds a request can be processed before it is marked as expired. The default is 15 minutes, or 900 seconds.

Parameters:

invocationTimeoutSeconds - Maximum amount of time in seconds a request can be processed before it is marked as expired. The default is 15 minutes, or 900 seconds.

getInvocationTimeoutSeconds

public Integer getInvocationTimeoutSeconds()

Maximum amount of time in seconds a request can be processed before it is marked as expired. The default is 15 minutes, or 900 seconds.

Returns:

Maximum amount of time in seconds a request can be processed before it is marked as expired. The default is 15 minutes, or 900 seconds.

withInvocationTimeoutSeconds

public InvokeEndpointAsyncRequest withInvocationTimeoutSeconds(Integer invocationTimeoutSeconds)

Maximum amount of time in seconds a request can be processed before it is marked as expired. The default is 15 minutes, or 900 seconds.

Parameters:

invocationTimeoutSeconds - Maximum amount of time in seconds a request can be processed before it is marked as expired. The default is 15 minutes, or 900 seconds.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public InvokeEndpointAsyncRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()