0
# Health Check Service
1

2
Service monitoring and health verification capabilities for Google Cloud Vision AI infrastructure. The HealthCheckService provides essential monitoring functionality to verify the operational status of Vision AI clusters and services.
3

4
## Capabilities
5

6
### Health Monitoring
7

8
Performs comprehensive health checks on Vision AI clusters to ensure services are operational and responsive.
9

10
```python { .api }
11
def health_check(self, cluster: str) -> HealthCheckResponse:
12
    """
13
    Performs health check on a Vision AI cluster.
14
    
15
    Args:
16
        cluster (str): Required. Cluster resource path
17
                      "projects/{project}/locations/{location}/clusters/{cluster}"
18
    
19
    Returns:
20
        HealthCheckResponse: Health status information for the cluster
21
    """
22
```
23

24
## Health Check Types
25

26
### Cluster Health Verification
27

28
```python { .api }
29
class HealthCheckRequest:
30
    """Request for health check operation."""
31
    cluster: str  # Cluster resource path to check
32

33
class HealthCheckResponse:
34
    """Response containing health check results."""
35
    cluster_info: ClusterInfo  # Detailed cluster health information
36

37
class ClusterInfo:
38
    """Cluster health and status information."""
39
    # Health status details and metrics
40
    pass
41
```
42

43
## Basic Usage
44

45
```python
46
from google.cloud import visionai_v1
47

48
# Create health check service client
49
health_client = visionai_v1.HealthCheckServiceClient()
50

51
# Check cluster health
52
cluster_path = health_client.common_project_path("my-project") + "/locations/us-central1/clusters/my-cluster"
53
response = health_client.health_check(cluster=cluster_path)
54

55
# Process health check results
56
cluster_info = response.cluster_info
57
print(f"Cluster health status: {cluster_info}")
58
```
59

60
Async usage:
61

62
```python
63
import asyncio
64
from google.cloud import visionai_v1
65

66
async def check_cluster_health():
67
    async with visionai_v1.HealthCheckServiceAsyncClient() as client:
68
        cluster_path = "projects/my-project/locations/us-central1/clusters/my-cluster"
69
        response = await client.health_check(cluster=cluster_path)
70
        return response.cluster_info
71

72
health_info = asyncio.run(check_cluster_health())
73
```
74

75
## Version Availability
76

77
- **v1**: Full HealthCheckService available
78
- **v1alpha1**: HealthCheckService not available (use v1 for health monitoring)
79

80
The HealthCheckService is only available in the stable v1 API and provides essential monitoring capabilities for production deployments.