Package org.gitlab4j.api

Class HealthCheckApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.HealthCheckApi

All Implemented Interfaces:

Constants

public class HealthCheckApi
extends AbstractApi

Nested Class Summary

Nested classes/interfaces inherited from interface org.gitlab4j.api.Constants

Constants.ActionType, Constants.ApplicationScope, Constants.ArchiveFormat, Constants.AutoDevopsDeployStrategy, Constants.BuildGitStrategy, Constants.CommitBuildState, Constants.DeploymentOrderBy, Constants.DeploymentStatus, Constants.DeployTokenScope, Constants.Encoding, Constants.EpicOrderBy, Constants.GroupOrderBy, Constants.GroupSearchScope, Constants.ImpersonationState, Constants.IssueOrderBy, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestOrderBy, Constants.MergeRequestScope, Constants.MergeRequestSearchIn, Constants.MergeRequestState, Constants.MilestoneState, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.ProjectSearchScope, Constants.SearchScope, Constants.SortOrder, Constants.SquashOption, Constants.StateEvent, Constants.TagOrderBy, Constants.TargetType, Constants.TodoAction, Constants.TodoState, Constants.TodoType, Constants.TokenType

Field Summary

Fields inherited from class org.gitlab4j.api.AbstractApi

gitLabApi

Fields inherited from interface org.gitlab4j.api.Constants

NEXT_PAGE_HEADER, PAGE_HEADER, PAGE_PARAM, PER_PAGE, PER_PAGE_PARAM, PREV_PAGE_HEADER, TOTAL_HEADER, TOTAL_PAGES_HEADER

Constructor Summary

Constructors

Constructor	Description
HealthCheckApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method	Description
HealthCheckInfo	getLiveness()	Get Health Checks from the liveness endpoint.
HealthCheckInfo	getLiveness(String token)	Deprecated.
HealthCheckInfo	getReadiness()	Get Health Checks from the readiness endpoint.
HealthCheckInfo	getReadiness(String token)	Deprecated.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getDefaultPerPageParam, getGroupIdOrPath, getLabelIdOrName, getPageQueryParams, getPageQueryParams, getPerPageQueryParam, getProjectIdOrPath, getUserIdOrUsername, getWithAccepts, handle, head, isApiVersion, post, post, post, post, post, put, put, put, putUpload, putUpload, putWithFormData, upload, upload, upload, urlEncode, validate

Methods inherited from class java.lang.Object

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

Constructor Details

HealthCheckApi

public HealthCheckApi(GitLabApi gitLabApi)

Method Details

getLiveness

public HealthCheckInfo getLiveness()
                            throws GitLabApiException

Get Health Checks from the liveness endpoint. Requires ip_whitelist, see the following link for more info: See https://docs.gitlab.com/ee/administration/monitoring/ip_whitelist.html

GitLab Endpoint: GET /-/liveness

Returns:

HealthCheckInfo instance

Throws:

GitLabApiException - if any exception occurs

getLiveness

public HealthCheckInfo getLiveness(String token)
                            throws GitLabApiException

Deprecated.

Get Health Checks from the liveness endpoint.

GitLab Endpoint: GET /-/liveness

Parameters:

token - Health Status token

Returns:

HealthCheckInfo instance

Throws:

GitLabApiException - if any exception occurs

getReadiness

public HealthCheckInfo getReadiness()
                             throws GitLabApiException

Get Health Checks from the readiness endpoint. Requires ip_whitelist, see the following link for more info: See https://docs.gitlab.com/ee/administration/monitoring/ip_whitelist.html

GitLab Endpoint: GET /-/readiness

Returns:

HealthCheckInfo instance

Throws:

GitLabApiException - if any exception occurs

getReadiness

public HealthCheckInfo getReadiness(String token)
                             throws GitLabApiException

Deprecated.

Get Health Checks from the readiness endpoint.

GitLab Endpoint: GET /-/readiness

Parameters:

token - Health Status token

Returns:

HealthCheckInfo instance

Throws:

GitLabApiException - if any exception occurs