CosmosHealthIndicator (Azure SDK for Java Reference Documentation)

java.lang.Object
- org.springframework.boot.actuate.health.AbstractHealthIndicator
- - com.azure.spring.autoconfigure.cosmos.CosmosHealthIndicator

All Implemented Interfaces:

org.springframework.boot.actuate.health.HealthContributor, org.springframework.boot.actuate.health.HealthIndicator
```
public class CosmosHealthIndicator
extends org.springframework.boot.actuate.health.AbstractHealthIndicator
```
Simple implementation of a HealthIndicator returning status information for Cosmos data stores.

- Constructor Summary
  
  Constructors
  Constructor Description
  
  CosmosHealthIndicator(com.azure.cosmos.CosmosAsyncClient cosmosAsyncClient)
  Creates a new instance of CosmosHealthIndicator.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  protected void doHealthCheck(org.springframework.boot.actuate.health.Health.Builder builder)
  - Methods inherited from class org.springframework.boot.actuate.health.AbstractHealthIndicator
    health
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  - Methods inherited from interface org.springframework.boot.actuate.health.HealthIndicator
    getHealth

- Constructor Detail
  - CosmosHealthIndicator
```
public CosmosHealthIndicator(com.azure.cosmos.CosmosAsyncClient cosmosAsyncClient)
```
    Creates a new instance of CosmosHealthIndicator.
    
    Parameters:
    
    cosmosAsyncClient - the CosmosAsyncClient
- Method Detail
  - doHealthCheck
```
protected void doHealthCheck(org.springframework.boot.actuate.health.Health.Builder builder)
                      throws Exception
```
    Specified by:
    
    doHealthCheck in class org.springframework.boot.actuate.health.AbstractHealthIndicator
    
    Throws:
    
    Exception