Class protos.google.cloud.essentialcontacts.v1.EssentialContactsService (3.2.0)

Represents an EssentialContactsService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.essentialcontacts.v1.EssentialContactsService

Package

@google-cloud/essential-contacts

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new EssentialContactsService service.

Parameters
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Methods

computeContacts(request, callback)

public computeContacts(request: google.cloud.essentialcontacts.v1.IComputeContactsRequest, callback: google.cloud.essentialcontacts.v1.EssentialContactsService.ComputeContactsCallback): void;

Calls ComputeContacts.

Parameters
NameDescription
request IComputeContactsRequest

ComputeContactsRequest message or plain object

callback ComputeContactsCallback

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

Returns
TypeDescription
void

computeContacts(request)

public computeContacts(request: google.cloud.essentialcontacts.v1.IComputeContactsRequest): Promise<google.cloud.essentialcontacts.v1.ComputeContactsResponse>;

Calls ComputeContacts.

Parameter
NameDescription
request IComputeContactsRequest

ComputeContactsRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.essentialcontacts.v1.ComputeContactsResponse>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

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

Creates new EssentialContactsService service using the specified rpc implementation.

Parameters
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Returns
TypeDescription
EssentialContactsService

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

createContact(request, callback)

public createContact(request: google.cloud.essentialcontacts.v1.ICreateContactRequest, callback: google.cloud.essentialcontacts.v1.EssentialContactsService.CreateContactCallback): void;

Calls CreateContact.

Parameters
NameDescription
request ICreateContactRequest

CreateContactRequest message or plain object

callback CreateContactCallback

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

Returns
TypeDescription
void

createContact(request)

public createContact(request: google.cloud.essentialcontacts.v1.ICreateContactRequest): Promise<google.cloud.essentialcontacts.v1.Contact>;

Calls CreateContact.

Parameter
NameDescription
request ICreateContactRequest

CreateContactRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.essentialcontacts.v1.Contact>

Promise

deleteContact(request, callback)

public deleteContact(request: google.cloud.essentialcontacts.v1.IDeleteContactRequest, callback: google.cloud.essentialcontacts.v1.EssentialContactsService.DeleteContactCallback): void;

Calls DeleteContact.

Parameters
NameDescription
request IDeleteContactRequest

DeleteContactRequest message or plain object

callback DeleteContactCallback

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

Returns
TypeDescription
void

deleteContact(request)

public deleteContact(request: google.cloud.essentialcontacts.v1.IDeleteContactRequest): Promise<google.protobuf.Empty>;

Calls DeleteContact.

Parameter
NameDescription
request IDeleteContactRequest

DeleteContactRequest message or plain object

Returns
TypeDescription
Promise<google.protobuf.Empty>

Promise

getContact(request, callback)

public getContact(request: google.cloud.essentialcontacts.v1.IGetContactRequest, callback: google.cloud.essentialcontacts.v1.EssentialContactsService.GetContactCallback): void;

Calls GetContact.

Parameters
NameDescription
request IGetContactRequest

GetContactRequest message or plain object

callback GetContactCallback

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

Returns
TypeDescription
void

getContact(request)

public getContact(request: google.cloud.essentialcontacts.v1.IGetContactRequest): Promise<google.cloud.essentialcontacts.v1.Contact>;

Calls GetContact.

Parameter
NameDescription
request IGetContactRequest

GetContactRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.essentialcontacts.v1.Contact>

Promise

listContacts(request, callback)

public listContacts(request: google.cloud.essentialcontacts.v1.IListContactsRequest, callback: google.cloud.essentialcontacts.v1.EssentialContactsService.ListContactsCallback): void;

Calls ListContacts.

Parameters
NameDescription
request IListContactsRequest

ListContactsRequest message or plain object

callback ListContactsCallback

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

Returns
TypeDescription
void

listContacts(request)

public listContacts(request: google.cloud.essentialcontacts.v1.IListContactsRequest): Promise<google.cloud.essentialcontacts.v1.ListContactsResponse>;

Calls ListContacts.

Parameter
NameDescription
request IListContactsRequest

ListContactsRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.essentialcontacts.v1.ListContactsResponse>

Promise

sendTestMessage(request, callback)

public sendTestMessage(request: google.cloud.essentialcontacts.v1.ISendTestMessageRequest, callback: google.cloud.essentialcontacts.v1.EssentialContactsService.SendTestMessageCallback): void;

Calls SendTestMessage.

Parameters
NameDescription
request ISendTestMessageRequest

SendTestMessageRequest message or plain object

callback SendTestMessageCallback

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

Returns
TypeDescription
void

sendTestMessage(request)

public sendTestMessage(request: google.cloud.essentialcontacts.v1.ISendTestMessageRequest): Promise<google.protobuf.Empty>;

Calls SendTestMessage.

Parameter
NameDescription
request ISendTestMessageRequest

SendTestMessageRequest message or plain object

Returns
TypeDescription
Promise<google.protobuf.Empty>

Promise

updateContact(request, callback)

public updateContact(request: google.cloud.essentialcontacts.v1.IUpdateContactRequest, callback: google.cloud.essentialcontacts.v1.EssentialContactsService.UpdateContactCallback): void;

Calls UpdateContact.

Parameters
NameDescription
request IUpdateContactRequest

UpdateContactRequest message or plain object

callback UpdateContactCallback

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

Returns
TypeDescription
void

updateContact(request)

public updateContact(request: google.cloud.essentialcontacts.v1.IUpdateContactRequest): Promise<google.cloud.essentialcontacts.v1.Contact>;

Calls UpdateContact.

Parameter
NameDescription
request IUpdateContactRequest

UpdateContactRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.essentialcontacts.v1.Contact>

Promise