Dialogflow v3 API - Class Webhooks.WebhooksClient (2.4.0)

Version 2.4.0

• 2.20.0 (latest)
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public class WebhooksClient : ClientBase<Webhooks.WebhooksClient>

Reference documentation and code samples for the Dialogflow v3 API class Webhooks.WebhooksClient.

Client for Webhooks

Inheritance

Object > ClientBase > ClientBase<Webhooks.WebhooksClient> > Webhooks.WebhooksClient

Inherited Members

ClientBase<Webhooks.WebhooksClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

WebhooksClient()

protected WebhooksClient()

Protected parameterless constructor to allow creation of test doubles.

WebhooksClient(CallInvoker)

public WebhooksClient(CallInvoker callInvoker)

Creates a new client for Webhooks that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

WebhooksClient(ChannelBase)

public WebhooksClient(ChannelBase channel)

Creates a new client for Webhooks

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

WebhooksClient(ClientBase.ClientBaseConfiguration)

protected WebhooksClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBase.ClientBaseConfiguration The client configuration.

Methods

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
Locations.LocationsClient	A new Locations.LocationsClient for the same target as this client.

CreateWebhook(CreateWebhookRequest, CallOptions)

public virtual Webhook CreateWebhook(CreateWebhookRequest request, CallOptions options)

Creates a webhook in the specified agent.

Parameters
Name	Description
request	CreateWebhookRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Webhook	The response received from the server.

CreateWebhook(CreateWebhookRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Webhook CreateWebhook(CreateWebhookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a webhook in the specified agent.

Parameters
Name	Description
request	CreateWebhookRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Webhook	The response received from the server.

CreateWebhookAsync(CreateWebhookRequest, CallOptions)

public virtual AsyncUnaryCall<Webhook> CreateWebhookAsync(CreateWebhookRequest request, CallOptions options)

Creates a webhook in the specified agent.

Parameters
Name	Description
request	CreateWebhookRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Webhook>	The call object.

CreateWebhookAsync(CreateWebhookRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Webhook> CreateWebhookAsync(CreateWebhookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a webhook in the specified agent.

Parameters
Name	Description
request	CreateWebhookRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<Webhook>	The call object.

DeleteWebhook(DeleteWebhookRequest, CallOptions)

public virtual Empty DeleteWebhook(DeleteWebhookRequest request, CallOptions options)

Deletes the specified webhook.

Parameters
Name	Description
request	DeleteWebhookRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteWebhook(DeleteWebhookRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Empty DeleteWebhook(DeleteWebhookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes the specified webhook.

Parameters
Name	Description
request	DeleteWebhookRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteWebhookAsync(DeleteWebhookRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteWebhookAsync(DeleteWebhookRequest request, CallOptions options)

Deletes the specified webhook.

Parameters
Name	Description
request	DeleteWebhookRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Empty>	The call object.

DeleteWebhookAsync(DeleteWebhookRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteWebhookAsync(DeleteWebhookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes the specified webhook.

Parameters
Name	Description
request	DeleteWebhookRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<Empty>	The call object.

GetWebhook(GetWebhookRequest, CallOptions)

public virtual Webhook GetWebhook(GetWebhookRequest request, CallOptions options)

Retrieves the specified webhook.

Parameters
Name	Description
request	GetWebhookRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Webhook	The response received from the server.

GetWebhook(GetWebhookRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Webhook GetWebhook(GetWebhookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Retrieves the specified webhook.

Parameters
Name	Description
request	GetWebhookRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Webhook	The response received from the server.

GetWebhookAsync(GetWebhookRequest, CallOptions)

public virtual AsyncUnaryCall<Webhook> GetWebhookAsync(GetWebhookRequest request, CallOptions options)

Retrieves the specified webhook.

Parameters
Name	Description
request	GetWebhookRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Webhook>	The call object.

GetWebhookAsync(GetWebhookRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Webhook> GetWebhookAsync(GetWebhookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Retrieves the specified webhook.

Parameters
Name	Description
request	GetWebhookRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<Webhook>	The call object.

ListWebhooks(ListWebhooksRequest, CallOptions)

public virtual ListWebhooksResponse ListWebhooks(ListWebhooksRequest request, CallOptions options)

Returns the list of all webhooks in the specified agent.

Parameters
Name	Description
request	ListWebhooksRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListWebhooksResponse	The response received from the server.

ListWebhooks(ListWebhooksRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListWebhooksResponse ListWebhooks(ListWebhooksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the list of all webhooks in the specified agent.

Parameters
Name	Description
request	ListWebhooksRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListWebhooksResponse	The response received from the server.

ListWebhooksAsync(ListWebhooksRequest, CallOptions)

public virtual AsyncUnaryCall<ListWebhooksResponse> ListWebhooksAsync(ListWebhooksRequest request, CallOptions options)

Returns the list of all webhooks in the specified agent.

Parameters
Name	Description
request	ListWebhooksRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<ListWebhooksResponse>	The call object.

ListWebhooksAsync(ListWebhooksRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListWebhooksResponse> ListWebhooksAsync(ListWebhooksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the list of all webhooks in the specified agent.

Parameters
Name	Description
request	ListWebhooksRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<ListWebhooksResponse>	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override Webhooks.WebhooksClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBase.ClientBaseConfiguration

Returns
Type	Description
Webhooks.WebhooksClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Dialogflow.Cx.V3.Webhooks.WebhooksClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateWebhook(UpdateWebhookRequest, CallOptions)

public virtual Webhook UpdateWebhook(UpdateWebhookRequest request, CallOptions options)

Updates the specified webhook.

Parameters
Name	Description
request	UpdateWebhookRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Webhook	The response received from the server.

UpdateWebhook(UpdateWebhookRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Webhook UpdateWebhook(UpdateWebhookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the specified webhook.

Parameters
Name	Description
request	UpdateWebhookRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Webhook	The response received from the server.

UpdateWebhookAsync(UpdateWebhookRequest, CallOptions)

public virtual AsyncUnaryCall<Webhook> UpdateWebhookAsync(UpdateWebhookRequest request, CallOptions options)

Updates the specified webhook.

Parameters
Name	Description
request	UpdateWebhookRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Webhook>	The call object.

UpdateWebhookAsync(UpdateWebhookRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Webhook> UpdateWebhookAsync(UpdateWebhookRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the specified webhook.

Parameters
Name	Description
request	UpdateWebhookRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<Webhook>	The call object.