EssentialContacts

import { EssentialContacts } from "https://googleapis.deno.dev/v1/essentialcontacts:v1.ts";

class EssentialContacts {

constructor(client?: CredentialsClient, baseUrl?: string);

async foldersContactsCompute(parent: string, opts?: FoldersContactsComputeOptions): Promise<GoogleCloudEssentialcontactsV1ComputeContactsResponse>;

async foldersContactsCreate(parent: string, req: GoogleCloudEssentialcontactsV1Contact): Promise<GoogleCloudEssentialcontactsV1Contact>;

async foldersContactsDelete(name: string): Promise<GoogleProtobufEmpty>;

async foldersContactsGet(name: string): Promise<GoogleCloudEssentialcontactsV1Contact>;

async foldersContactsList(parent: string, opts?: FoldersContactsListOptions): Promise<GoogleCloudEssentialcontactsV1ListContactsResponse>;

async foldersContactsPatch(

req: GoogleCloudEssentialcontactsV1Contact,

opts?: FoldersContactsPatchOptions,

): Promise<GoogleCloudEssentialcontactsV1Contact>;

async foldersContactsSendTestMessage(resource: string, req: GoogleCloudEssentialcontactsV1SendTestMessageRequest): Promise<GoogleProtobufEmpty>;

async organizationsContactsCompute(parent: string, opts?: OrganizationsContactsComputeOptions): Promise<GoogleCloudEssentialcontactsV1ComputeContactsResponse>;

async organizationsContactsCreate(parent: string, req: GoogleCloudEssentialcontactsV1Contact): Promise<GoogleCloudEssentialcontactsV1Contact>;

async organizationsContactsDelete(name: string): Promise<GoogleProtobufEmpty>;

async organizationsContactsGet(name: string): Promise<GoogleCloudEssentialcontactsV1Contact>;

async organizationsContactsList(parent: string, opts?: OrganizationsContactsListOptions): Promise<GoogleCloudEssentialcontactsV1ListContactsResponse>;

async organizationsContactsPatch(

req: GoogleCloudEssentialcontactsV1Contact,

opts?: OrganizationsContactsPatchOptions,

): Promise<GoogleCloudEssentialcontactsV1Contact>;

async organizationsContactsSendTestMessage(resource: string, req: GoogleCloudEssentialcontactsV1SendTestMessageRequest): Promise<GoogleProtobufEmpty>;

async projectsContactsCompute(parent: string, opts?: ProjectsContactsComputeOptions): Promise<GoogleCloudEssentialcontactsV1ComputeContactsResponse>;

async projectsContactsCreate(parent: string, req: GoogleCloudEssentialcontactsV1Contact): Promise<GoogleCloudEssentialcontactsV1Contact>;

async projectsContactsDelete(name: string): Promise<GoogleProtobufEmpty>;

async projectsContactsGet(name: string): Promise<GoogleCloudEssentialcontactsV1Contact>;

async projectsContactsList(parent: string, opts?: ProjectsContactsListOptions): Promise<GoogleCloudEssentialcontactsV1ListContactsResponse>;

async projectsContactsPatch(

req: GoogleCloudEssentialcontactsV1Contact,

opts?: ProjectsContactsPatchOptions,

): Promise<GoogleCloudEssentialcontactsV1Contact>;

async projectsContactsSendTestMessage(resource: string, req: GoogleCloudEssentialcontactsV1SendTestMessageRequest): Promise<GoogleProtobufEmpty>;

}

§Constructors

new EssentialContacts(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

foldersContactsCompute(parent: string, opts?: FoldersContactsComputeOptions): Promise<GoogleCloudEssentialcontactsV1ComputeContactsResponse>

[src]

Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.

@param parent

Required. The name of the resource to compute contacts for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}

foldersContactsCreate(parent: string, req: GoogleCloudEssentialcontactsV1Contact): Promise<GoogleCloudEssentialcontactsV1Contact>

[src]

Adds a new contact for a resource.

@param parent

Required. The resource to save this contact for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}

foldersContactsDelete(name: string): Promise<GoogleProtobufEmpty>

[src]

Deletes a contact.

@param name

Required. The name of the contact to delete. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}

foldersContactsGet(name: string): Promise<GoogleCloudEssentialcontactsV1Contact>

[src]

Gets a single contact.

@param name

Required. The name of the contact to retrieve. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}

foldersContactsList(parent: string, opts?: FoldersContactsListOptions): Promise<GoogleCloudEssentialcontactsV1ListContactsResponse>

[src]

Lists the contacts that have been set on a resource.

@param parent

Required. The parent resource name. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}

foldersContactsPatch(name: string, req: GoogleCloudEssentialcontactsV1Contact, opts?: FoldersContactsPatchOptions): Promise<GoogleCloudEssentialcontactsV1Contact>

[src]

Updates a contact. Note: A contact's email address cannot be changed.

@param name

Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}

foldersContactsSendTestMessage(resource: string, req: GoogleCloudEssentialcontactsV1SendTestMessageRequest): Promise<GoogleProtobufEmpty>

[src]

Allows a contact admin to send a test message to contact to verify that it has been configured correctly.

@param resource

Required. The name of the resource to send the test message for. All contacts must either be set directly on this resource or inherited from another resource that is an ancestor of this one. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}

organizationsContactsCompute(parent: string, opts?: OrganizationsContactsComputeOptions): Promise<GoogleCloudEssentialcontactsV1ComputeContactsResponse>

[src]

Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.

@param parent

Required. The name of the resource to compute contacts for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}

organizationsContactsCreate(parent: string, req: GoogleCloudEssentialcontactsV1Contact): Promise<GoogleCloudEssentialcontactsV1Contact>

[src]

Adds a new contact for a resource.

@param parent

Required. The resource to save this contact for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}

organizationsContactsDelete(name: string): Promise<GoogleProtobufEmpty>

[src]

Deletes a contact.

@param name

Required. The name of the contact to delete. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}

organizationsContactsGet(name: string): Promise<GoogleCloudEssentialcontactsV1Contact>

[src]

Gets a single contact.

@param name

Required. The name of the contact to retrieve. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}

organizationsContactsList(parent: string, opts?: OrganizationsContactsListOptions): Promise<GoogleCloudEssentialcontactsV1ListContactsResponse>

[src]

Lists the contacts that have been set on a resource.

@param parent

Required. The parent resource name. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}

organizationsContactsPatch(name: string, req: GoogleCloudEssentialcontactsV1Contact, opts?: OrganizationsContactsPatchOptions): Promise<GoogleCloudEssentialcontactsV1Contact>

[src]

Updates a contact. Note: A contact's email address cannot be changed.

@param name

Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}

organizationsContactsSendTestMessage(resource: string, req: GoogleCloudEssentialcontactsV1SendTestMessageRequest): Promise<GoogleProtobufEmpty>

[src]

Allows a contact admin to send a test message to contact to verify that it has been configured correctly.

@param resource

projectsContactsCompute(parent: string, opts?: ProjectsContactsComputeOptions): Promise<GoogleCloudEssentialcontactsV1ComputeContactsResponse>

[src]

Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.

@param parent

Required. The name of the resource to compute contacts for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}

projectsContactsCreate(parent: string, req: GoogleCloudEssentialcontactsV1Contact): Promise<GoogleCloudEssentialcontactsV1Contact>

[src]

Adds a new contact for a resource.

@param parent

Required. The resource to save this contact for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}

projectsContactsDelete(name: string): Promise<GoogleProtobufEmpty>

[src]

Deletes a contact.

@param name

Required. The name of the contact to delete. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}

projectsContactsGet(name: string): Promise<GoogleCloudEssentialcontactsV1Contact>

[src]

Gets a single contact.

@param name

Required. The name of the contact to retrieve. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}

projectsContactsList(parent: string, opts?: ProjectsContactsListOptions): Promise<GoogleCloudEssentialcontactsV1ListContactsResponse>

[src]

Lists the contacts that have been set on a resource.

@param parent

Required. The parent resource name. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}

projectsContactsPatch(name: string, req: GoogleCloudEssentialcontactsV1Contact, opts?: ProjectsContactsPatchOptions): Promise<GoogleCloudEssentialcontactsV1Contact>

[src]

Updates a contact. Note: A contact's email address cannot be changed.

@param name

Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}

projectsContactsSendTestMessage(resource: string, req: GoogleCloudEssentialcontactsV1SendTestMessageRequest): Promise<GoogleProtobufEmpty>

[src]

Allows a contact admin to send a test message to contact to verify that it has been configured correctly.

@param resource