Class v1.EssentialContactsServiceClient (1.0.6)

Manages contacts for important Google Cloud notifications. v1

Package

@google-cloud/essential-contacts!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of EssentialContactsServiceClient.

Parameter

Name	Description
opts	`ClientOptions`

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value

Type	Description
string

auth

auth: gax.GoogleAuth;

Property Value

Type	Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;

Property Value

Type	Description
Descriptors

essentialContactsServiceStub

essentialContactsServiceStub?: Promise<{
        [name: string]: Function;
    }>;

Property Value

Type	Description
Promise<{ [name: string]: Function; }>

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

Property Value

Type	Description
{ [name: string]: Function; }

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

Property Value

Type	Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value

Type	Description
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value

Type	Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value

Type	Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;

Property Value

Type	Description
(code: string, message: string, warnType?: string) => void

Methods

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns

Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

computeContacts(request, options)

computeContacts(request?: protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.essentialcontacts.v1.IContact[],
        protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest | null,
        protos.google.cloud.essentialcontacts.v1.IComputeContactsResponse
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.essentialcontacts.v1.IContact[], protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest \| null, protos.google.cloud.essentialcontacts.v1.IComputeContactsResponse ]>

computeContacts(request, options, callback)

computeContacts(request: protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest, protos.google.cloud.essentialcontacts.v1.IComputeContactsResponse | null | undefined, protos.google.cloud.essentialcontacts.v1.IContact>): void;

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest, protos.google.cloud.essentialcontacts.v1.IComputeContactsResponse \| null \| undefined, protos.google.cloud.essentialcontacts.v1.IContact>`

Returns

Type	Description
void

computeContacts(request, callback)

computeContacts(request: protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest, callback: PaginationCallback<protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest, protos.google.cloud.essentialcontacts.v1.IComputeContactsResponse | null | undefined, protos.google.cloud.essentialcontacts.v1.IContact>): void;

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest`
callback	`PaginationCallback<protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest, protos.google.cloud.essentialcontacts.v1.IComputeContactsResponse \| null \| undefined, protos.google.cloud.essentialcontacts.v1.IContact>`

Returns

Type	Description
void

computeContactsAsync(request, options)

computeContactsAsync(request?: protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.essentialcontacts.v1.IContact>;

Equivalent to computeContacts, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.essentialcontacts.v1.IContact>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Contact]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

computeContactsStream(request, options)

computeContactsStream(request?: protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.IComputeContactsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing [Contact] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using computeContactsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

createContact(request, options)

createContact(request?: protos.google.cloud.essentialcontacts.v1.ICreateContactRequest, options?: CallOptions): Promise<[
        protos.google.cloud.essentialcontacts.v1.IContact,
        (protos.google.cloud.essentialcontacts.v1.ICreateContactRequest | undefined),
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.ICreateContactRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.essentialcontacts.v1.IContact, (protos.google.cloud.essentialcontacts.v1.ICreateContactRequest \| undefined), {} \| undefined ]>

createContact(request, options, callback)

createContact(request: protos.google.cloud.essentialcontacts.v1.ICreateContactRequest, options: CallOptions, callback: Callback<protos.google.cloud.essentialcontacts.v1.IContact, protos.google.cloud.essentialcontacts.v1.ICreateContactRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.ICreateContactRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.essentialcontacts.v1.IContact, protos.google.cloud.essentialcontacts.v1.ICreateContactRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createContact(request, callback)

createContact(request: protos.google.cloud.essentialcontacts.v1.ICreateContactRequest, callback: Callback<protos.google.cloud.essentialcontacts.v1.IContact, protos.google.cloud.essentialcontacts.v1.ICreateContactRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.ICreateContactRequest`
callback	`Callback<protos.google.cloud.essentialcontacts.v1.IContact, protos.google.cloud.essentialcontacts.v1.ICreateContactRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteContact(request, options)

deleteContact(request?: protos.google.cloud.essentialcontacts.v1.IDeleteContactRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.essentialcontacts.v1.IDeleteContactRequest | undefined),
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.IDeleteContactRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.essentialcontacts.v1.IDeleteContactRequest \| undefined), {} \| undefined ]>

deleteContact(request, options, callback)

deleteContact(request: protos.google.cloud.essentialcontacts.v1.IDeleteContactRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.essentialcontacts.v1.IDeleteContactRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.IDeleteContactRequest`
options	`CallOptions`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.essentialcontacts.v1.IDeleteContactRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteContact(request, callback)

deleteContact(request: protos.google.cloud.essentialcontacts.v1.IDeleteContactRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.essentialcontacts.v1.IDeleteContactRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.IDeleteContactRequest`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.essentialcontacts.v1.IDeleteContactRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

folderContactPath(folder, contact)

folderContactPath(folder: string, contact: string): string;

Return a fully-qualified folderContact resource name string.

Parameters

Name	Description
folder	`string`
contact	`string`

Returns

Type	Description
string	{string} Resource name string.

getContact(request, options)

getContact(request?: protos.google.cloud.essentialcontacts.v1.IGetContactRequest, options?: CallOptions): Promise<[
        protos.google.cloud.essentialcontacts.v1.IContact,
        protos.google.cloud.essentialcontacts.v1.IGetContactRequest | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.IGetContactRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.essentialcontacts.v1.IContact, protos.google.cloud.essentialcontacts.v1.IGetContactRequest \| undefined, {} \| undefined ]>

getContact(request, options, callback)

getContact(request: protos.google.cloud.essentialcontacts.v1.IGetContactRequest, options: CallOptions, callback: Callback<protos.google.cloud.essentialcontacts.v1.IContact, protos.google.cloud.essentialcontacts.v1.IGetContactRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.IGetContactRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.essentialcontacts.v1.IContact, protos.google.cloud.essentialcontacts.v1.IGetContactRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getContact(request, callback)

getContact(request: protos.google.cloud.essentialcontacts.v1.IGetContactRequest, callback: Callback<protos.google.cloud.essentialcontacts.v1.IContact, protos.google.cloud.essentialcontacts.v1.IGetContactRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.IGetContactRequest`
callback	`Callback<protos.google.cloud.essentialcontacts.v1.IContact, protos.google.cloud.essentialcontacts.v1.IGetContactRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter

Name	Description
callback	`Callback<string, undefined, undefined>`

Returns

Type	Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns

Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

listContacts(request, options)

listContacts(request?: protos.google.cloud.essentialcontacts.v1.IListContactsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.essentialcontacts.v1.IContact[],
        protos.google.cloud.essentialcontacts.v1.IListContactsRequest | null,
        protos.google.cloud.essentialcontacts.v1.IListContactsResponse
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.IListContactsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.essentialcontacts.v1.IContact[], protos.google.cloud.essentialcontacts.v1.IListContactsRequest \| null, protos.google.cloud.essentialcontacts.v1.IListContactsResponse ]>

listContacts(request, options, callback)

listContacts(request: protos.google.cloud.essentialcontacts.v1.IListContactsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.essentialcontacts.v1.IListContactsRequest, protos.google.cloud.essentialcontacts.v1.IListContactsResponse | null | undefined, protos.google.cloud.essentialcontacts.v1.IContact>): void;

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.IListContactsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.essentialcontacts.v1.IListContactsRequest, protos.google.cloud.essentialcontacts.v1.IListContactsResponse \| null \| undefined, protos.google.cloud.essentialcontacts.v1.IContact>`

Returns

Type	Description
void

listContacts(request, callback)

listContacts(request: protos.google.cloud.essentialcontacts.v1.IListContactsRequest, callback: PaginationCallback<protos.google.cloud.essentialcontacts.v1.IListContactsRequest, protos.google.cloud.essentialcontacts.v1.IListContactsResponse | null | undefined, protos.google.cloud.essentialcontacts.v1.IContact>): void;

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.IListContactsRequest`
callback	`PaginationCallback<protos.google.cloud.essentialcontacts.v1.IListContactsRequest, protos.google.cloud.essentialcontacts.v1.IListContactsResponse \| null \| undefined, protos.google.cloud.essentialcontacts.v1.IContact>`

Returns

Type	Description
void

listContactsAsync(request, options)

listContactsAsync(request?: protos.google.cloud.essentialcontacts.v1.IListContactsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.essentialcontacts.v1.IContact>;

Equivalent to listContacts, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.IListContactsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.essentialcontacts.v1.IContact>

listContactsStream(request, options)

listContactsStream(request?: protos.google.cloud.essentialcontacts.v1.IListContactsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.IListContactsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing [Contact] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listContactsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

matchContactFromFolderContactName(folderContactName)

matchContactFromFolderContactName(folderContactName: string): string | number;

Parse the contact from FolderContact resource.

Parameter

Name	Description
folderContactName	`string` A fully-qualified path representing folder_contact resource.

Returns

Type	Description
string \| number	{string} A string representing the contact.

matchContactFromOrganizationContactName(organizationContactName)

matchContactFromOrganizationContactName(organizationContactName: string): string | number;

Parse the contact from OrganizationContact resource.

Parameter

Name	Description
organizationContactName	`string` A fully-qualified path representing organization_contact resource.

Returns

Type	Description
string \| number	{string} A string representing the contact.

matchContactFromProjectContactName(projectContactName)

matchContactFromProjectContactName(projectContactName: string): string | number;

Parse the contact from ProjectContact resource.

Parameter

Name	Description
projectContactName	`string` A fully-qualified path representing project_contact resource.

Returns

Type	Description
string \| number	{string} A string representing the contact.

matchFolderFromFolderContactName(folderContactName)

matchFolderFromFolderContactName(folderContactName: string): string | number;

Parse the folder from FolderContact resource.

Parameter

Name	Description
folderContactName	`string` A fully-qualified path representing folder_contact resource.

Returns

Type	Description
string \| number	{string} A string representing the folder.

matchOrganizationFromOrganizationContactName(organizationContactName)

matchOrganizationFromOrganizationContactName(organizationContactName: string): string | number;

Parse the organization from OrganizationContact resource.

Parameter

Name	Description
organizationContactName	`string` A fully-qualified path representing organization_contact resource.

Returns

Type	Description
string \| number	{string} A string representing the organization.

matchProjectFromProjectContactName(projectContactName)

matchProjectFromProjectContactName(projectContactName: string): string | number;

Parse the project from ProjectContact resource.

Parameter

Name	Description
projectContactName	`string` A fully-qualified path representing project_contact resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter

Name	Description
projectName	`string` A fully-qualified path representing Project resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

organizationContactPath(organization, contact)

organizationContactPath(organization: string, contact: string): string;

Return a fully-qualified organizationContact resource name string.

Parameters

Name	Description
organization	`string`
contact	`string`

Returns

Type	Description
string	{string} Resource name string.

projectContactPath(project, contact)

projectContactPath(project: string, contact: string): string;

Return a fully-qualified projectContact resource name string.

Parameters

Name	Description
project	`string`
contact	`string`

Returns

Type	Description
string	{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter

Name	Description
project	`string`

Returns

Type	Description
string	{string} Resource name string.

sendTestMessage(request, options)

sendTestMessage(request?: protos.google.cloud.essentialcontacts.v1.ISendTestMessageRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.essentialcontacts.v1.ISendTestMessageRequest | undefined),
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.ISendTestMessageRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.essentialcontacts.v1.ISendTestMessageRequest \| undefined), {} \| undefined ]>

sendTestMessage(request, options, callback)

sendTestMessage(request: protos.google.cloud.essentialcontacts.v1.ISendTestMessageRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.essentialcontacts.v1.ISendTestMessageRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.ISendTestMessageRequest`
options	`CallOptions`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.essentialcontacts.v1.ISendTestMessageRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

sendTestMessage(request, callback)

sendTestMessage(request: protos.google.cloud.essentialcontacts.v1.ISendTestMessageRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.essentialcontacts.v1.ISendTestMessageRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.ISendTestMessageRequest`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.essentialcontacts.v1.ISendTestMessageRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateContact(request, options)

updateContact(request?: protos.google.cloud.essentialcontacts.v1.IUpdateContactRequest, options?: CallOptions): Promise<[
        protos.google.cloud.essentialcontacts.v1.IContact,
        (protos.google.cloud.essentialcontacts.v1.IUpdateContactRequest | undefined),
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.IUpdateContactRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.essentialcontacts.v1.IContact, (protos.google.cloud.essentialcontacts.v1.IUpdateContactRequest \| undefined), {} \| undefined ]>

updateContact(request, options, callback)

updateContact(request: protos.google.cloud.essentialcontacts.v1.IUpdateContactRequest, options: CallOptions, callback: Callback<protos.google.cloud.essentialcontacts.v1.IContact, protos.google.cloud.essentialcontacts.v1.IUpdateContactRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.IUpdateContactRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.essentialcontacts.v1.IContact, protos.google.cloud.essentialcontacts.v1.IUpdateContactRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateContact(request, callback)

updateContact(request: protos.google.cloud.essentialcontacts.v1.IUpdateContactRequest, callback: Callback<protos.google.cloud.essentialcontacts.v1.IContact, protos.google.cloud.essentialcontacts.v1.IUpdateContactRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.essentialcontacts.v1.IUpdateContactRequest`
callback	`Callback<protos.google.cloud.essentialcontacts.v1.IContact, protos.google.cloud.essentialcontacts.v1.IUpdateContactRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void