Skip to main content

Class: HealthCheckResponse

health.v1.HealthCheckResponse

Represents a HealthCheckResponse.

Implements

Constructors

constructor

new HealthCheckResponse(properties?): HealthCheckResponse

Constructs a new HealthCheckResponse.

Parameters

NameTypeDescription
properties?IHealthCheckResponseProperties to set

Returns

HealthCheckResponse

Properties

status

status: ServingStatus

HealthCheckResponse status.

Implementation of

IHealthCheckResponse.status

Methods

toJSON

toJSON(): Object

Converts this HealthCheckResponse to JSON.

Returns

Object

JSON object


create

create(properties?): HealthCheckResponse

Creates a new HealthCheckResponse instance using the specified properties.

Parameters

NameTypeDescription
properties?IHealthCheckResponseProperties to set

Returns

HealthCheckResponse

HealthCheckResponse instance


decode

decode(reader, length?): HealthCheckResponse

Decodes a HealthCheckResponse message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

HealthCheckResponse

HealthCheckResponse

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): HealthCheckResponse

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

HealthCheckResponse

HealthCheckResponse

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIHealthCheckResponseHealthCheckResponse message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIHealthCheckResponseHealthCheckResponse message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): HealthCheckResponse

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

HealthCheckResponse

HealthCheckResponse


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for HealthCheckResponse

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageHealthCheckResponseHealthCheckResponse
options?IConversionOptionsConversion options

Returns

Object

Plain object