forge-dashboard-sdk-php

HealthApi
in package

HealthApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

Constants

contentTypes  : array<string|int, string> = ['getVersion' => ['application/json'], 'health'...

Properties

$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
$hostIndex  : int

Methods

__construct()  : mixed
getConfig()  : Configuration
getHostIndex()  : int
Get the host index
getVersion()  : Version
Operation getVersion
getVersionAsync()  : PromiseInterface
Operation getVersionAsync
getVersionAsyncWithHttpInfo()  : PromiseInterface
Operation getVersionAsyncWithHttpInfo
getVersionRequest()  : Request
Create request for operation 'getVersion'
getVersionWithHttpInfo()  : array<string|int, mixed>
Operation getVersionWithHttpInfo
health()  : Health
Operation health
healthAsync()  : PromiseInterface
Operation healthAsync
healthAsyncWithHttpInfo()  : PromiseInterface
Operation healthAsyncWithHttpInfo
healthRequest()  : Request
Create request for operation 'health'
healthWithHttpInfo()  : array<string|int, mixed>
Operation healthWithHttpInfo
ready()  : Health|Error
Operation ready
readyAsync()  : PromiseInterface
Operation readyAsync
readyAsyncWithHttpInfo()  : PromiseInterface
Operation readyAsyncWithHttpInfo
readyRequest()  : Request
Create request for operation 'ready'
readyWithHttpInfo()  : array<string|int, mixed>
Operation readyWithHttpInfo
setHostIndex()  : void
Set the host index
createHttpClientOption()  : array<string|int, mixed>
Create http client option
handleResponseWithDataType()  : array<string|int, mixed>
responseWithinRangeCode()  : bool

Constants

contentTypes

public array<string|int, string> contentTypes = ['getVersion' => ['application/json'], 'health' => ['application/json'], 'ready' => ['application/json']]

Properties

$hostIndex

protected int $hostIndex

Host index

Methods

__construct()

public __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ][, int $hostIndex = 0 ]) : mixed
Parameters
$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int = 0

(Optional) host index to select the list of hosts if defined in the OpenAPI spec

getHostIndex()

Get the host index

public getHostIndex() : int
Return values
int —

Host index

getVersion()

Operation getVersion

public getVersion([string $contentType = self::contentTypes['getVersion'][0] ]) : Version

The running server's own version

Parameters
$contentType : string = self::contentTypes['getVersion'][0]

The value for the Content-Type header. Check self::contentTypes['getVersion'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

InvalidArgumentException
Return values
Version

getVersionAsync()

Operation getVersionAsync

public getVersionAsync([string $contentType = self::contentTypes['getVersion'][0] ]) : PromiseInterface

The running server's own version

Parameters
$contentType : string = self::contentTypes['getVersion'][0]

The value for the Content-Type header. Check self::contentTypes['getVersion'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getVersionAsyncWithHttpInfo()

Operation getVersionAsyncWithHttpInfo

public getVersionAsyncWithHttpInfo([string $contentType = self::contentTypes['getVersion'][0] ]) : PromiseInterface

The running server's own version

Parameters
$contentType : string = self::contentTypes['getVersion'][0]

The value for the Content-Type header. Check self::contentTypes['getVersion'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getVersionRequest()

Create request for operation 'getVersion'

public getVersionRequest([string $contentType = self::contentTypes['getVersion'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['getVersion'][0]

The value for the Content-Type header. Check self::contentTypes['getVersion'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getVersionWithHttpInfo()

Operation getVersionWithHttpInfo

public getVersionWithHttpInfo([string $contentType = self::contentTypes['getVersion'][0] ]) : array<string|int, mixed>

The running server's own version

Parameters
$contentType : string = self::contentTypes['getVersion'][0]

The value for the Content-Type header. Check self::contentTypes['getVersion'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

InvalidArgumentException
Return values
array<string|int, mixed> —

of \ForgeDashboard\Generated\Model\Version, HTTP status code, HTTP response headers (array of strings)

health()

Operation health

public health([string $contentType = self::contentTypes['health'][0] ]) : Health

Liveness

Parameters
$contentType : string = self::contentTypes['health'][0]

The value for the Content-Type header. Check self::contentTypes['health'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

InvalidArgumentException
Return values
Health

healthAsync()

Operation healthAsync

public healthAsync([string $contentType = self::contentTypes['health'][0] ]) : PromiseInterface

Liveness

Parameters
$contentType : string = self::contentTypes['health'][0]

The value for the Content-Type header. Check self::contentTypes['health'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

healthAsyncWithHttpInfo()

Operation healthAsyncWithHttpInfo

public healthAsyncWithHttpInfo([string $contentType = self::contentTypes['health'][0] ]) : PromiseInterface

Liveness

Parameters
$contentType : string = self::contentTypes['health'][0]

The value for the Content-Type header. Check self::contentTypes['health'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

healthRequest()

Create request for operation 'health'

public healthRequest([string $contentType = self::contentTypes['health'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['health'][0]

The value for the Content-Type header. Check self::contentTypes['health'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

healthWithHttpInfo()

Operation healthWithHttpInfo

public healthWithHttpInfo([string $contentType = self::contentTypes['health'][0] ]) : array<string|int, mixed>

Liveness

Parameters
$contentType : string = self::contentTypes['health'][0]

The value for the Content-Type header. Check self::contentTypes['health'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

InvalidArgumentException
Return values
array<string|int, mixed> —

of \ForgeDashboard\Generated\Model\Health, HTTP status code, HTTP response headers (array of strings)

ready()

Operation ready

public ready([string $contentType = self::contentTypes['ready'][0] ]) : Health|Error

Readiness

Parameters
$contentType : string = self::contentTypes['ready'][0]

The value for the Content-Type header. Check self::contentTypes['ready'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

InvalidArgumentException
Return values
Health|Error

readyAsync()

Operation readyAsync

public readyAsync([string $contentType = self::contentTypes['ready'][0] ]) : PromiseInterface

Readiness

Parameters
$contentType : string = self::contentTypes['ready'][0]

The value for the Content-Type header. Check self::contentTypes['ready'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

readyAsyncWithHttpInfo()

Operation readyAsyncWithHttpInfo

public readyAsyncWithHttpInfo([string $contentType = self::contentTypes['ready'][0] ]) : PromiseInterface

Readiness

Parameters
$contentType : string = self::contentTypes['ready'][0]

The value for the Content-Type header. Check self::contentTypes['ready'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

readyRequest()

Create request for operation 'ready'

public readyRequest([string $contentType = self::contentTypes['ready'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['ready'][0]

The value for the Content-Type header. Check self::contentTypes['ready'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

readyWithHttpInfo()

Operation readyWithHttpInfo

public readyWithHttpInfo([string $contentType = self::contentTypes['ready'][0] ]) : array<string|int, mixed>

Readiness

Parameters
$contentType : string = self::contentTypes['ready'][0]

The value for the Content-Type header. Check self::contentTypes['ready'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

InvalidArgumentException
Return values
array<string|int, mixed> —

of \ForgeDashboard\Generated\Model\Health|\ForgeDashboard\Generated\Model\Error, HTTP status code, HTTP response headers (array of strings)

setHostIndex()

Set the host index

public setHostIndex(int $hostIndex) : void
Parameters
$hostIndex : int

Host index (required)

createHttpClientOption()

Create http client option

protected createHttpClientOption() : array<string|int, mixed>
Tags
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed> —

of http client options

handleResponseWithDataType()

private handleResponseWithDataType(string $dataType, RequestInterface $request, ResponseInterface $response) : array<string|int, mixed>
Parameters
$dataType : string
$request : RequestInterface
$response : ResponseInterface
Return values
array<string|int, mixed>

responseWithinRangeCode()

private responseWithinRangeCode(string $rangeCode, int $statusCode) : bool
Parameters
$rangeCode : string
$statusCode : int
Return values
bool
On this page

Search results