Class EndpointSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EndpointSummary.Builder,
EndpointSummary>
Provides summary information for an endpoint.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic EndpointSummary.Builder
builder()
final Instant
A timestamp that shows when the endpoint was created.final String
The Amazon Resource Name (ARN) of the endpoint.final String
The name of the endpoint.final EndpointStatus
The status of the endpoint.final String
The status of the endpoint.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Instant
A timestamp that shows when the endpoint was last modified.static Class
<? extends EndpointSummary.Builder> 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
-
endpointName
The name of the endpoint.
- Returns:
- The name of the endpoint.
-
endpointArn
The Amazon Resource Name (ARN) of the endpoint.
- Returns:
- The Amazon Resource Name (ARN) of the endpoint.
-
creationTime
A timestamp that shows when the endpoint was created.
- Returns:
- A timestamp that shows when the endpoint was created.
-
lastModifiedTime
A timestamp that shows when the endpoint was last modified.
- Returns:
- A timestamp that shows when the endpoint was last modified.
-
endpointStatus
The status of the endpoint.
-
OutOfService
: Endpoint is not available to take incoming requests. -
Creating
: CreateEndpoint is executing. -
Updating
: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing. -
SystemUpdating
: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count. -
RollingBack
: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to anInService
status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly. -
InService
: Endpoint is available to process incoming requests. -
Deleting
: DeleteEndpoint is executing. -
Failed
: Endpoint could not be created, updated, or re-scaled. UseDescribeEndpointOutput$FailureReason
for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.
To get a list of endpoints with a specified status, use the
StatusEquals
filter with a call to ListEndpoints.If the service returns an enum value that is not available in the current SDK version,
endpointStatus
will returnEndpointStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendpointStatusAsString()
.- Returns:
- The status of the endpoint.
-
OutOfService
: Endpoint is not available to take incoming requests. -
Creating
: CreateEndpoint is executing. -
Updating
: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing. -
SystemUpdating
: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count. -
RollingBack
: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to anInService
status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly. -
InService
: Endpoint is available to process incoming requests. -
Deleting
: DeleteEndpoint is executing. -
Failed
: Endpoint could not be created, updated, or re-scaled. UseDescribeEndpointOutput$FailureReason
for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.
To get a list of endpoints with a specified status, use the
StatusEquals
filter with a call to ListEndpoints . -
- See Also:
-
-
endpointStatusAsString
The status of the endpoint.
-
OutOfService
: Endpoint is not available to take incoming requests. -
Creating
: CreateEndpoint is executing. -
Updating
: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing. -
SystemUpdating
: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count. -
RollingBack
: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to anInService
status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly. -
InService
: Endpoint is available to process incoming requests. -
Deleting
: DeleteEndpoint is executing. -
Failed
: Endpoint could not be created, updated, or re-scaled. UseDescribeEndpointOutput$FailureReason
for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.
To get a list of endpoints with a specified status, use the
StatusEquals
filter with a call to ListEndpoints.If the service returns an enum value that is not available in the current SDK version,
endpointStatus
will returnEndpointStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendpointStatusAsString()
.- Returns:
- The status of the endpoint.
-
OutOfService
: Endpoint is not available to take incoming requests. -
Creating
: CreateEndpoint is executing. -
Updating
: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing. -
SystemUpdating
: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count. -
RollingBack
: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to anInService
status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly. -
InService
: Endpoint is available to process incoming requests. -
Deleting
: DeleteEndpoint is executing. -
Failed
: Endpoint could not be created, updated, or re-scaled. UseDescribeEndpointOutput$FailureReason
for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.
To get a list of endpoints with a specified status, use the
StatusEquals
filter with a call to ListEndpoints . -
- See Also:
-
-
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<EndpointSummary.Builder,
EndpointSummary> - 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
-