software.amazon.awssdk.services.comprehend.model

Class CreateEndpointRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.comprehend.model.ComprehendRequest

software.amazon.awssdk.services.comprehend.model.CreateEndpointRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateEndpointRequest.Builder,CreateEndpointRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateEndpointRequest
extends ComprehendRequest
implements ToCopyableBuilder<CreateEndpointRequest.Builder,CreateEndpointRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateEndpointRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateEndpointRequest.Builder	builder()
String	clientRequestToken() An idempotency token provided by the customer.
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).
Integer	desiredInferenceUnits() The desired number of inference units to be used by the model using this endpoint.
String	endpointName() This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests to this resource.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	flywheelArn() The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	modelArn() The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateEndpointRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() Tags to associate with the endpoint.
CreateEndpointRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

endpointName

public final String endpointName()

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.

modelArn

public final String modelArn()

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.

desiredInferenceUnits

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

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.

clientRequestToken

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

Returns:

An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a ResourceInUseException.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

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.

dataAccessRoleArn

public final 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).

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).

flywheelArn

public final String flywheelArn()

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.

toBuilder

public CreateEndpointRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateEndpointRequest.Builder,CreateEndpointRequest>

Specified by:

toBuilder in class ComprehendRequest

builder

public static CreateEndpointRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateEndpointRequest.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo