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("software.amazon.awssdk:codegen")
public final class DescribeEndpointResponse
extends SageMakerResponse
implements ToCopyableBuilder<DescribeEndpointResponse.Builder,DescribeEndpointResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeEndpointResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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)`
`ExplainerConfig`	`explainerConfig()`	The configuration parameters for an explainer.
`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.
`boolean`	`hasShadowProductionVariants()`	For responses, this returns true if the service returned a value for the ShadowProductionVariants 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()`
`List<ProductionVariantSummary>`	`shadowProductionVariants()`	An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on `ProductionVariants`.
`DescribeEndpointResponse.Builder`	`toBuilder()`
`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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - endpointName
```
public final String endpointName()
```
    Name of the endpoint.
    
    Returns:
    
    Name of the endpoint.
  - endpointArn
```
public final String endpointArn()
```
    The Amazon Resource Name (ARN) of the endpoint.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the endpoint.
  - endpointConfigName
```
public final 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 final boolean hasProductionVariants()
```
    For responses, this returns true if the service returned a value for the ProductionVariants property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - productionVariants
```
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.
    
    Returns:
    
    An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
  - dataCaptureConfig
```
public final DataCaptureConfigSummary dataCaptureConfig()
```
    Returns the value of the DataCaptureConfig property for this object.
    
    Returns:
    
    The value of the DataCaptureConfig property for this object.
  - endpointStatus
```
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 the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.
    
    UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status to InService, see Rolling Deployments.
    
    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 the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.
    
    UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status to InService, see Rolling Deployments.
    
    See Also:
    
    EndpointStatus
  - endpointStatusAsString
```
public 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 the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.
    
    UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status to InService, see Rolling Deployments.
    
    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 the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.
    
    UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status to InService, see Rolling Deployments.
    
    See Also:
    
    EndpointStatus
  - failureReason
```
public final 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 final Instant creationTime()
```
    A timestamp that shows when the endpoint was created.
    
    Returns:
    
    A timestamp that shows when the endpoint was created.
  - lastModifiedTime
```
public final Instant lastModifiedTime()
```
    A timestamp that shows when the endpoint was last modified.
    
    Returns:
    
    A timestamp that shows when the endpoint was last modified.
  - lastDeploymentConfig
```
public final DeploymentConfig lastDeploymentConfig()
```
    The most recent deployment configuration for the endpoint.
    
    Returns:
    
    The most recent deployment configuration for the endpoint.
  - asyncInferenceConfig
```
public final AsyncInferenceConfig asyncInferenceConfig()
```
    Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
    
    Returns:
    
    Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
  - pendingDeploymentSummary
```
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.
    
    Returns:
    
    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.
  - explainerConfig
```
public final ExplainerConfig explainerConfig()
```
    The configuration parameters for an explainer.
    
    Returns:
    
    The configuration parameters for an explainer.
  - hasShadowProductionVariants
```
public final boolean hasShadowProductionVariants()
```
    For responses, this returns true if the service returned a value for the ShadowProductionVariants property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - shadowProductionVariants
```
public final List<ProductionVariantSummary> shadowProductionVariants()
```
    An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.
    
    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 hasShadowProductionVariants() method.
    
    Returns:
    
    An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.
  - toBuilder
```
public DescribeEndpointResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeEndpointResponse.Builder,DescribeEndpointResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeEndpointResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeEndpointResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeEndpointResponse

Nested Class Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Method Detail

endpointName

endpointArn

endpointConfigName

hasProductionVariants

productionVariants

dataCaptureConfig

endpointStatus

endpointStatusAsString

failureReason

creationTime

lastModifiedTime

lastDeploymentConfig

asyncInferenceConfig

pendingDeploymentSummary

explainerConfig

hasShadowProductionVariants

shadowProductionVariants

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields