software.amazon.awssdk.services.sagemaker.model

Class EndpointSummary

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.EndpointSummary

All Implemented Interfaces:

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

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

Provides summary information for an endpoint.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EndpointSummary.Builder

Method Summary

Modifier and Type	Method and Description
static EndpointSummary.Builder	builder()
Instant	creationTime() A timestamp that shows when the endpoint was created.
String	endpointArn() The Amazon Resource Name (ARN) of the endpoint.
String	endpointName() The name of the endpoint.
EndpointStatus	endpointStatus() The status of the endpoint.
String	endpointStatusAsString() The status of the endpoint.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastModifiedTime() A timestamp that shows when the endpoint was last modified.
List<SdkField<?>>	sdkFields()
static Class<? extends EndpointSummary.Builder>	serializableBuilderClass()
EndpointSummary.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

endpointName

public String endpointName()

The name of the endpoint.

Returns:

The name of the endpoint.

endpointArn

public String endpointArn()

The Amazon Resource Name (ARN) of the endpoint.

Returns:

The Amazon Resource Name (ARN) of the endpoint.

creationTime

public Instant creationTime()

A timestamp that shows when the endpoint was created.

Returns:

A timestamp that shows when the endpoint was created.

lastModifiedTime

public Instant lastModifiedTime()

A timestamp that shows when the endpoint was last modified.

Returns:

A timestamp that shows when the endpoint was last modified.

endpointStatus

public EndpointStatus 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 mainenance 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 an InService 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. Use DescribeEndpointOutput$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 ListEndpointsInput$StatusEquals filter.

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

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 mainenance 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 an InService 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. Use DescribeEndpointOutput$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 ListEndpointsInput$StatusEquals filter.

See Also:

EndpointStatus

endpointStatusAsString

public String 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 mainenance 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 an InService 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. Use DescribeEndpointOutput$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 ListEndpointsInput$StatusEquals filter.

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

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 mainenance 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 an InService 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. Use DescribeEndpointOutput$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 ListEndpointsInput$StatusEquals filter.

See Also:

EndpointStatus

toBuilder

public EndpointSummary.Builder 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 interface ToCopyableBuilder<EndpointSummary.Builder,EndpointSummary>

Returns:

a builder for type T

builder

public static EndpointSummary.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.