Skip to main content

Class: HealthCheckResponse

Represents a HealthCheckResponse.

Properties​

status​

status: ServingStatus

HealthCheckResponse status.

Methods​

toJSON()​

toJSON(): object

Converts this HealthCheckResponse to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): HealthCheckResponse & $Properties

Creates a new HealthCheckResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

HealthCheckResponse & $Properties

HealthCheckResponse instance

Call Signature​

static create(properties?): HealthCheckResponse

Creates a new HealthCheckResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

HealthCheckResponse

HealthCheckResponse instance

decode()​

static decode(reader, length?): HealthCheckResponse & $Properties

Decodes a HealthCheckResponse message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

HealthCheckResponse & $Properties

HealthCheckResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): HealthCheckResponse & $Properties

Decodes a HealthCheckResponse message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

HealthCheckResponse & $Properties

HealthCheckResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified HealthCheckResponse message. Does not implicitly grpc.health.v1.HealthCheckResponse.verify|verify messages.

Parameters​

message​

$Properties

HealthCheckResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified HealthCheckResponse message, length delimited. Does not implicitly grpc.health.v1.HealthCheckResponse.verify|verify messages.

Parameters​

message​

$Properties

HealthCheckResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): HealthCheckResponse

Creates a HealthCheckResponse message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

HealthCheckResponse

HealthCheckResponse

toObject()​

static toObject(message, options?): object

Creates a plain object from a HealthCheckResponse message. Also converts values to other types if specified.

Parameters​

message​

HealthCheckResponse

HealthCheckResponse

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object