Package software.amazon.awssdk.services.comprehend.model

Class EndpointProperties

java.lang.Object

software.amazon.awssdk.services.comprehend.model.EndpointProperties

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EndpointProperties.Builder,EndpointProperties>

@Generated("software.amazon.awssdk:codegen")
public final class EndpointProperties
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EndpointProperties.Builder,EndpointProperties>

Specifies information about the specified endpoint. For information about endpoints, see Managing endpoints.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EndpointProperties.Builder

Method Summary

Modifier and Type	Method	Description
static EndpointProperties.Builder	builder()
Instant	creationTime()	The creation date and time of the endpoint.
Integer	currentInferenceUnits()	The number of inference units currently used by the model using this endpoint.
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).
String	desiredDataAccessRoleArn()	Data access role ARN to use in case the new model is encrypted with a customer KMS key.
Integer	desiredInferenceUnits()	The desired number of inference units to be used by the model using this endpoint.
String	desiredModelArn()	ARN of the new model to use for updating an existing endpoint.
String	endpointArn()	The Amazon Resource Number (ARN) of the endpoint.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	flywheelArn()	The Amazon Resource Number (ARN) of the flywheel
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastModifiedTime()	The date and time that the endpoint was last modified.
String	message()	Specifies a reason for failure in cases of Failed status.
String	modelArn()	The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
List<SdkField<?>>	sdkFields()
static Class<? extends EndpointProperties.Builder>	serializableBuilderClass()
EndpointStatus	status()	Specifies the status of the endpoint.
String	statusAsString()	Specifies the status of the endpoint.
EndpointProperties.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

endpointArn

public final String endpointArn()

The Amazon Resource Number (ARN) of the endpoint.

Returns:

The Amazon Resource Number (ARN) of the endpoint.

status

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

If the service returns an enum value that is not available in the current SDK version, status will return EndpointStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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.

See Also:

EndpointStatus

statusAsString

public final String statusAsString()

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.

If the service returns an enum value that is not available in the current SDK version, status will return EndpointStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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.

See Also:

EndpointStatus

message

public final String message()

Specifies a reason for failure in cases of Failed status.

Returns:

Specifies a reason for failure in cases of Failed status.

modelArn

public final String modelArn()

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

Returns:

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

desiredModelArn

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

Returns:

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

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.

currentInferenceUnits

public final Integer currentInferenceUnits()

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

Returns:

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

creationTime

public final Instant creationTime()

The creation date and time of the endpoint.

Returns:

The creation date and time of the endpoint.

lastModifiedTime

public final Instant lastModifiedTime()

The date and time that the endpoint was last modified.

Returns:

The date and time that the endpoint was last modified.

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

desiredDataAccessRoleArn

public final String desiredDataAccessRoleArn()

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

Returns:

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

flywheelArn

public final String flywheelArn()

The Amazon Resource Number (ARN) of the flywheel

Returns:

The Amazon Resource Number (ARN) of the flywheel

toBuilder

public EndpointProperties.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EndpointProperties.Builder,EndpointProperties>

builder

public static EndpointProperties.Builder builder()

serializableBuilderClass

public static Class<? extends EndpointProperties.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo