@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 |
|---|---|
AsyncInferenceConfig |
asyncInferenceConfig()
Returns the description of an endpoint configuration created using the
CreateEndpointConfig API. |
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) |
String |
failureReason()
If the status of the endpoint is
Failed, the reason why it failed. |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasProductionVariants()
For responses, this returns true if the service returned a value for the ProductionVariants property.
|
DeploymentConfig |
lastDeploymentConfig()
The most recent deployment configuration for the endpoint.
|
Instant |
lastModifiedTime()
A timestamp that shows when the endpoint was last modified.
|
PendingDeploymentSummary |
pendingDeploymentSummary()
Returns the summary of an in-progress deployment.
|
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() |
String |
toString()
Returns a string representation of this object.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic 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()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasProductionVariants() method.
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 final AsyncInferenceConfig asyncInferenceConfig()
Returns the description of an endpoint configuration created using the
CreateEndpointConfig API.
CreateEndpointConfig API.public final PendingDeploymentSummary pendingDeploymentSummary()
Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or updating with a new endpoint configuration.
public DescribeEndpointResponse.Builder toBuilder()
toBuilder 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)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2022. All rights reserved.