Essential Contacts v1 API - Class EssentialContactsServiceClientImpl (2.5.0)

Version latest

• 2.5.0 (latest)
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.1.0
• 1.0.0

public sealed class EssentialContactsServiceClientImpl : EssentialContactsServiceClient

Reference documentation and code samples for the Essential Contacts v1 API class EssentialContactsServiceClientImpl.

EssentialContactsService client wrapper implementation, for convenient use.

Inheritance

object > EssentialContactsServiceClient > EssentialContactsServiceClientImpl

Inherited Members

EssentialContactsServiceClient.DefaultEndpoint

EssentialContactsServiceClient.DefaultScopes

EssentialContactsServiceClient.ServiceMetadata

EssentialContactsServiceClient.CreateAsync(CancellationToken)

EssentialContactsServiceClient.Create()

EssentialContactsServiceClient.ShutdownDefaultChannelsAsync()

EssentialContactsServiceClient.CreateContactAsync(CreateContactRequest, CancellationToken)

EssentialContactsServiceClient.CreateContact(string, Contact, CallSettings)

EssentialContactsServiceClient.CreateContactAsync(string, Contact, CallSettings)

EssentialContactsServiceClient.CreateContactAsync(string, Contact, CancellationToken)

EssentialContactsServiceClient.CreateContact(ProjectName, Contact, CallSettings)

EssentialContactsServiceClient.CreateContactAsync(ProjectName, Contact, CallSettings)

EssentialContactsServiceClient.CreateContactAsync(ProjectName, Contact, CancellationToken)

EssentialContactsServiceClient.CreateContact(FolderName, Contact, CallSettings)

EssentialContactsServiceClient.CreateContactAsync(FolderName, Contact, CallSettings)

EssentialContactsServiceClient.CreateContactAsync(FolderName, Contact, CancellationToken)

EssentialContactsServiceClient.CreateContact(OrganizationName, Contact, CallSettings)

EssentialContactsServiceClient.CreateContactAsync(OrganizationName, Contact, CallSettings)

EssentialContactsServiceClient.CreateContactAsync(OrganizationName, Contact, CancellationToken)

EssentialContactsServiceClient.UpdateContactAsync(UpdateContactRequest, CancellationToken)

EssentialContactsServiceClient.UpdateContact(Contact, FieldMask, CallSettings)

EssentialContactsServiceClient.UpdateContactAsync(Contact, FieldMask, CallSettings)

EssentialContactsServiceClient.UpdateContactAsync(Contact, FieldMask, CancellationToken)

EssentialContactsServiceClient.ListContacts(string, string, int?, CallSettings)

EssentialContactsServiceClient.ListContactsAsync(string, string, int?, CallSettings)

EssentialContactsServiceClient.ListContacts(ProjectName, string, int?, CallSettings)

EssentialContactsServiceClient.ListContactsAsync(ProjectName, string, int?, CallSettings)

EssentialContactsServiceClient.ListContacts(FolderName, string, int?, CallSettings)

EssentialContactsServiceClient.ListContactsAsync(FolderName, string, int?, CallSettings)

EssentialContactsServiceClient.ListContacts(OrganizationName, string, int?, CallSettings)

EssentialContactsServiceClient.ListContactsAsync(OrganizationName, string, int?, CallSettings)

EssentialContactsServiceClient.GetContactAsync(GetContactRequest, CancellationToken)

EssentialContactsServiceClient.GetContact(string, CallSettings)

EssentialContactsServiceClient.GetContactAsync(string, CallSettings)

EssentialContactsServiceClient.GetContactAsync(string, CancellationToken)

EssentialContactsServiceClient.GetContact(ContactName, CallSettings)

EssentialContactsServiceClient.GetContactAsync(ContactName, CallSettings)

EssentialContactsServiceClient.GetContactAsync(ContactName, CancellationToken)

EssentialContactsServiceClient.DeleteContactAsync(DeleteContactRequest, CancellationToken)

EssentialContactsServiceClient.DeleteContact(string, CallSettings)

EssentialContactsServiceClient.DeleteContactAsync(string, CallSettings)

EssentialContactsServiceClient.DeleteContactAsync(string, CancellationToken)

EssentialContactsServiceClient.DeleteContact(ContactName, CallSettings)

EssentialContactsServiceClient.DeleteContactAsync(ContactName, CallSettings)

EssentialContactsServiceClient.DeleteContactAsync(ContactName, CancellationToken)

EssentialContactsServiceClient.SendTestMessageAsync(SendTestMessageRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.EssentialContacts.V1

Assembly

Google.Cloud.EssentialContacts.V1.dll

Remarks

Manages contacts for important Google Cloud notifications.

Constructors

EssentialContactsServiceClientImpl(EssentialContactsServiceClient, EssentialContactsServiceSettings, ILogger)

public EssentialContactsServiceClientImpl(EssentialContactsService.EssentialContactsServiceClient grpcClient, EssentialContactsServiceSettings settings, ILogger logger)

Constructs a client wrapper for the EssentialContactsService service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	EssentialContactsServiceEssentialContactsServiceClient The underlying gRPC client.
settings	EssentialContactsServiceSettings The base EssentialContactsServiceSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override EssentialContactsService.EssentialContactsServiceClient GrpcClient { get; }

The underlying gRPC EssentialContactsService client

Property Value
Type	Description
EssentialContactsServiceEssentialContactsServiceClient

Overrides

EssentialContactsServiceClient.GrpcClient

Methods

ComputeContacts(ComputeContactsRequest, CallSettings)

public override PagedEnumerable<ComputeContactsResponse, Contact> ComputeContacts(ComputeContactsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ComputeContactsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableComputeContactsResponseContact	A pageable sequence of Contact resources.

Overrides

EssentialContactsServiceClient.ComputeContacts(ComputeContactsRequest, CallSettings)

ComputeContactsAsync(ComputeContactsRequest, CallSettings)

public override PagedAsyncEnumerable<ComputeContactsResponse, Contact> ComputeContactsAsync(ComputeContactsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ComputeContactsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableComputeContactsResponseContact	A pageable asynchronous sequence of Contact resources.

Overrides

EssentialContactsServiceClient.ComputeContactsAsync(ComputeContactsRequest, CallSettings)

CreateContact(CreateContactRequest, CallSettings)

public override Contact CreateContact(CreateContactRequest request, CallSettings callSettings = null)

Adds a new contact for a resource.

Parameters
Name	Description
request	CreateContactRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Contact	The RPC response.

Overrides

EssentialContactsServiceClient.CreateContact(CreateContactRequest, CallSettings)

CreateContactAsync(CreateContactRequest, CallSettings)

public override Task<Contact> CreateContactAsync(CreateContactRequest request, CallSettings callSettings = null)

Adds a new contact for a resource.

Parameters
Name	Description
request	CreateContactRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskContact	A Task containing the RPC response.

Overrides

EssentialContactsServiceClient.CreateContactAsync(CreateContactRequest, CallSettings)

DeleteContact(DeleteContactRequest, CallSettings)

public override void DeleteContact(DeleteContactRequest request, CallSettings callSettings = null)

Deletes a contact.

Parameters
Name	Description
request	DeleteContactRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Overrides

EssentialContactsServiceClient.DeleteContact(DeleteContactRequest, CallSettings)

DeleteContactAsync(DeleteContactRequest, CallSettings)

public override Task DeleteContactAsync(DeleteContactRequest request, CallSettings callSettings = null)

Deletes a contact.

Parameters
Name	Description
request	DeleteContactRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Overrides

EssentialContactsServiceClient.DeleteContactAsync(DeleteContactRequest, CallSettings)

GetContact(GetContactRequest, CallSettings)

public override Contact GetContact(GetContactRequest request, CallSettings callSettings = null)

Gets a single contact.

Parameters
Name	Description
request	GetContactRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Contact	The RPC response.

Overrides

EssentialContactsServiceClient.GetContact(GetContactRequest, CallSettings)

GetContactAsync(GetContactRequest, CallSettings)

public override Task<Contact> GetContactAsync(GetContactRequest request, CallSettings callSettings = null)

Gets a single contact.

Parameters
Name	Description
request	GetContactRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskContact	A Task containing the RPC response.

Overrides

EssentialContactsServiceClient.GetContactAsync(GetContactRequest, CallSettings)

ListContacts(ListContactsRequest, CallSettings)

public override PagedEnumerable<ListContactsResponse, Contact> ListContacts(ListContactsRequest request, CallSettings callSettings = null)

Lists the contacts that have been set on a resource.

Parameters
Name	Description
request	ListContactsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListContactsResponseContact	A pageable sequence of Contact resources.

Overrides

EssentialContactsServiceClient.ListContacts(ListContactsRequest, CallSettings)

ListContactsAsync(ListContactsRequest, CallSettings)

public override PagedAsyncEnumerable<ListContactsResponse, Contact> ListContactsAsync(ListContactsRequest request, CallSettings callSettings = null)

Lists the contacts that have been set on a resource.

Parameters
Name	Description
request	ListContactsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListContactsResponseContact	A pageable asynchronous sequence of Contact resources.

Overrides

EssentialContactsServiceClient.ListContactsAsync(ListContactsRequest, CallSettings)

SendTestMessage(SendTestMessageRequest, CallSettings)

public override void SendTestMessage(SendTestMessageRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	SendTestMessageRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Overrides

EssentialContactsServiceClient.SendTestMessage(SendTestMessageRequest, CallSettings)

SendTestMessageAsync(SendTestMessageRequest, CallSettings)

public override Task SendTestMessageAsync(SendTestMessageRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	SendTestMessageRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Overrides

EssentialContactsServiceClient.SendTestMessageAsync(SendTestMessageRequest, CallSettings)

UpdateContact(UpdateContactRequest, CallSettings)

public override Contact UpdateContact(UpdateContactRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	UpdateContactRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Contact	The RPC response.

Overrides

EssentialContactsServiceClient.UpdateContact(UpdateContactRequest, CallSettings)

UpdateContactAsync(UpdateContactRequest, CallSettings)

public override Task<Contact> UpdateContactAsync(UpdateContactRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	UpdateContactRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskContact	A Task containing the RPC response.

Overrides

EssentialContactsServiceClient.UpdateContactAsync(UpdateContactRequest, CallSettings)