DescribeEndpointResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.sagemaker.model.DescribeEndpointResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeEndpointResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeEndpointResult()

Constructors
Constructor and Description
`DescribeEndpointResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeEndpointResult`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` A timestamp that shows when the endpoint was created.
`DataCaptureConfigSummary`	`getDataCaptureConfig()`
`String`	`getEndpointArn()` The Amazon Resource Name (ARN) of the endpoint.
`String`	`getEndpointConfigName()` The name of the endpoint configuration associated with this endpoint.
`String`	`getEndpointName()` Name of the endpoint.
`String`	`getEndpointStatus()` The status of the endpoint.
`String`	`getFailureReason()` If the status of the endpoint is `Failed`, the reason why it failed.
`Date`	`getLastModifiedTime()` A timestamp that shows when the endpoint was last modified.
`List<ProductionVariantSummary>`	`getProductionVariants()` An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
`int`	`hashCode()`
`void`	`setCreationTime(Date creationTime)` A timestamp that shows when the endpoint was created.
`void`	`setDataCaptureConfig(DataCaptureConfigSummary dataCaptureConfig)`
`void`	`setEndpointArn(String endpointArn)` The Amazon Resource Name (ARN) of the endpoint.
`void`	`setEndpointConfigName(String endpointConfigName)` The name of the endpoint configuration associated with this endpoint.
`void`	`setEndpointName(String endpointName)` Name of the endpoint.
`void`	`setEndpointStatus(String endpointStatus)` The status of the endpoint.
`void`	`setFailureReason(String failureReason)` If the status of the endpoint is `Failed`, the reason why it failed.
`void`	`setLastModifiedTime(Date lastModifiedTime)` A timestamp that shows when the endpoint was last modified.
`void`	`setProductionVariants(Collection<ProductionVariantSummary> productionVariants)` An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
`String`	`toString()` Returns a string representation of this object.
`DescribeEndpointResult`	`withCreationTime(Date creationTime)` A timestamp that shows when the endpoint was created.
`DescribeEndpointResult`	`withDataCaptureConfig(DataCaptureConfigSummary dataCaptureConfig)`
`DescribeEndpointResult`	`withEndpointArn(String endpointArn)` The Amazon Resource Name (ARN) of the endpoint.
`DescribeEndpointResult`	`withEndpointConfigName(String endpointConfigName)` The name of the endpoint configuration associated with this endpoint.
`DescribeEndpointResult`	`withEndpointName(String endpointName)` Name of the endpoint.
`DescribeEndpointResult`	`withEndpointStatus(EndpointStatus endpointStatus)` The status of the endpoint.
`DescribeEndpointResult`	`withEndpointStatus(String endpointStatus)` The status of the endpoint.
`DescribeEndpointResult`	`withFailureReason(String failureReason)` If the status of the endpoint is `Failed`, the reason why it failed.
`DescribeEndpointResult`	`withLastModifiedTime(Date lastModifiedTime)` A timestamp that shows when the endpoint was last modified.
`DescribeEndpointResult`	`withProductionVariants(Collection<ProductionVariantSummary> productionVariants)` An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
`DescribeEndpointResult`	`withProductionVariants(ProductionVariantSummary... productionVariants)` An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeEndpointResult
```
public DescribeEndpointResult()
```
- Method Detail
  - setEndpointName
```
public void setEndpointName(String endpointName)
```
    Name of the endpoint.
    
    Parameters:
    
    endpointName - Name of the endpoint.
  - getEndpointName
```
public String getEndpointName()
```
    Name of the endpoint.
    
    Returns:
    
    Name of the endpoint.
  - withEndpointName
```
public DescribeEndpointResult withEndpointName(String endpointName)
```
    Name of the endpoint.
    
    Parameters:
    
    endpointName - Name of the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointArn
```
public void setEndpointArn(String endpointArn)
```
    The Amazon Resource Name (ARN) of the endpoint.
    
    Parameters:
    
    endpointArn - The Amazon Resource Name (ARN) of the endpoint.
  - getEndpointArn
```
public String getEndpointArn()
```
    The Amazon Resource Name (ARN) of the endpoint.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the endpoint.
  - withEndpointArn
```
public DescribeEndpointResult withEndpointArn(String endpointArn)
```
    The Amazon Resource Name (ARN) of the endpoint.
    
    Parameters:
    
    endpointArn - The Amazon Resource Name (ARN) of the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointConfigName
```
public void setEndpointConfigName(String endpointConfigName)
```
    The name of the endpoint configuration associated with this endpoint.
    
    Parameters:
    
    endpointConfigName - The name of the endpoint configuration associated with this endpoint.
  - getEndpointConfigName
```
public String getEndpointConfigName()
```
    The name of the endpoint configuration associated with this endpoint.
    
    Returns:
    
    The name of the endpoint configuration associated with this endpoint.
  - withEndpointConfigName
```
public DescribeEndpointResult withEndpointConfigName(String endpointConfigName)
```
    The name of the endpoint configuration associated with this endpoint.
    
    Parameters:
    
    endpointConfigName - The name of the endpoint configuration associated with this endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getProductionVariants
```
public List<ProductionVariantSummary> getProductionVariants()
```
    An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
    
    Returns:
    
    An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
  - setProductionVariants
```
public void setProductionVariants(Collection<ProductionVariantSummary> productionVariants)
```
    An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
    
    Parameters:
    
    productionVariants - An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
  - withProductionVariants
```
public DescribeEndpointResult withProductionVariants(ProductionVariantSummary... productionVariants)
```
    An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
    
    NOTE: This method appends the values to the existing list (if any). Use setProductionVariants(java.util.Collection) or withProductionVariants(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    productionVariants - An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withProductionVariants
```
public DescribeEndpointResult withProductionVariants(Collection<ProductionVariantSummary> productionVariants)
```
    An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
    
    Parameters:
    
    productionVariants - An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataCaptureConfig
```
public void setDataCaptureConfig(DataCaptureConfigSummary dataCaptureConfig)
```
    Parameters:
    
    dataCaptureConfig -
  - getDataCaptureConfig
```
public DataCaptureConfigSummary getDataCaptureConfig()
```
    Returns:
  - withDataCaptureConfig
```
public DescribeEndpointResult withDataCaptureConfig(DataCaptureConfigSummary dataCaptureConfig)
```
    Parameters:
    
    dataCaptureConfig -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointStatus
```
public void setEndpointStatus(String 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.
    Parameters:
    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.
    See Also:
    
    EndpointStatus
  - getEndpointStatus
```
public String getEndpointStatus()
```
    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.
    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
  - withEndpointStatus
```
public DescribeEndpointResult withEndpointStatus(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EndpointStatus
  - withEndpointStatus
```
public DescribeEndpointResult withEndpointStatus(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EndpointStatus
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    If the status of the endpoint is Failed, the reason why it failed.
    
    Parameters:
    
    failureReason - If the status of the endpoint is Failed, the reason why it failed.
  - getFailureReason
```
public String getFailureReason()
```
    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.
  - withFailureReason
```
public DescribeEndpointResult withFailureReason(String failureReason)
```
    If the status of the endpoint is Failed, the reason why it failed.
    
    Parameters:
    
    failureReason - If the status of the endpoint is Failed, the reason why it failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    A timestamp that shows when the endpoint was created.
    
    Parameters:
    
    creationTime - A timestamp that shows when the endpoint was created.
  - getCreationTime
```
public Date getCreationTime()
```
    A timestamp that shows when the endpoint was created.
    
    Returns:
    
    A timestamp that shows when the endpoint was created.
  - withCreationTime
```
public DescribeEndpointResult withCreationTime(Date creationTime)
```
    A timestamp that shows when the endpoint was created.
    
    Parameters:
    
    creationTime - A timestamp that shows when the endpoint was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
    A timestamp that shows when the endpoint was last modified.
    
    Parameters:
    
    lastModifiedTime - A timestamp that shows when the endpoint was last modified.
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    A timestamp that shows when the endpoint was last modified.
    
    Returns:
    
    A timestamp that shows when the endpoint was last modified.
  - withLastModifiedTime
```
public DescribeEndpointResult withLastModifiedTime(Date lastModifiedTime)
```
    A timestamp that shows when the endpoint was last modified.
    
    Parameters:
    
    lastModifiedTime - A timestamp that shows when the endpoint was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeEndpointResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DescribeEndpointResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeEndpointResult

Method Detail

setEndpointName

getEndpointName

withEndpointName

setEndpointArn

getEndpointArn

withEndpointArn

setEndpointConfigName

getEndpointConfigName

withEndpointConfigName

getProductionVariants

setProductionVariants

withProductionVariants

withProductionVariants

setDataCaptureConfig

getDataCaptureConfig

withDataCaptureConfig

setEndpointStatus

getEndpointStatus

withEndpointStatus

withEndpointStatus

setFailureReason

getFailureReason

withFailureReason

setCreationTime

getCreationTime

withCreationTime

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

toString

equals

hashCode

clone