Class protos.google.cloud.servicehealth.v1.ServiceHealth (0.8.0)

Represents a ServiceHealth

Inheritance

$protobuf.rpc.Service > protos.google.cloud.servicehealth.v1.ServiceHealth

Package

@google-cloud/servicehealth

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new ServiceHealth service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): ServiceHealth;

Creates new ServiceHealth service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
ServiceHealth

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

getEvent(request, callback)

public getEvent(request: google.cloud.servicehealth.v1.IGetEventRequest, callback: google.cloud.servicehealth.v1.ServiceHealth.GetEventCallback): void;

Calls GetEvent.

Parameters
Name Description
request IGetEventRequest

GetEventRequest message or plain object
callback GetEventCallback

Node-style callback called with the error, if any, and Event
Returns
Type Description
void

getEvent(request)

public getEvent(request: google.cloud.servicehealth.v1.IGetEventRequest): Promise<google.cloud.servicehealth.v1.Event>;

Calls GetEvent.

Parameter
Name Description
request IGetEventRequest

GetEventRequest message or plain object
Returns
Type Description
Promise<google.cloud.servicehealth.v1.Event>

Promise

getOrganizationEvent(request, callback)

public getOrganizationEvent(request: google.cloud.servicehealth.v1.IGetOrganizationEventRequest, callback: google.cloud.servicehealth.v1.ServiceHealth.GetOrganizationEventCallback): void;

Calls GetOrganizationEvent.

Parameters
Name Description
request IGetOrganizationEventRequest

GetOrganizationEventRequest message or plain object
callback GetOrganizationEventCallback

Node-style callback called with the error, if any, and OrganizationEvent
Returns
Type Description
void

getOrganizationEvent(request)

public getOrganizationEvent(request: google.cloud.servicehealth.v1.IGetOrganizationEventRequest): Promise<google.cloud.servicehealth.v1.OrganizationEvent>;

Calls GetOrganizationEvent.

Parameter
Name Description
request IGetOrganizationEventRequest

GetOrganizationEventRequest message or plain object
Returns
Type Description
Promise<google.cloud.servicehealth.v1.OrganizationEvent>

Promise

getOrganizationImpact(request, callback)

public getOrganizationImpact(request: google.cloud.servicehealth.v1.IGetOrganizationImpactRequest, callback: google.cloud.servicehealth.v1.ServiceHealth.GetOrganizationImpactCallback): void;

Calls GetOrganizationImpact.

Parameters
Name Description
request IGetOrganizationImpactRequest

GetOrganizationImpactRequest message or plain object
callback GetOrganizationImpactCallback

Node-style callback called with the error, if any, and OrganizationImpact
Returns
Type Description
void

getOrganizationImpact(request)

public getOrganizationImpact(request: google.cloud.servicehealth.v1.IGetOrganizationImpactRequest): Promise<google.cloud.servicehealth.v1.OrganizationImpact>;

Calls GetOrganizationImpact.

Parameter
Name Description
request IGetOrganizationImpactRequest

GetOrganizationImpactRequest message or plain object
Returns
Type Description
Promise<google.cloud.servicehealth.v1.OrganizationImpact>

Promise

listEvents(request, callback)

public listEvents(request: google.cloud.servicehealth.v1.IListEventsRequest, callback: google.cloud.servicehealth.v1.ServiceHealth.ListEventsCallback): void;

Calls ListEvents.

Parameters
Name Description
request IListEventsRequest

ListEventsRequest message or plain object
callback ListEventsCallback

Node-style callback called with the error, if any, and ListEventsResponse
Returns
Type Description
void

listEvents(request)

public listEvents(request: google.cloud.servicehealth.v1.IListEventsRequest): Promise<google.cloud.servicehealth.v1.ListEventsResponse>;

Calls ListEvents.

Parameter
Name Description
request IListEventsRequest

ListEventsRequest message or plain object
Returns
Type Description
Promise<google.cloud.servicehealth.v1.ListEventsResponse>

Promise

listOrganizationEvents(request, callback)

public listOrganizationEvents(request: google.cloud.servicehealth.v1.IListOrganizationEventsRequest, callback: google.cloud.servicehealth.v1.ServiceHealth.ListOrganizationEventsCallback): void;

Calls ListOrganizationEvents.

Parameters
Name Description
request IListOrganizationEventsRequest

ListOrganizationEventsRequest message or plain object
callback ListOrganizationEventsCallback

Node-style callback called with the error, if any, and ListOrganizationEventsResponse
Returns
Type Description
void

listOrganizationEvents(request)

public listOrganizationEvents(request: google.cloud.servicehealth.v1.IListOrganizationEventsRequest): Promise<google.cloud.servicehealth.v1.ListOrganizationEventsResponse>;

Calls ListOrganizationEvents.

Parameter
Name Description
request IListOrganizationEventsRequest

ListOrganizationEventsRequest message or plain object
Returns
Type Description
Promise<google.cloud.servicehealth.v1.ListOrganizationEventsResponse>

Promise

listOrganizationImpacts(request, callback)

public listOrganizationImpacts(request: google.cloud.servicehealth.v1.IListOrganizationImpactsRequest, callback: google.cloud.servicehealth.v1.ServiceHealth.ListOrganizationImpactsCallback): void;

Calls ListOrganizationImpacts.

Parameters
Name Description
request IListOrganizationImpactsRequest

ListOrganizationImpactsRequest message or plain object
callback ListOrganizationImpactsCallback

Node-style callback called with the error, if any, and ListOrganizationImpactsResponse
Returns
Type Description
void

listOrganizationImpacts(request)

public listOrganizationImpacts(request: google.cloud.servicehealth.v1.IListOrganizationImpactsRequest): Promise<google.cloud.servicehealth.v1.ListOrganizationImpactsResponse>;

Calls ListOrganizationImpacts.

Parameter
Name Description
request IListOrganizationImpactsRequest

ListOrganizationImpactsRequest message or plain object
Returns
Type Description
Promise<google.cloud.servicehealth.v1.ListOrganizationImpactsResponse>

Promise