Module ai.docling.serve.client

Package ai.docling.serve.client.operations

Class HealthOperations

java.lang.Object

ai.docling.serve.client.operations.HealthOperations

All Implemented Interfaces:

ai.docling.serve.api.DoclingServeHealthApi

public final class HealthOperations
extends Object
implements ai.docling.serve.api.DoclingServeHealthApi

Base class for health API operations. Provides access to health check functionality of the Docling service.

Constructor Summary

Constructors

Constructor	Description
HealthOperations(HttpOperations httpOperations)

Method Summary

Modifier and Type	Method	Description
ai.docling.serve.api.health.HealthCheckResponse	health()	Executes a health check for the API and retrieves the health status of the service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HealthOperations

public HealthOperations(HttpOperations httpOperations)

Method Details

health

public ai.docling.serve.api.health.HealthCheckResponse health()

Executes a health check for the API and retrieves the health status of the service.

Specified by:

health in interface ai.docling.serve.api.DoclingServeHealthApi

Returns:

a HealthCheckResponse object containing the health status of the API.