HealthChecks

google.cloud.compute.v1. HealthChecks

Represents a HealthChecks

Constructor

new HealthChecks(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new HealthChecks service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

aggregatedList(request, callback) → {undefined}

Calls AggregatedList.

Parameters:
Name Type Description
request google.cloud.compute.v1.IAggregatedListHealthChecksRequest

AggregatedListHealthChecksRequest message or plain object

callback google.cloud.compute.v1.HealthChecks.AggregatedListCallback

Node-style callback called with the error, if any, and HealthChecksAggregatedList

Returns:
Type Description
undefined

aggregatedList(request) → {Promise.<google.cloud.compute.v1.HealthChecksAggregatedList>}

Calls AggregatedList.

Parameters:
Name Type Description
request google.cloud.compute.v1.IAggregatedListHealthChecksRequest

AggregatedListHealthChecksRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.HealthChecksAggregatedList>

Promise

delete(request, callback) → {undefined}

Calls Delete.

Parameters:
Name Type Description
request google.cloud.compute.v1.IDeleteHealthCheckRequest

DeleteHealthCheckRequest message or plain object

callback google.cloud.compute.v1.HealthChecks.DeleteCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

delete(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls Delete.

Parameters:
Name Type Description
request google.cloud.compute.v1.IDeleteHealthCheckRequest

DeleteHealthCheckRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Operation>

Promise

get(request, callback) → {undefined}

Calls Get.

Parameters:
Name Type Description
request google.cloud.compute.v1.IGetHealthCheckRequest

GetHealthCheckRequest message or plain object

callback google.cloud.compute.v1.HealthChecks.GetCallback

Node-style callback called with the error, if any, and HealthCheck

Returns:
Type Description
undefined

get(request) → {Promise.<google.cloud.compute.v1.HealthCheck>}

Calls Get.

Parameters:
Name Type Description
request google.cloud.compute.v1.IGetHealthCheckRequest

GetHealthCheckRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.HealthCheck>

Promise

insert(request, callback) → {undefined}

Calls Insert.

Parameters:
Name Type Description
request google.cloud.compute.v1.IInsertHealthCheckRequest

InsertHealthCheckRequest message or plain object

callback google.cloud.compute.v1.HealthChecks.InsertCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

insert(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls Insert.

Parameters:
Name Type Description
request google.cloud.compute.v1.IInsertHealthCheckRequest

InsertHealthCheckRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Operation>

Promise

list(request, callback) → {undefined}

Calls List.

Parameters:
Name Type Description
request google.cloud.compute.v1.IListHealthChecksRequest

ListHealthChecksRequest message or plain object

callback google.cloud.compute.v1.HealthChecks.ListCallback

Node-style callback called with the error, if any, and HealthCheckList

Returns:
Type Description
undefined

list(request) → {Promise.<google.cloud.compute.v1.HealthCheckList>}

Calls List.

Parameters:
Name Type Description
request google.cloud.compute.v1.IListHealthChecksRequest

ListHealthChecksRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.HealthCheckList>

Promise

patch(request, callback) → {undefined}

Calls Patch.

Parameters:
Name Type Description
request google.cloud.compute.v1.IPatchHealthCheckRequest

PatchHealthCheckRequest message or plain object

callback google.cloud.compute.v1.HealthChecks.PatchCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

patch(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls Patch.

Parameters:
Name Type Description
request google.cloud.compute.v1.IPatchHealthCheckRequest

PatchHealthCheckRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Operation>

Promise

update(request, callback) → {undefined}

Calls Update.

Parameters:
Name Type Description
request google.cloud.compute.v1.IUpdateHealthCheckRequest

UpdateHealthCheckRequest message or plain object

callback google.cloud.compute.v1.HealthChecks.UpdateCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

update(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls Update.

Parameters:
Name Type Description
request google.cloud.compute.v1.IUpdateHealthCheckRequest

UpdateHealthCheckRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Operation>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {HealthChecks}

Creates new HealthChecks service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Returns:
Type Description
HealthChecks

RPC service. Useful where requests and/or responses are streamed.

Type Definitions

AggregatedListCallback(error, responseopt)

Callback as used by aggregatedList.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.HealthChecksAggregatedList <optional>

HealthChecksAggregatedList

DeleteCallback(error, responseopt)

Callback as used by delete_.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Operation <optional>

Operation

GetCallback(error, responseopt)

Callback as used by get.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.HealthCheck <optional>

HealthCheck

InsertCallback(error, responseopt)

Callback as used by insert.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Operation <optional>

Operation

ListCallback(error, responseopt)

Callback as used by list.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.HealthCheckList <optional>

HealthCheckList

PatchCallback(error, responseopt)

Callback as used by patch.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Operation <optional>

Operation

UpdateCallback(error, responseopt)

Callback as used by update.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Operation <optional>

Operation