public sealed class EssentialContactsServiceClientImpl : EssentialContactsServiceClientReference documentation and code samples for the Essential Contacts v1 API class EssentialContactsServiceClientImpl.
EssentialContactsService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.EssentialContacts.V1Assembly
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 | EssentialContactsServiceEssentialContactsServiceClientThe underlying gRPC client. |
settings | EssentialContactsServiceSettingsThe base EssentialContactsServiceSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
GrpcClient
public override EssentialContactsService.EssentialContactsServiceClient GrpcClient { get; }The underlying gRPC EssentialContactsService client
| Property Value | |
|---|---|
| Type | Description |
EssentialContactsServiceEssentialContactsServiceClient | |
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 | ComputeContactsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableComputeContactsResponseContact | A pageable sequence of Contact resources. |
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 | ComputeContactsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableComputeContactsResponseContact | A pageable asynchronous sequence of Contact resources. |
CreateContact(CreateContactRequest, CallSettings)
public override Contact CreateContact(CreateContactRequest request, CallSettings callSettings = null)Adds a new contact for a resource.
| Parameters | |
|---|---|
| Name | Description |
request | CreateContactRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Contact | The RPC response. |
CreateContactAsync(CreateContactRequest, CallSettings)
public override Task<Contact> CreateContactAsync(CreateContactRequest request, CallSettings callSettings = null)Adds a new contact for a resource.
| Parameters | |
|---|---|
| Name | Description |
request | CreateContactRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskContact | A Task containing the RPC response. |
DeleteContact(DeleteContactRequest, CallSettings)
public override void DeleteContact(DeleteContactRequest request, CallSettings callSettings = null)Deletes a contact.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteContactRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteContactAsync(DeleteContactRequest, CallSettings)
public override Task DeleteContactAsync(DeleteContactRequest request, CallSettings callSettings = null)Deletes a contact.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteContactRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
GetContact(GetContactRequest, CallSettings)
public override Contact GetContact(GetContactRequest request, CallSettings callSettings = null)Gets a single contact.
| Parameters | |
|---|---|
| Name | Description |
request | GetContactRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Contact | The RPC response. |
GetContactAsync(GetContactRequest, CallSettings)
public override Task<Contact> GetContactAsync(GetContactRequest request, CallSettings callSettings = null)Gets a single contact.
| Parameters | |
|---|---|
| Name | Description |
request | GetContactRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskContact | A Task containing the RPC response. |
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 | ListContactsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListContactsResponseContact | A pageable sequence of Contact resources. |
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 | ListContactsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListContactsResponseContact | A pageable asynchronous sequence of Contact resources. |
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 | SendTestMessageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
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 | SendTestMessageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
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 | UpdateContactRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Contact | The RPC response. |
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 | UpdateContactRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskContact | A Task containing the RPC response. |