Class EndpointProperties
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EndpointProperties.Builder,
EndpointProperties>
Specifies information about the specified endpoint. For information about endpoints, see Managing endpoints.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic EndpointProperties.Builder
builder()
final Instant
The creation date and time of the endpoint.final Integer
The number of inference units currently used by the model using this endpoint.final String
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).final String
Data access role ARN to use in case the new model is encrypted with a customer KMS key.final Integer
The desired number of inference units to be used by the model using this endpoint.final String
ARN of the new model to use for updating an existing endpoint.final String
The Amazon Resource Number (ARN) of the endpoint.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The Amazon Resource Number (ARN) of the flywheelfinal <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Instant
The date and time that the endpoint was last modified.final String
message()
Specifies a reason for failure in cases ofFailed
status.final String
modelArn()
The Amazon Resource Number (ARN) of the model to which the endpoint is attached.static Class
<? extends EndpointProperties.Builder> final EndpointStatus
status()
Specifies the status of the endpoint.final String
Specifies the status of the endpoint.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
endpointArn
The Amazon Resource Number (ARN) of the endpoint.
- Returns:
- The Amazon Resource Number (ARN) of the endpoint.
-
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 returnEndpointStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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:
-
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 returnEndpointStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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:
-
message
Specifies a reason for failure in cases of
Failed
status.- Returns:
- Specifies a reason for failure in cases of
Failed
status.
-
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
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
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
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
The creation date and time of the endpoint.
- Returns:
- The creation date and time of the endpoint.
-
lastModifiedTime
The date and time that the endpoint was last modified.
- Returns:
- The date and time that the endpoint was last modified.
-
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
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
The Amazon Resource Number (ARN) of the flywheel
- Returns:
- The Amazon Resource Number (ARN) of the flywheel
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<EndpointProperties.Builder,
EndpointProperties> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-