CreateEndpointRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.comprehend.model

Class CreateEndpointRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.comprehend.model.CreateEndpointRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateEndpointRequest
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

CreateEndpointRequest ()

Constructors
Constructor and Description
`CreateEndpointRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`CreateEndpointRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`String`	`getClientRequestToken ()` An idempotency token provided by the customer.
`String`	`getDataAccessRoleArn ()` The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
`Integer`	`getDesiredInferenceUnits ()` The desired number of inference units to be used by the model using this endpoint.
`String`	`getEndpointName ()` This is the descriptive suffix that becomes part of the `EndpointArn` used for all subsequent requests to this resource.
`String`	`getFlywheelArn ()` The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.
`String`	`getModelArn ()` The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
`List<Tag>`	`getTags ()` Tags to associate with the endpoint.
`int`	`hashCode ()`
`void`	`setClientRequestToken (String clientRequestToken)` An idempotency token provided by the customer.
`void`	`setDataAccessRoleArn (String dataAccessRoleArn)` The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
`void`	`setDesiredInferenceUnits (Integer desiredInferenceUnits)` The desired number of inference units to be used by the model using this endpoint.
`void`	`setEndpointName (String endpointName)` This is the descriptive suffix that becomes part of the `EndpointArn` used for all subsequent requests to this resource.
`void`	`setFlywheelArn (String flywheelArn)` The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.
`void`	`setModelArn (String modelArn)` The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
`void`	`setTags (Collection<Tag> tags)` Tags to associate with the endpoint.
`String`	`toString ()` Returns a string representation of this object.
`CreateEndpointRequest`	`withClientRequestToken (String clientRequestToken)` An idempotency token provided by the customer.
`CreateEndpointRequest`	`withDataAccessRoleArn (String dataAccessRoleArn)` The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
`CreateEndpointRequest`	`withDesiredInferenceUnits (Integer desiredInferenceUnits)` The desired number of inference units to be used by the model using this endpoint.
`CreateEndpointRequest`	`withEndpointName (String endpointName)` This is the descriptive suffix that becomes part of the `EndpointArn` used for all subsequent requests to this resource.
`CreateEndpointRequest`	`withFlywheelArn (String flywheelArn)` The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.
`CreateEndpointRequest`	`withModelArn (String modelArn)` The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
`CreateEndpointRequest`	`withTags (Collection<Tag> tags)` Tags to associate with the endpoint.
`CreateEndpointRequest`	`withTags (Tag... tags)` Tags to associate with the endpoint.

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
  - CreateEndpointRequest
```
public CreateEndpointRequest()
```
- Method Detail
  - setEndpointName
```
public void setEndpointName(String endpointName)
```
    This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests to this resource.
    
    Parameters:
    
    endpointName - This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests to this resource.
  - getEndpointName
```
public String getEndpointName()
```
    This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests to this resource.
    
    Returns:
    
    This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests to this resource.
  - withEndpointName
```
public CreateEndpointRequest withEndpointName(String endpointName)
```
    This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests to this resource.
    
    Parameters:
    
    endpointName - This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests to this resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelArn
```
public void setModelArn(String modelArn)
```
    The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
    
    Parameters:
    
    modelArn - The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
  - getModelArn
```
public String getModelArn()
```
    The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
    
    Returns:
    
    The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
  - withModelArn
```
public CreateEndpointRequest withModelArn(String modelArn)
```
    The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
    
    Parameters:
    
    modelArn - The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDesiredInferenceUnits
```
public void setDesiredInferenceUnits(Integer desiredInferenceUnits)
```
    The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.
    
    Parameters:
    
    desiredInferenceUnits - The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.
  - getDesiredInferenceUnits
```
public Integer getDesiredInferenceUnits()
```
    The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.
    
    Returns:
    
    The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.
  - withDesiredInferenceUnits
```
public CreateEndpointRequest withDesiredInferenceUnits(Integer desiredInferenceUnits)
```
    The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.
    
    Parameters:
    
    desiredInferenceUnits - The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientRequestToken
```
public void setClientRequestToken(String clientRequestToken)
```
    An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a ResourceInUseException.
    
    Parameters:
    
    clientRequestToken - An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a ResourceInUseException.
  - getClientRequestToken
```
public String getClientRequestToken()
```
    An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a ResourceInUseException.
    
    Returns:
    
    An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a ResourceInUseException.
  - withClientRequestToken
```
public CreateEndpointRequest withClientRequestToken(String clientRequestToken)
```
    An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a ResourceInUseException.
    
    Parameters:
    
    clientRequestToken - An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a ResourceInUseException.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    Tags to associate with the endpoint. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.
    
    Returns:
    
    Tags to associate with the endpoint. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    Tags to associate with the endpoint. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.
    
    Parameters:
    
    tags - Tags to associate with the endpoint. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.
  - withTags
```
public CreateEndpointRequest withTags(Tag... tags)
```
    Tags to associate with the endpoint. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - Tags to associate with the endpoint. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public CreateEndpointRequest withTags(Collection<Tag> tags)
```
    Tags to associate with the endpoint. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.
    
    Parameters:
    
    tags - Tags to associate with the endpoint. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataAccessRoleArn
```
public void setDataAccessRoleArn(String dataAccessRoleArn)
```
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
    
    Parameters:
    
    dataAccessRoleArn - The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
  - getDataAccessRoleArn
```
public String getDataAccessRoleArn()
```
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
  - withDataAccessRoleArn
```
public CreateEndpointRequest withDataAccessRoleArn(String dataAccessRoleArn)
```
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
    
    Parameters:
    
    dataAccessRoleArn - The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFlywheelArn
```
public void setFlywheelArn(String flywheelArn)
```
    The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.
    
    Parameters:
    
    flywheelArn - The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.
  - getFlywheelArn
```
public String getFlywheelArn()
```
    The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.
    
    Returns:
    
    The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.
  - withFlywheelArn
```
public CreateEndpointRequest withFlywheelArn(String flywheelArn)
```
    The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.
    
    Parameters:
    
    flywheelArn - The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.
    
    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 CreateEndpointRequest 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()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class CreateEndpointRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateEndpointRequest

Method Detail

setEndpointName

getEndpointName

withEndpointName

setModelArn

getModelArn

withModelArn

setDesiredInferenceUnits

getDesiredInferenceUnits

withDesiredInferenceUnits

setClientRequestToken

getClientRequestToken

withClientRequestToken

getTags

setTags

withTags

withTags

setDataAccessRoleArn

getDataAccessRoleArn

withDataAccessRoleArn

setFlywheelArn

getFlywheelArn

withFlywheelArn

toString

equals

hashCode

clone