ServiceHealth

google.cloud.servicehealth.v1. ServiceHealth

Represents a ServiceHealth

Constructor

new ServiceHealth(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new ServiceHealth 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

getEvent(request, callback) → {undefined}

Calls GetEvent.

Parameters:
Name Type Description
request google.cloud.servicehealth.v1.IGetEventRequest

GetEventRequest message or plain object

callback google.cloud.servicehealth.v1.ServiceHealth.GetEventCallback

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

Returns:
Type Description
undefined

getEvent(request) → {Promise.<google.cloud.servicehealth.v1.Event>}

Calls GetEvent.

Parameters:
Name Type Description
request google.cloud.servicehealth.v1.IGetEventRequest

GetEventRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.servicehealth.v1.Event>

Promise

getOrganizationEvent(request, callback) → {undefined}

Calls GetOrganizationEvent.

Parameters:
Name Type Description
request google.cloud.servicehealth.v1.IGetOrganizationEventRequest

GetOrganizationEventRequest message or plain object

callback google.cloud.servicehealth.v1.ServiceHealth.GetOrganizationEventCallback

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

Returns:
Type Description
undefined

getOrganizationEvent(request) → {Promise.<google.cloud.servicehealth.v1.OrganizationEvent>}

Calls GetOrganizationEvent.

Parameters:
Name Type Description
request google.cloud.servicehealth.v1.IGetOrganizationEventRequest

GetOrganizationEventRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.servicehealth.v1.OrganizationEvent>

Promise

getOrganizationImpact(request, callback) → {undefined}

Calls GetOrganizationImpact.

Parameters:
Name Type Description
request google.cloud.servicehealth.v1.IGetOrganizationImpactRequest

GetOrganizationImpactRequest message or plain object

callback google.cloud.servicehealth.v1.ServiceHealth.GetOrganizationImpactCallback

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

Returns:
Type Description
undefined

getOrganizationImpact(request) → {Promise.<google.cloud.servicehealth.v1.OrganizationImpact>}

Calls GetOrganizationImpact.

Parameters:
Name Type Description
request google.cloud.servicehealth.v1.IGetOrganizationImpactRequest

GetOrganizationImpactRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.servicehealth.v1.OrganizationImpact>

Promise

listEvents(request, callback) → {undefined}

Calls ListEvents.

Parameters:
Name Type Description
request google.cloud.servicehealth.v1.IListEventsRequest

ListEventsRequest message or plain object

callback google.cloud.servicehealth.v1.ServiceHealth.ListEventsCallback

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

Returns:
Type Description
undefined

listEvents(request) → {Promise.<google.cloud.servicehealth.v1.ListEventsResponse>}

Calls ListEvents.

Parameters:
Name Type Description
request google.cloud.servicehealth.v1.IListEventsRequest

ListEventsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.servicehealth.v1.ListEventsResponse>

Promise

listOrganizationEvents(request, callback) → {undefined}

Calls ListOrganizationEvents.

Parameters:
Name Type Description
request google.cloud.servicehealth.v1.IListOrganizationEventsRequest

ListOrganizationEventsRequest message or plain object

callback google.cloud.servicehealth.v1.ServiceHealth.ListOrganizationEventsCallback

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

Returns:
Type Description
undefined

listOrganizationEvents(request) → {Promise.<google.cloud.servicehealth.v1.ListOrganizationEventsResponse>}

Calls ListOrganizationEvents.

Parameters:
Name Type Description
request google.cloud.servicehealth.v1.IListOrganizationEventsRequest

ListOrganizationEventsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.servicehealth.v1.ListOrganizationEventsResponse>

Promise

listOrganizationImpacts(request, callback) → {undefined}

Calls ListOrganizationImpacts.

Parameters:
Name Type Description
request google.cloud.servicehealth.v1.IListOrganizationImpactsRequest

ListOrganizationImpactsRequest message or plain object

callback google.cloud.servicehealth.v1.ServiceHealth.ListOrganizationImpactsCallback

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

Returns:
Type Description
undefined

listOrganizationImpacts(request) → {Promise.<google.cloud.servicehealth.v1.ListOrganizationImpactsResponse>}

Calls ListOrganizationImpacts.

Parameters:
Name Type Description
request google.cloud.servicehealth.v1.IListOrganizationImpactsRequest

ListOrganizationImpactsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.servicehealth.v1.ListOrganizationImpactsResponse>

Promise

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

Creates new ServiceHealth 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
ServiceHealth

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

Type Definitions

GetEventCallback(error, responseopt)

Callback as used by getEvent.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.servicehealth.v1.Event <optional>

Event

GetOrganizationEventCallback(error, responseopt)

Callback as used by getOrganizationEvent.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.servicehealth.v1.OrganizationEvent <optional>

OrganizationEvent

GetOrganizationImpactCallback(error, responseopt)

Callback as used by getOrganizationImpact.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.servicehealth.v1.OrganizationImpact <optional>

OrganizationImpact

ListEventsCallback(error, responseopt)

Callback as used by listEvents.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.servicehealth.v1.ListEventsResponse <optional>

ListEventsResponse

ListOrganizationEventsCallback(error, responseopt)

Callback as used by listOrganizationEvents.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.servicehealth.v1.ListOrganizationEventsResponse <optional>

ListOrganizationEventsResponse

ListOrganizationImpactsCallback(error, responseopt)

Callback as used by listOrganizationImpacts.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.servicehealth.v1.ListOrganizationImpactsResponse <optional>

ListOrganizationImpactsResponse