Class WebhooksClient (1.11.0)

public abstract class WebhooksClient

Webhooks client wrapper, for convenient use.

Inheritance

Object > WebhooksClient

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Derived Types

WebhooksClientImpl

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

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
`String`

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default Webhooks scopes.

Property Value
Type	Description
`IReadOnlyList<String>`

Remarks

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`	`CancellationToken` The CancellationToken to use while creating the client.

Returns
Type	Description
`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: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;`.
`webhook`	`Webhook` Required. The webhook to create.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Webhook`	The RPC response.

Example

// Create client
WebhooksClient webhooksClient = WebhooksClient.Create();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
Webhook webhook = new Webhook();
// Make the request
Webhook response = webhooksClient.CreateWebhook(parent, webhook);

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`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Webhook`	The RPC response.

Example

// Create client
WebhooksClient webhooksClient = WebhooksClient.Create();
// Initialize request argument(s)
CreateWebhookRequest request = new CreateWebhookRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    Webhook = new Webhook(),
};
// Make the request
Webhook response = webhooksClient.CreateWebhook(request);

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`	`String` Required. The agent to create a webhook for. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;`.
`webhook`	`Webhook` Required. The webhook to create.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Webhook`	The RPC response.

Example

// Create client
WebhooksClient webhooksClient = WebhooksClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
Webhook webhook = new Webhook();
// Make the request
Webhook response = webhooksClient.CreateWebhook(parent, webhook);

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: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;`.
`webhook`	`Webhook` Required. The webhook to create.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Webhook>`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
Webhook webhook = new Webhook();
// Make the request
Webhook response = await webhooksClient.CreateWebhookAsync(parent, webhook);

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: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;`.
`webhook`	`Webhook` Required. The webhook to create.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Webhook>`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
Webhook webhook = new Webhook();
// Make the request
Webhook response = await webhooksClient.CreateWebhookAsync(parent, webhook);

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`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Webhook>`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
CreateWebhookRequest request = new CreateWebhookRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    Webhook = new Webhook(),
};
// Make the request
Webhook response = await webhooksClient.CreateWebhookAsync(request);

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`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Webhook>`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
CreateWebhookRequest request = new CreateWebhookRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    Webhook = new Webhook(),
};
// Make the request
Webhook response = await webhooksClient.CreateWebhookAsync(request);

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`	`String` Required. The agent to create a webhook for. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;`.
`webhook`	`Webhook` Required. The webhook to create.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Webhook>`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
Webhook webhook = new Webhook();
// Make the request
Webhook response = await webhooksClient.CreateWebhookAsync(parent, webhook);

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`	`String` Required. The agent to create a webhook for. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;`.
`webhook`	`Webhook` Required. The webhook to create.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Webhook>`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
Webhook webhook = new Webhook();
// Make the request
Webhook response = await webhooksClient.CreateWebhookAsync(parent, webhook);

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`	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
WebhooksClient webhooksClient = WebhooksClient.Create();
// Initialize request argument(s)
DeleteWebhookRequest request = new DeleteWebhookRequest
{
    WebhookName = WebhookName.FromProjectLocationAgentWebhook("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]"),
    Force = false,
};
// Make the request
webhooksClient.DeleteWebhook(request);

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: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/webhooks/&lt;Webhook ID&gt;`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
WebhooksClient webhooksClient = WebhooksClient.Create();
// Initialize request argument(s)
WebhookName name = WebhookName.FromProjectLocationAgentWebhook("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]");
// Make the request
webhooksClient.DeleteWebhook(name);

DeleteWebhook(String, CallSettings)

public virtual void DeleteWebhook(string name, CallSettings callSettings = null)

Deletes the specified webhook.

Parameters
Name	Description
`name`	`String` Required. The name of the webhook to delete. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/webhooks/&lt;Webhook ID&gt;`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Example

// Create client
WebhooksClient webhooksClient = WebhooksClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/webhooks/[WEBHOOK]";
// Make the request
webhooksClient.DeleteWebhook(name);

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`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
DeleteWebhookRequest request = new DeleteWebhookRequest
{
    WebhookName = WebhookName.FromProjectLocationAgentWebhook("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]"),
    Force = false,
};
// Make the request
await webhooksClient.DeleteWebhookAsync(request);

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`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
DeleteWebhookRequest request = new DeleteWebhookRequest
{
    WebhookName = WebhookName.FromProjectLocationAgentWebhook("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]"),
    Force = false,
};
// Make the request
await webhooksClient.DeleteWebhookAsync(request);

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: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/webhooks/&lt;Webhook ID&gt;`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
WebhookName name = WebhookName.FromProjectLocationAgentWebhook("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]");
// Make the request
await webhooksClient.DeleteWebhookAsync(name);

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: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/webhooks/&lt;Webhook ID&gt;`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
WebhookName name = WebhookName.FromProjectLocationAgentWebhook("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]");
// Make the request
await webhooksClient.DeleteWebhookAsync(name);

DeleteWebhookAsync(String, CallSettings)

public virtual Task DeleteWebhookAsync(string name, CallSettings callSettings = null)

Deletes the specified webhook.

Parameters
Name	Description
`name`	`String` Required. The name of the webhook to delete. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/webhooks/&lt;Webhook ID&gt;`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/webhooks/[WEBHOOK]";
// Make the request
await webhooksClient.DeleteWebhookAsync(name);

DeleteWebhookAsync(String, CancellationToken)

public virtual Task DeleteWebhookAsync(string name, CancellationToken cancellationToken)

Deletes the specified webhook.

Parameters
Name	Description
`name`	`String` Required. The name of the webhook to delete. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/webhooks/&lt;Webhook ID&gt;`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/webhooks/[WEBHOOK]";
// Make the request
await webhooksClient.DeleteWebhookAsync(name);

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`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Webhook`	The RPC response.

Example

// Create client
WebhooksClient webhooksClient = WebhooksClient.Create();
// Initialize request argument(s)
GetWebhookRequest request = new GetWebhookRequest
{
    WebhookName = WebhookName.FromProjectLocationAgentWebhook("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]"),
};
// Make the request
Webhook response = webhooksClient.GetWebhook(request);

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: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/webhooks/&lt;Webhook ID&gt;`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Webhook`	The RPC response.

Example

// Create client
WebhooksClient webhooksClient = WebhooksClient.Create();
// Initialize request argument(s)
WebhookName name = WebhookName.FromProjectLocationAgentWebhook("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]");
// Make the request
Webhook response = webhooksClient.GetWebhook(name);

GetWebhook(String, CallSettings)

public virtual Webhook GetWebhook(string name, CallSettings callSettings = null)

Retrieves the specified webhook.

Parameters
Name	Description
`name`	`String` Required. The name of the webhook. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/webhooks/&lt;Webhook ID&gt;`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Webhook`	The RPC response.

Example

// Create client
WebhooksClient webhooksClient = WebhooksClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/webhooks/[WEBHOOK]";
// Make the request
Webhook response = webhooksClient.GetWebhook(name);

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`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Webhook>`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
GetWebhookRequest request = new GetWebhookRequest
{
    WebhookName = WebhookName.FromProjectLocationAgentWebhook("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]"),
};
// Make the request
Webhook response = await webhooksClient.GetWebhookAsync(request);

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`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Webhook>`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
GetWebhookRequest request = new GetWebhookRequest
{
    WebhookName = WebhookName.FromProjectLocationAgentWebhook("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]"),
};
// Make the request
Webhook response = await webhooksClient.GetWebhookAsync(request);

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: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/webhooks/&lt;Webhook ID&gt;`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Webhook>`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
WebhookName name = WebhookName.FromProjectLocationAgentWebhook("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]");
// Make the request
Webhook response = await webhooksClient.GetWebhookAsync(name);

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: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/webhooks/&lt;Webhook ID&gt;`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Webhook>`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
WebhookName name = WebhookName.FromProjectLocationAgentWebhook("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]");
// Make the request
Webhook response = await webhooksClient.GetWebhookAsync(name);

GetWebhookAsync(String, CallSettings)

public virtual Task<Webhook> GetWebhookAsync(string name, CallSettings callSettings = null)

Retrieves the specified webhook.

Parameters
Name	Description
`name`	`String` Required. The name of the webhook. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/webhooks/&lt;Webhook ID&gt;`.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Webhook>`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/webhooks/[WEBHOOK]";
// Make the request
Webhook response = await webhooksClient.GetWebhookAsync(name);

GetWebhookAsync(String, CancellationToken)

public virtual Task<Webhook> GetWebhookAsync(string name, CancellationToken cancellationToken)

Retrieves the specified webhook.

Parameters
Name	Description
`name`	`String` Required. The name of the webhook. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/webhooks/&lt;Webhook ID&gt;`.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Webhook>`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]/webhooks/[WEBHOOK]";
// Make the request
Webhook response = await webhooksClient.GetWebhookAsync(name);

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: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;`.
`pageToken`	`String` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`Nullable<Int32>` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListWebhooksResponse, Webhook>`	A pageable sequence of Webhook resources.

Example

// Create client
WebhooksClient webhooksClient = WebhooksClient.Create();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
// Make the request
PagedEnumerable<ListWebhooksResponse, Webhook> response = webhooksClient.ListWebhooks(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Webhook item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListWebhooksResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Webhook item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Webhook> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Webhook item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListWebhooksResponse, Webhook>`	A pageable sequence of Webhook resources.

Example

// Create client
WebhooksClient webhooksClient = WebhooksClient.Create();
// Initialize request argument(s)
ListWebhooksRequest request = new ListWebhooksRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
};
// Make the request
PagedEnumerable<ListWebhooksResponse, Webhook> response = webhooksClient.ListWebhooks(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Webhook item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListWebhooksResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Webhook item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Webhook> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Webhook item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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`	`String` Required. The agent to list all webhooks for. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;`.
`pageToken`	`String` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`Nullable<Int32>` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListWebhooksResponse, Webhook>`	A pageable sequence of Webhook resources.

Example

// Create client
WebhooksClient webhooksClient = WebhooksClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
// Make the request
PagedEnumerable<ListWebhooksResponse, Webhook> response = webhooksClient.ListWebhooks(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Webhook item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListWebhooksResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Webhook item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Webhook> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Webhook item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;`.
`pageToken`	`String` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`Nullable<Int32>` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListWebhooksResponse, Webhook>`	A pageable asynchronous sequence of Webhook resources.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
// Make the request
PagedAsyncEnumerable<ListWebhooksResponse, Webhook> response = webhooksClient.ListWebhooksAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Webhook item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListWebhooksResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Webhook item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Webhook> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Webhook item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListWebhooksResponse, Webhook>`	A pageable asynchronous sequence of Webhook resources.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
ListWebhooksRequest request = new ListWebhooksRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
};
// Make the request
PagedAsyncEnumerable<ListWebhooksResponse, Webhook> response = webhooksClient.ListWebhooksAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Webhook item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListWebhooksResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Webhook item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Webhook> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Webhook item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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`	`String` Required. The agent to list all webhooks for. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;`.
`pageToken`	`String` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`Nullable<Int32>` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListWebhooksResponse, Webhook>`	A pageable asynchronous sequence of Webhook resources.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[AGENT]";
// Make the request
PagedAsyncEnumerable<ListWebhooksResponse, Webhook> response = webhooksClient.ListWebhooksAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Webhook item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListWebhooksResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Webhook item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Webhook> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Webhook item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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
`Task`	A task representing the asynchronous shutdown operation.

Remarks

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`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Webhook`	The RPC response.

Example

// Create client
WebhooksClient webhooksClient = WebhooksClient.Create();
// Initialize request argument(s)
UpdateWebhookRequest request = new UpdateWebhookRequest
{
    Webhook = new Webhook(),
    UpdateMask = new FieldMask(),
};
// Make the request
Webhook response = webhooksClient.UpdateWebhook(request);

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`	`FieldMask` The mask to control which fields get updated. If the mask is not present, all fields will be updated.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Webhook`	The RPC response.

Example

// Create client
WebhooksClient webhooksClient = WebhooksClient.Create();
// Initialize request argument(s)
Webhook webhook = new Webhook();
FieldMask updateMask = new FieldMask();
// Make the request
Webhook response = webhooksClient.UpdateWebhook(webhook, updateMask);

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`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Webhook>`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
UpdateWebhookRequest request = new UpdateWebhookRequest
{
    Webhook = new Webhook(),
    UpdateMask = new FieldMask(),
};
// Make the request
Webhook response = await webhooksClient.UpdateWebhookAsync(request);

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`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Webhook>`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
UpdateWebhookRequest request = new UpdateWebhookRequest
{
    Webhook = new Webhook(),
    UpdateMask = new FieldMask(),
};
// Make the request
Webhook response = await webhooksClient.UpdateWebhookAsync(request);

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`	`FieldMask` The mask to control which fields get updated. If the mask is not present, all fields will be updated.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Webhook>`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
Webhook webhook = new Webhook();
FieldMask updateMask = new FieldMask();
// Make the request
Webhook response = await webhooksClient.UpdateWebhookAsync(webhook, updateMask);

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`	`FieldMask` The mask to control which fields get updated. If the mask is not present, all fields will be updated.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Webhook>`	A Task containing the RPC response.

Example

// Create client
WebhooksClient webhooksClient = await WebhooksClient.CreateAsync();
// Initialize request argument(s)
Webhook webhook = new Webhook();
FieldMask updateMask = new FieldMask();
// Make the request
Webhook response = await webhooksClient.UpdateWebhookAsync(webhook, updateMask);