Interface CreateEndpointRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,ComprehendRequest.Builder
,CopyableBuilder<CreateEndpointRequest.Builder,
,CreateEndpointRequest> SdkBuilder<CreateEndpointRequest.Builder,
,CreateEndpointRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateEndpointRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientRequestToken
(String clientRequestToken) An idempotency token provided by the customer.dataAccessRoleArn
(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).desiredInferenceUnits
(Integer desiredInferenceUnits) The desired number of inference units to be used by the model using this endpoint.endpointName
(String endpointName) This is the descriptive suffix that becomes part of theEndpointArn
used for all subsequent requests to this resource.flywheelArn
(String flywheelArn) The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.tags
(Collection<Tag> tags) Tags to associate with the endpoint.tags
(Consumer<Tag.Builder>... tags) Tags to associate with the endpoint.Tags to associate with the endpoint.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.comprehend.model.ComprehendRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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 theEndpointArn
used for all subsequent requests to this resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
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 aResourceInUseException
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
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.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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.
-
overrideConfiguration
CreateEndpointRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateEndpointRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-