public abstract class WebhooksClient
Webhooks client wrapper, for convenient use.
Inheritance
System.Object > WebhooksClientNamespace
Google.Cloud.Dialogflow.Cx.V3Assembly
Google.Cloud.Dialogflow.Cx.V3.dll
Remarks
Service for managing [Webhooks][google.cloud.dialogflow.cx.v3.Webhook].
Properties
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the Webhooks service, which is a host of "dialogflow.googleapis.com" and a port of 443.
Property Value | |
---|---|
Type | Description |
System.String |
DefaultScopes
public static IReadOnlyList<string> DefaultScopes { get; }
The default Webhooks scopes.
Property Value | |
---|---|
Type | Description |
System.Collections.Generic.IReadOnlyList<System.String> |
The default Webhooks scopes are:
GrpcClient
public virtual Webhooks.WebhooksClient GrpcClient { get; }
The underlying gRPC Webhooks client
Property Value | |
---|---|
Type | Description |
Webhooks.WebhooksClient |
Methods
Create()
public static WebhooksClient Create()
Synchronously creates a WebhooksClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use WebhooksClientBuilder.
Returns | |
---|---|
Type | Description |
WebhooksClient | The created WebhooksClient. |
CreateAsync(CancellationToken)
public static Task<WebhooksClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))
Asynchronously creates a WebhooksClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use WebhooksClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken | System.Threading.CancellationToken The System.Threading.CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<WebhooksClient> | The task representing the created WebhooksClient. |
CreateWebhook(AgentName, Webhook, CallSettings)
public virtual Webhook CreateWebhook(AgentName parent, Webhook webhook, CallSettings callSettings = null)
Creates a webhook in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | AgentName Required. The agent to create a webhook for.
Format: |
webhook | Webhook Required. The webhook to create. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Webhook | The RPC response. |
CreateWebhook(CreateWebhookRequest, CallSettings)
public virtual Webhook CreateWebhook(CreateWebhookRequest request, CallSettings callSettings = null)
Creates a webhook in the specified agent.
Parameters | |
---|---|
Name | Description |
request | CreateWebhookRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Webhook | The RPC response. |
CreateWebhook(String, Webhook, CallSettings)
public virtual Webhook CreateWebhook(string parent, Webhook webhook, CallSettings callSettings = null)
Creates a webhook in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The agent to create a webhook for.
Format: |
webhook | Webhook Required. The webhook to create. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Webhook | The RPC response. |
CreateWebhookAsync(AgentName, Webhook, CallSettings)
public virtual Task<Webhook> CreateWebhookAsync(AgentName parent, Webhook webhook, CallSettings callSettings = null)
Creates a webhook in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | AgentName Required. The agent to create a webhook for.
Format: |
webhook | Webhook Required. The webhook to create. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Webhook> | A Task containing the RPC response. |
CreateWebhookAsync(AgentName, Webhook, CancellationToken)
public virtual Task<Webhook> CreateWebhookAsync(AgentName parent, Webhook webhook, CancellationToken cancellationToken)
Creates a webhook in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | AgentName Required. The agent to create a webhook for.
Format: |
webhook | Webhook Required. The webhook to create. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Webhook> | A Task containing the RPC response. |
CreateWebhookAsync(CreateWebhookRequest, CallSettings)
public virtual Task<Webhook> CreateWebhookAsync(CreateWebhookRequest request, CallSettings callSettings = null)
Creates a webhook in the specified agent.
Parameters | |
---|---|
Name | Description |
request | CreateWebhookRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Webhook> | A Task containing the RPC response. |
CreateWebhookAsync(CreateWebhookRequest, CancellationToken)
public virtual Task<Webhook> CreateWebhookAsync(CreateWebhookRequest request, CancellationToken cancellationToken)
Creates a webhook in the specified agent.
Parameters | |
---|---|
Name | Description |
request | CreateWebhookRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Webhook> | A Task containing the RPC response. |
CreateWebhookAsync(String, Webhook, CallSettings)
public virtual Task<Webhook> CreateWebhookAsync(string parent, Webhook webhook, CallSettings callSettings = null)
Creates a webhook in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The agent to create a webhook for.
Format: |
webhook | Webhook Required. The webhook to create. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Webhook> | A Task containing the RPC response. |
CreateWebhookAsync(String, Webhook, CancellationToken)
public virtual Task<Webhook> CreateWebhookAsync(string parent, Webhook webhook, CancellationToken cancellationToken)
Creates a webhook in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The agent to create a webhook for.
Format: |
webhook | Webhook Required. The webhook to create. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Webhook> | A Task containing the RPC response. |
DeleteWebhook(DeleteWebhookRequest, CallSettings)
public virtual void DeleteWebhook(DeleteWebhookRequest request, CallSettings callSettings = null)
Deletes the specified webhook.
Parameters | |
---|---|
Name | Description |
request | DeleteWebhookRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
DeleteWebhook(WebhookName, CallSettings)
public virtual void DeleteWebhook(WebhookName name, CallSettings callSettings = null)
Deletes the specified webhook.
Parameters | |
---|---|
Name | Description |
name | WebhookName Required. The name of the webhook to delete.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
DeleteWebhook(String, CallSettings)
public virtual void DeleteWebhook(string name, CallSettings callSettings = null)
Deletes the specified webhook.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the webhook to delete.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
DeleteWebhookAsync(DeleteWebhookRequest, CallSettings)
public virtual Task DeleteWebhookAsync(DeleteWebhookRequest request, CallSettings callSettings = null)
Deletes the specified webhook.
Parameters | |
---|---|
Name | Description |
request | DeleteWebhookRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteWebhookAsync(DeleteWebhookRequest, CancellationToken)
public virtual Task DeleteWebhookAsync(DeleteWebhookRequest request, CancellationToken cancellationToken)
Deletes the specified webhook.
Parameters | |
---|---|
Name | Description |
request | DeleteWebhookRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteWebhookAsync(WebhookName, CallSettings)
public virtual Task DeleteWebhookAsync(WebhookName name, CallSettings callSettings = null)
Deletes the specified webhook.
Parameters | |
---|---|
Name | Description |
name | WebhookName Required. The name of the webhook to delete.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteWebhookAsync(WebhookName, CancellationToken)
public virtual Task DeleteWebhookAsync(WebhookName name, CancellationToken cancellationToken)
Deletes the specified webhook.
Parameters | |
---|---|
Name | Description |
name | WebhookName Required. The name of the webhook to delete.
Format: |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteWebhookAsync(String, CallSettings)
public virtual Task DeleteWebhookAsync(string name, CallSettings callSettings = null)
Deletes the specified webhook.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the webhook to delete.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteWebhookAsync(String, CancellationToken)
public virtual Task DeleteWebhookAsync(string name, CancellationToken cancellationToken)
Deletes the specified webhook.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the webhook to delete.
Format: |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
GetWebhook(GetWebhookRequest, CallSettings)
public virtual Webhook GetWebhook(GetWebhookRequest request, CallSettings callSettings = null)
Retrieves the specified webhook.
Parameters | |
---|---|
Name | Description |
request | GetWebhookRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Webhook | The RPC response. |
GetWebhook(WebhookName, CallSettings)
public virtual Webhook GetWebhook(WebhookName name, CallSettings callSettings = null)
Retrieves the specified webhook.
Parameters | |
---|---|
Name | Description |
name | WebhookName Required. The name of the webhook.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Webhook | The RPC response. |
GetWebhook(String, CallSettings)
public virtual Webhook GetWebhook(string name, CallSettings callSettings = null)
Retrieves the specified webhook.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the webhook.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Webhook | The RPC response. |
GetWebhookAsync(GetWebhookRequest, CallSettings)
public virtual Task<Webhook> GetWebhookAsync(GetWebhookRequest request, CallSettings callSettings = null)
Retrieves the specified webhook.
Parameters | |
---|---|
Name | Description |
request | GetWebhookRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Webhook> | A Task containing the RPC response. |
GetWebhookAsync(GetWebhookRequest, CancellationToken)
public virtual Task<Webhook> GetWebhookAsync(GetWebhookRequest request, CancellationToken cancellationToken)
Retrieves the specified webhook.
Parameters | |
---|---|
Name | Description |
request | GetWebhookRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Webhook> | A Task containing the RPC response. |
GetWebhookAsync(WebhookName, CallSettings)
public virtual Task<Webhook> GetWebhookAsync(WebhookName name, CallSettings callSettings = null)
Retrieves the specified webhook.
Parameters | |
---|---|
Name | Description |
name | WebhookName Required. The name of the webhook.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Webhook> | A Task containing the RPC response. |
GetWebhookAsync(WebhookName, CancellationToken)
public virtual Task<Webhook> GetWebhookAsync(WebhookName name, CancellationToken cancellationToken)
Retrieves the specified webhook.
Parameters | |
---|---|
Name | Description |
name | WebhookName Required. The name of the webhook.
Format: |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Webhook> | A Task containing the RPC response. |
GetWebhookAsync(String, CallSettings)
public virtual Task<Webhook> GetWebhookAsync(string name, CallSettings callSettings = null)
Retrieves the specified webhook.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the webhook.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Webhook> | A Task containing the RPC response. |
GetWebhookAsync(String, CancellationToken)
public virtual Task<Webhook> GetWebhookAsync(string name, CancellationToken cancellationToken)
Retrieves the specified webhook.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the webhook.
Format: |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Webhook> | A Task containing the RPC response. |
ListWebhooks(AgentName, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListWebhooksResponse, Webhook> ListWebhooks(AgentName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Returns the list of all webhooks in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | AgentName Required. The agent to list all webhooks for.
Format: |
pageToken | System.String The token returned from the previous request. A value of |
pageSize | System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedEnumerable<ListWebhooksResponse, Webhook> | A pageable sequence of Webhook resources. |
ListWebhooks(ListWebhooksRequest, CallSettings)
public virtual PagedEnumerable<ListWebhooksResponse, Webhook> ListWebhooks(ListWebhooksRequest request, CallSettings callSettings = null)
Returns the list of all webhooks in the specified agent.
Parameters | |
---|---|
Name | Description |
request | ListWebhooksRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedEnumerable<ListWebhooksResponse, Webhook> | A pageable sequence of Webhook resources. |
ListWebhooks(String, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListWebhooksResponse, Webhook> ListWebhooks(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Returns the list of all webhooks in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The agent to list all webhooks for.
Format: |
pageToken | System.String The token returned from the previous request. A value of |
pageSize | System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedEnumerable<ListWebhooksResponse, Webhook> | A pageable sequence of Webhook resources. |
ListWebhooksAsync(AgentName, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListWebhooksResponse, Webhook> ListWebhooksAsync(AgentName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Returns the list of all webhooks in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | AgentName Required. The agent to list all webhooks for.
Format: |
pageToken | System.String The token returned from the previous request. A value of |
pageSize | System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedAsyncEnumerable<ListWebhooksResponse, Webhook> | A pageable asynchronous sequence of Webhook resources. |
ListWebhooksAsync(ListWebhooksRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListWebhooksResponse, Webhook> ListWebhooksAsync(ListWebhooksRequest request, CallSettings callSettings = null)
Returns the list of all webhooks in the specified agent.
Parameters | |
---|---|
Name | Description |
request | ListWebhooksRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedAsyncEnumerable<ListWebhooksResponse, Webhook> | A pageable asynchronous sequence of Webhook resources. |
ListWebhooksAsync(String, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListWebhooksResponse, Webhook> ListWebhooksAsync(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Returns the list of all webhooks in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The agent to list all webhooks for.
Format: |
pageToken | System.String The token returned from the previous request. A value of |
pageSize | System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedAsyncEnumerable<ListWebhooksResponse, Webhook> | A pageable asynchronous sequence of Webhook resources. |
ShutdownDefaultChannelsAsync()
public static Task ShutdownDefaultChannelsAsync()
Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A task representing the asynchronous shutdown operation. |
After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.
UpdateWebhook(UpdateWebhookRequest, CallSettings)
public virtual Webhook UpdateWebhook(UpdateWebhookRequest request, CallSettings callSettings = null)
Updates the specified webhook.
Parameters | |
---|---|
Name | Description |
request | UpdateWebhookRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Webhook | The RPC response. |
UpdateWebhook(Webhook, FieldMask, CallSettings)
public virtual Webhook UpdateWebhook(Webhook webhook, FieldMask updateMask, CallSettings callSettings = null)
Updates the specified webhook.
Parameters | |
---|---|
Name | Description |
webhook | Webhook Required. The webhook to update. |
updateMask | Google.Protobuf.WellKnownTypes.FieldMask The mask to control which fields get updated. If the mask is not present, all fields will be updated. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Webhook | The RPC response. |
UpdateWebhookAsync(UpdateWebhookRequest, CallSettings)
public virtual Task<Webhook> UpdateWebhookAsync(UpdateWebhookRequest request, CallSettings callSettings = null)
Updates the specified webhook.
Parameters | |
---|---|
Name | Description |
request | UpdateWebhookRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Webhook> | A Task containing the RPC response. |
UpdateWebhookAsync(UpdateWebhookRequest, CancellationToken)
public virtual Task<Webhook> UpdateWebhookAsync(UpdateWebhookRequest request, CancellationToken cancellationToken)
Updates the specified webhook.
Parameters | |
---|---|
Name | Description |
request | UpdateWebhookRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Webhook> | A Task containing the RPC response. |
UpdateWebhookAsync(Webhook, FieldMask, CallSettings)
public virtual Task<Webhook> UpdateWebhookAsync(Webhook webhook, FieldMask updateMask, CallSettings callSettings = null)
Updates the specified webhook.
Parameters | |
---|---|
Name | Description |
webhook | Webhook Required. The webhook to update. |
updateMask | Google.Protobuf.WellKnownTypes.FieldMask The mask to control which fields get updated. If the mask is not present, all fields will be updated. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Webhook> | A Task containing the RPC response. |
UpdateWebhookAsync(Webhook, FieldMask, CancellationToken)
public virtual Task<Webhook> UpdateWebhookAsync(Webhook webhook, FieldMask updateMask, CancellationToken cancellationToken)
Updates the specified webhook.
Parameters | |
---|---|
Name | Description |
webhook | Webhook Required. The webhook to update. |
updateMask | Google.Protobuf.WellKnownTypes.FieldMask The mask to control which fields get updated. If the mask is not present, all fields will be updated. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Webhook> | A Task containing the RPC response. |