WebhooksClient (Google Dialogflow CX 0.71.0 API)

java.lang.Object
- com.google.cloud.dialogflow.cx.v3beta1.WebhooksClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class WebhooksClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service for managing [Webhooks][google.cloud.dialogflow.cx.v3beta1.Webhook].

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WebhooksClient webhooksClient = WebhooksClient.create()) {
   WebhookName name = WebhookName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]");
   Webhook response = webhooksClient.getWebhook(name);
 }

Note: close() needs to be called on the WebhooksClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method	Description	Method Variants
ListWebhooks	Returns the list of all webhooks in the specified agent.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listWebhooks(ListWebhooksRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listWebhooks(AgentName parent) listWebhooks(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listWebhooksPagedCallable() listWebhooksCallable()
GetWebhook	Retrieves the specified webhook.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getWebhook(GetWebhookRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getWebhook(WebhookName name) getWebhook(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getWebhookCallable()
CreateWebhook	Creates a webhook in the specified agent.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createWebhook(CreateWebhookRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createWebhook(AgentName parent, Webhook webhook) createWebhook(String parent, Webhook webhook) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createWebhookCallable()
UpdateWebhook	Updates the specified webhook.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateWebhook(UpdateWebhookRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateWebhook(Webhook webhook, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateWebhookCallable()
DeleteWebhook	Deletes the specified webhook.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteWebhook(DeleteWebhookRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteWebhook(WebhookName name) deleteWebhook(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteWebhookCallable()
ListLocations	Lists information about the supported locations for this service.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLocations(ListLocationsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLocationsPagedCallable() listLocationsCallable()
GetLocation	Gets information about a location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLocation(GetLocationRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLocationCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of WebhooksSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 WebhooksSettings webhooksSettings =
     WebhooksSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 WebhooksClient webhooksClient = WebhooksClient.create(webhooksSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 WebhooksSettings webhooksSettings =
     WebhooksSettings.newBuilder().setEndpoint(myEndpoint).build();
 WebhooksClient webhooksClient = WebhooksClient.create(webhooksSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 WebhooksSettings webhooksSettings = WebhooksSettings.newHttpJsonBuilder().build();
 WebhooksClient webhooksClient = WebhooksClient.create(webhooksSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`WebhooksClient.ListLocationsFixedSizeCollection`
`static class`	`WebhooksClient.ListLocationsPage`
`static class`	`WebhooksClient.ListLocationsPagedResponse`
`static class`	`WebhooksClient.ListWebhooksFixedSizeCollection`
`static class`	`WebhooksClient.ListWebhooksPage`
`static class`	`WebhooksClient.ListWebhooksPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`WebhooksClient(WebhooksSettings settings)` Constructs an instance of WebhooksClient, using the given settings.
`protected`	`WebhooksClient(WebhooksStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static WebhooksClient`	`create()` Constructs an instance of WebhooksClient with default settings.
`static WebhooksClient`	`create(WebhooksSettings settings)` Constructs an instance of WebhooksClient, using the given settings.
`static WebhooksClient`	`create(WebhooksStub stub)` Constructs an instance of WebhooksClient, using the given stub for making calls.
`Webhook`	`createWebhook(AgentName parent, Webhook webhook)` Creates a webhook in the specified agent.
`Webhook`	`createWebhook(CreateWebhookRequest request)` Creates a webhook in the specified agent.
`Webhook`	`createWebhook(String parent, Webhook webhook)` Creates a webhook in the specified agent.
`com.google.api.gax.rpc.UnaryCallable<CreateWebhookRequest,Webhook>`	`createWebhookCallable()` Creates a webhook in the specified agent.
`void`	`deleteWebhook(DeleteWebhookRequest request)` Deletes the specified webhook.
`void`	`deleteWebhook(String name)` Deletes the specified webhook.
`void`	`deleteWebhook(WebhookName name)` Deletes the specified webhook.
`com.google.api.gax.rpc.UnaryCallable<DeleteWebhookRequest,com.google.protobuf.Empty>`	`deleteWebhookCallable()` Deletes the specified webhook.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`WebhooksSettings`	`getSettings()`
`WebhooksStub`	`getStub()`
`Webhook`	`getWebhook(GetWebhookRequest request)` Retrieves the specified webhook.
`Webhook`	`getWebhook(String name)` Retrieves the specified webhook.
`Webhook`	`getWebhook(WebhookName name)` Retrieves the specified webhook.
`com.google.api.gax.rpc.UnaryCallable<GetWebhookRequest,Webhook>`	`getWebhookCallable()` Retrieves the specified webhook.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`WebhooksClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,WebhooksClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`WebhooksClient.ListWebhooksPagedResponse`	`listWebhooks(AgentName parent)` Returns the list of all webhooks in the specified agent.
`WebhooksClient.ListWebhooksPagedResponse`	`listWebhooks(ListWebhooksRequest request)` Returns the list of all webhooks in the specified agent.
`WebhooksClient.ListWebhooksPagedResponse`	`listWebhooks(String parent)` Returns the list of all webhooks in the specified agent.
`com.google.api.gax.rpc.UnaryCallable<ListWebhooksRequest,ListWebhooksResponse>`	`listWebhooksCallable()` Returns the list of all webhooks in the specified agent.
`com.google.api.gax.rpc.UnaryCallable<ListWebhooksRequest,WebhooksClient.ListWebhooksPagedResponse>`	`listWebhooksPagedCallable()` Returns the list of all webhooks in the specified agent.
`void`	`shutdown()`
`void`	`shutdownNow()`
`Webhook`	`updateWebhook(UpdateWebhookRequest request)` Updates the specified webhook.
`Webhook`	`updateWebhook(Webhook webhook, com.google.protobuf.FieldMask updateMask)` Updates the specified webhook.
`com.google.api.gax.rpc.UnaryCallable<UpdateWebhookRequest,Webhook>`	`updateWebhookCallable()` Updates the specified webhook.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- WebhooksClient
```
protected WebhooksClient(WebhooksSettings settings)
                  throws IOException
```
  Constructs an instance of WebhooksClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
  
  Throws:
  
  IOException
- WebhooksClient
```
protected WebhooksClient(WebhooksStub stub)
```

Method Detail

create

public static final WebhooksClient create()
                                   throws IOException

Constructs an instance of WebhooksClient with default settings.

Throws:: IOException

create
```
public static final WebhooksClient create(WebhooksSettings settings)
                                   throws IOException
```
Constructs an instance of WebhooksClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create
```
public static final WebhooksClient create(WebhooksStub stub)
```
Constructs an instance of WebhooksClient, using the given stub for making calls. This is for advanced usage - prefer using create(WebhooksSettings).

getSettings

public final WebhooksSettings getSettings()

getStub
```
public WebhooksStub getStub()
```