@Generated(value="software.amazon.awssdk:codegen") public final class DescribeEndpointResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeEndpointResponse.Builder,DescribeEndpointResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
DescribeEndpointResponse.Builder |
| 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).
|
DeploymentConfig |
lastDeploymentConfig()
The most recent deployment configuration for the endpoint.
|
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.
|
responseMetadatasdkHttpResponsecopypublic final String endpointName()
Name of the endpoint.
public final String endpointArn()
The Amazon Resource Name (ARN) of the endpoint.
public final String endpointConfigName()
The name of the endpoint configuration associated with this endpoint.
public final boolean hasProductionVariants()
public final 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.
public final DataCaptureConfigSummary dataCaptureConfig()
public final 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().
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.
EndpointStatuspublic final 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().
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.
EndpointStatuspublic final String failureReason()
If the status of the endpoint is Failed, the reason why it failed.
Failed, the reason why it failed.public final Instant creationTime()
A timestamp that shows when the endpoint was created.
public final Instant lastModifiedTime()
A timestamp that shows when the endpoint was last modified.
public final DeploymentConfig lastDeploymentConfig()
The most recent deployment configuration for the endpoint.
public DescribeEndpointResponse.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<DescribeEndpointResponse.Builder,DescribeEndpointResponse>toBuilder in class AwsResponsepublic static DescribeEndpointResponse.Builder builder()
public static Class<? extends DescribeEndpointResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponseSdkResponse. 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.getValueForField in class SdkResponsefieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.