software.amazon.awssdk.services.comprehend.model

Interface EndpointProperties.Builder

All Superinterfaces:

Buildable, CopyableBuilder<EndpointProperties.Builder,EndpointProperties>, SdkBuilder<EndpointProperties.Builder,EndpointProperties>, SdkPojo

Enclosing class:

EndpointProperties

public static interface EndpointProperties.Builder
extends SdkPojo, CopyableBuilder<EndpointProperties.Builder,EndpointProperties>

Method Summary

Modifier and Type	Method and Description
EndpointProperties.Builder	creationTime(Instant creationTime) The creation date and time of the endpoint.
EndpointProperties.Builder	currentInferenceUnits(Integer currentInferenceUnits) The number of inference units currently used by the model using this endpoint.
EndpointProperties.Builder	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).
EndpointProperties.Builder	desiredDataAccessRoleArn(String desiredDataAccessRoleArn) Data access role ARN to use in case the new model is encrypted with a customer KMS key.
EndpointProperties.Builder	desiredInferenceUnits(Integer desiredInferenceUnits) The desired number of inference units to be used by the model using this endpoint.
EndpointProperties.Builder	desiredModelArn(String desiredModelArn) ARN of the new model to use for updating an existing endpoint.
EndpointProperties.Builder	endpointArn(String endpointArn) The Amazon Resource Number (ARN) of the endpoint.
EndpointProperties.Builder	flywheelArn(String flywheelArn) The Amazon Resource Number (ARN) of the flywheel
EndpointProperties.Builder	lastModifiedTime(Instant lastModifiedTime) The date and time that the endpoint was last modified.
EndpointProperties.Builder	message(String message) Specifies a reason for failure in cases of Failed status.
EndpointProperties.Builder	modelArn(String modelArn) The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
EndpointProperties.Builder	status(EndpointStatus status) Specifies the status of the endpoint.
EndpointProperties.Builder	status(String status) Specifies the status of the endpoint.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

endpointArn

EndpointProperties.Builder endpointArn(String endpointArn)

The Amazon Resource Number (ARN) of the endpoint.

Parameters:

endpointArn - The Amazon Resource Number (ARN) of the endpoint.

Returns:

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

status

EndpointProperties.Builder status(String status)

Specifies the status of the endpoint. Because the endpoint updates and creation are asynchronous, so customers will need to wait for the endpoint to be Ready status before making inference requests.

Parameters:

status - Specifies the status of the endpoint. Because the endpoint updates and creation are asynchronous, so customers will need to wait for the endpoint to be Ready status before making inference requests.

Returns:

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

See Also:

EndpointStatus, EndpointStatus

status

EndpointProperties.Builder status(EndpointStatus status)

Specifies the status of the endpoint. Because the endpoint updates and creation are asynchronous, so customers will need to wait for the endpoint to be Ready status before making inference requests.

Parameters:

status - Specifies the status of the endpoint. Because the endpoint updates and creation are asynchronous, so customers will need to wait for the endpoint to be Ready status before making inference requests.

Returns:

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

See Also:

EndpointStatus, EndpointStatus

message

EndpointProperties.Builder message(String message)

Specifies a reason for failure in cases of Failed status.

Parameters:

message - Specifies a reason for failure in cases of Failed status.

Returns:

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

modelArn

EndpointProperties.Builder modelArn(String modelArn)

The Amazon Resource Number (ARN) of the model to which the endpoint is attached.

Parameters:

modelArn - The Amazon Resource Number (ARN) of the model to which the endpoint is attached.

Returns:

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

desiredModelArn

EndpointProperties.Builder desiredModelArn(String desiredModelArn)

ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress

Parameters:

desiredModelArn - ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress

Returns:

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

desiredInferenceUnits

EndpointProperties.Builder desiredInferenceUnits(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.

currentInferenceUnits

EndpointProperties.Builder currentInferenceUnits(Integer currentInferenceUnits)

The number of inference units currently used by the model using this endpoint.

Parameters:

currentInferenceUnits - The number of inference units currently used by the model using this endpoint.

Returns:

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

creationTime

EndpointProperties.Builder creationTime(Instant creationTime)

The creation date and time of the endpoint.

Parameters:

creationTime - The creation date and time of the endpoint.

Returns:

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

lastModifiedTime

EndpointProperties.Builder lastModifiedTime(Instant lastModifiedTime)

The date and time that the endpoint was last modified.

Parameters:

lastModifiedTime - The date and time that the endpoint was last modified.

Returns:

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

dataAccessRoleArn

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

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.

desiredDataAccessRoleArn

EndpointProperties.Builder desiredDataAccessRoleArn(String desiredDataAccessRoleArn)

Data access role ARN to use in case the new model is encrypted with a customer KMS key.

Parameters:

desiredDataAccessRoleArn - Data access role ARN to use in case the new model is encrypted with a customer KMS key.

Returns:

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

flywheelArn

EndpointProperties.Builder flywheelArn(String flywheelArn)

The Amazon Resource Number (ARN) of the flywheel

Parameters:

flywheelArn - The Amazon Resource Number (ARN) of the flywheel

Returns:

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