software.amazon.awssdk.services.sagemaker.model

Class DescribeEndpointResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

software.amazon.awssdk.services.sagemaker.model.DescribeEndpointResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeEndpointResponse.Builder,DescribeEndpointResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeEndpointResponse
extends SageMakerResponse
implements ToCopyableBuilder<DescribeEndpointResponse.Builder,DescribeEndpointResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeEndpointResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeEndpointResponse.Builder	builder()
Instant	creationTime() A timestamp that shows when the endpoint was created.
DataCaptureConfigSummary	dataCaptureConfig() Returns the value of the DataCaptureConfig property for this object.
String	endpointArn() The Amazon Resource Name (ARN) of the endpoint.
String	endpointConfigName() The name of the endpoint configuration associated with this endpoint.
String	endpointName() Name of the endpoint.
EndpointStatus	endpointStatus() The status of the endpoint.
String	endpointStatusAsString() The status of the endpoint.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
String	failureReason() If the status of the endpoint is Failed, the reason why it failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
boolean	hasProductionVariants() Returns true if the ProductionVariants property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Instant	lastModifiedTime() A timestamp that shows when the endpoint was last modified.
List<ProductionVariantSummary>	productionVariants() An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeEndpointResponse.Builder>	serializableBuilderClass()
DescribeEndpointResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

Name of the endpoint.

Returns:

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.

endpointConfigName

public String endpointConfigName()

The name of the endpoint configuration associated with this endpoint.

Returns:

The name of the endpoint configuration associated with this endpoint.

hasProductionVariants

public boolean hasProductionVariants()

Returns true if the ProductionVariants property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

productionVariants

public List<ProductionVariantSummary> productionVariants()

An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasProductionVariants() to see if a value was sent in this field.

Returns:

An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

dataCaptureConfig

public DataCaptureConfigSummary dataCaptureConfig()

Returns the value of the DataCaptureConfig property for this object.

Returns:

The value of the DataCaptureConfig property for this object.

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

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

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

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

See Also:

EndpointStatus

failureReason

public String failureReason()

If the status of the endpoint is Failed, the reason why it failed.

Returns:

If the status of the endpoint is Failed, the reason why it failed.

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.

toBuilder

public DescribeEndpointResponse.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<DescribeEndpointResponse.Builder,DescribeEndpointResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeEndpointResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

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.