InvokeEndpointRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.sagemakerruntime.model.InvokeEndpointRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class InvokeEndpointRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint.

For an overview of Amazon SageMaker, see How It Works.

Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax.

Cals to InvokeEndpoint are authenticated by using AWS Signature Version 4. For information, see Authenticating Requests (AWS Signature Version 4) in the Amazon S3 API Reference.

Endpoints are scoped to an individual account, and are not public. The URL does not contain the account ID, but Amazon SageMaker determines the account ID from the authentication token that is supplied by the caller.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

InvokeEndpointRequest()

Constructors
Constructor and Description
`InvokeEndpointRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getAccept()` The desired MIME type of the inference in the response.
`java.nio.ByteBuffer`	`getBody()` Provides input data, in the format specified in the `ContentType` request header.
`java.lang.String`	`getContentType()` The MIME type of the input data in the request body.
`java.lang.String`	`getCustomAttributes()`
`java.lang.String`	`getEndpointName()` The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
`int`	`hashCode()`
`void`	`setAccept(java.lang.String accept)` The desired MIME type of the inference in the response.
`void`	`setBody(java.nio.ByteBuffer body)` Provides input data, in the format specified in the `ContentType` request header.
`void`	`setContentType(java.lang.String contentType)` The MIME type of the input data in the request body.
`void`	`setCustomAttributes(java.lang.String customAttributes)`
`void`	`setEndpointName(java.lang.String endpointName)` The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`InvokeEndpointRequest`	`withAccept(java.lang.String accept)` The desired MIME type of the inference in the response.
`InvokeEndpointRequest`	`withBody(java.nio.ByteBuffer body)` Provides input data, in the format specified in the `ContentType` request header.
`InvokeEndpointRequest`	`withContentType(java.lang.String contentType)` The MIME type of the input data in the request body.
`InvokeEndpointRequest`	`withCustomAttributes(java.lang.String customAttributes)`
`InvokeEndpointRequest`	`withEndpointName(java.lang.String endpointName)` The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - InvokeEndpointRequest
```
public InvokeEndpointRequest()
```
- Method Detail
  - getEndpointName
```
public java.lang.String getEndpointName()
```
    The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
    
    Constraints:
    Length: - 63
    Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
    
    Returns:
    
    The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
  - setEndpointName
```
public void setEndpointName(java.lang.String endpointName)
```
    The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
    
    Constraints:
    Length: - 63
    Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
    
    Parameters:
    
    endpointName -
    The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
  - withEndpointName
```
public InvokeEndpointRequest withEndpointName(java.lang.String endpointName)
```
    The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 63
    Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
    
    Parameters:
    
    endpointName -
    The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getBody
```
public java.nio.ByteBuffer getBody()
```
    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.
    
    Constraints:
    Length: - 5242880
    
    Returns:
    
    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.
  - setBody
```
public void setBody(java.nio.ByteBuffer 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.
    
    Constraints:
    Length: - 5242880
    
    Parameters:
    
    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.
  - withBody
```
public InvokeEndpointRequest withBody(java.nio.ByteBuffer 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 5242880
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getContentType
```
public java.lang.String getContentType()
```
    The MIME type of the input data in the request body.
    
    Constraints:
    Length: - 1024
    
    Returns:
    
    The MIME type of the input data in the request body.
  - setContentType
```
public void setContentType(java.lang.String contentType)
```
    The MIME type of the input data in the request body.
    
    Constraints:
    Length: - 1024
    
    Parameters:
    
    contentType -
    The MIME type of the input data in the request body.
  - withContentType
```
public InvokeEndpointRequest withContentType(java.lang.String contentType)
```
    The MIME type of the input data in the request body.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 1024
    
    Parameters:
    
    contentType -
    The MIME type of the input data in the request body.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAccept
```
public java.lang.String getAccept()
```
    The desired MIME type of the inference in the response.
    
    Constraints:
    Length: - 1024
    
    Returns:
    
    The desired MIME type of the inference in the response.
  - setAccept
```
public void setAccept(java.lang.String accept)
```
    The desired MIME type of the inference in the response.
    
    Constraints:
    Length: - 1024
    
    Parameters:
    
    accept -
    The desired MIME type of the inference in the response.
  - withAccept
```
public InvokeEndpointRequest withAccept(java.lang.String accept)
```
    The desired MIME type of the inference in the response.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 1024
    
    Parameters:
    
    accept -
    The desired MIME type of the inference in the response.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getCustomAttributes
```
public java.lang.String getCustomAttributes()
```
    Constraints:
    Length: - 1024
    
    Returns:
  - setCustomAttributes
```
public void setCustomAttributes(java.lang.String customAttributes)
```
    Constraints:
    Length: - 1024
    
    Parameters:
    
    customAttributes -
  - withCustomAttributes
```
public InvokeEndpointRequest withCustomAttributes(java.lang.String customAttributes)
```
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 1024
    
    Parameters:
    
    customAttributes -
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class InvokeEndpointRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

InvokeEndpointRequest

Method Detail

getEndpointName

setEndpointName

withEndpointName

getBody

setBody

withBody

getContentType

setContentType

withContentType

getAccept

setAccept

withAccept

getCustomAttributes

setCustomAttributes

withCustomAttributes

toString

hashCode

equals