com.google.cloud.dialogflow.cx.v3.WebhooksClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-dialogflow-cx Show documentation
provides a new way of designing agents, taking a state machine approach to agent design. This gives you clear and explicit control over a conversation, a better end-user experience, and a better development workflow.
The newest version!
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.cloud.dialogflow.cx.v3;

import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.dialogflow.cx.v3.stub.WebhooksStub;
import com.google.cloud.dialogflow.cx.v3.stub.WebhooksStubSettings;
import com.google.cloud.location.GetLocationRequest;
import com.google.cloud.location.ListLocationsRequest;
import com.google.cloud.location.ListLocationsResponse;
import com.google.cloud.location.Location;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.protobuf.Empty;
import com.google.protobuf.FieldMask;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
 * Service Description: Service for managing [Webhooks][google.cloud.dialogflow.cx.v3.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:
 *
 * 
{@code
 * // 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().
 *
 * 
 *    
 *    
 *      
 *      
 *      
 *    
 *    
 *      
 *      
 *      
 *    
 *    
 *      
 *      
 *      
 *    
 *    
 *      
 *      
 *      
 *    
 *    
 *      
 *      
 *      
 *    
 *    
 *      
 *      
 *      
 *    
 *    
 *      
 *      
 *      
 *    
 *    
 *      
 *      
 *      
 *    
 *  MethodsMethod 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:
 *
 * 
{@code
 * // 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:
 *
 * 
{@code
 * // 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:
 *
 * 
{@code
 * // 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.
 */
@Generated("by gapic-generator-java")
public class WebhooksClient implements BackgroundResource {
  private final WebhooksSettings settings;
  private final WebhooksStub stub;

  /** Constructs an instance of WebhooksClient with default settings. */
  public static final WebhooksClient create() throws IOException {
    return create(WebhooksSettings.newBuilder().build());
  }

  /**
   * 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.
   */
  public static final WebhooksClient create(WebhooksSettings settings) throws IOException {
    return new WebhooksClient(settings);
  }

  /**
   * Constructs an instance of WebhooksClient, using the given stub for making calls. This is for
   * advanced usage - prefer using create(WebhooksSettings).
   */
  public static final WebhooksClient create(WebhooksStub stub) {
    return new WebhooksClient(stub);
  }

  /**
   * 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.
   */
  protected WebhooksClient(WebhooksSettings settings) throws IOException {
    this.settings = settings;
    this.stub = ((WebhooksStubSettings) settings.getStubSettings()).createStub();
  }

  protected WebhooksClient(WebhooksStub stub) {
    this.settings = null;
    this.stub = stub;
  }

  public final WebhooksSettings getSettings() {
    return settings;
  }

  public WebhooksStub getStub() {
    return stub;
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Returns the list of all webhooks in the specified agent.
   *
   * 
Sample code:
   *
   * 
{@code
   * // 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()) {
   *   AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
   *   for (Webhook element : webhooksClient.listWebhooks(parent).iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }
   *
   * @param parent Required. The agent to list all webhooks for. Format:
   *     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final ListWebhooksPagedResponse listWebhooks(AgentName parent) {
    ListWebhooksRequest request =
        ListWebhooksRequest.newBuilder()
            .setParent(parent == null ? null : parent.toString())
            .build();
    return listWebhooks(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Returns the list of all webhooks in the specified agent.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   String parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString();
   *   for (Webhook element : webhooksClient.listWebhooks(parent).iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }
   *
   * @param parent Required. The agent to list all webhooks for. Format:
   *     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final ListWebhooksPagedResponse listWebhooks(String parent) {
    ListWebhooksRequest request = ListWebhooksRequest.newBuilder().setParent(parent).build();
    return listWebhooks(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Returns the list of all webhooks in the specified agent.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   ListWebhooksRequest request =
   *       ListWebhooksRequest.newBuilder()
   *           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .build();
   *   for (Webhook element : webhooksClient.listWebhooks(request).iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }
   *
   * @param request The request object containing all of the parameters for the API call.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final ListWebhooksPagedResponse listWebhooks(ListWebhooksRequest request) {
    return listWebhooksPagedCallable().call(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Returns the list of all webhooks in the specified agent.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   ListWebhooksRequest request =
   *       ListWebhooksRequest.newBuilder()
   *           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .build();
   *   ApiFuture future = webhooksClient.listWebhooksPagedCallable().futureCall(request);
   *   // Do something.
   *   for (Webhook element : future.get().iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }
   */
  public final UnaryCallable
      listWebhooksPagedCallable() {
    return stub.listWebhooksPagedCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Returns the list of all webhooks in the specified agent.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   ListWebhooksRequest request =
   *       ListWebhooksRequest.newBuilder()
   *           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .build();
   *   while (true) {
   *     ListWebhooksResponse response = webhooksClient.listWebhooksCallable().call(request);
   *     for (Webhook element : response.getWebhooksList()) {
   *       // doThingsWith(element);
   *     }
   *     String nextPageToken = response.getNextPageToken();
   *     if (!Strings.isNullOrEmpty(nextPageToken)) {
   *       request = request.toBuilder().setPageToken(nextPageToken).build();
   *     } else {
   *       break;
   *     }
   *   }
   * }
   * }
   */
  public final UnaryCallable listWebhooksCallable() {
    return stub.listWebhooksCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Retrieves the specified webhook.
   *
   * Sample code:
   *
   * 
{@code
   * // 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);
   * }
   * }
   *
   * @param name Required. The name of the webhook. Format:
   *     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final Webhook getWebhook(WebhookName name) {
    GetWebhookRequest request =
        GetWebhookRequest.newBuilder().setName(name == null ? null : name.toString()).build();
    return getWebhook(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Retrieves the specified webhook.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   String name = WebhookName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]").toString();
   *   Webhook response = webhooksClient.getWebhook(name);
   * }
   * }
   *
   * @param name Required. The name of the webhook. Format:
   *     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final Webhook getWebhook(String name) {
    GetWebhookRequest request = GetWebhookRequest.newBuilder().setName(name).build();
    return getWebhook(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Retrieves the specified webhook.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   GetWebhookRequest request =
   *       GetWebhookRequest.newBuilder()
   *           .setName(WebhookName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]").toString())
   *           .build();
   *   Webhook response = webhooksClient.getWebhook(request);
   * }
   * }
   *
   * @param request The request object containing all of the parameters for the API call.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final Webhook getWebhook(GetWebhookRequest request) {
    return getWebhookCallable().call(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Retrieves the specified webhook.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   GetWebhookRequest request =
   *       GetWebhookRequest.newBuilder()
   *           .setName(WebhookName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]").toString())
   *           .build();
   *   ApiFuture future = webhooksClient.getWebhookCallable().futureCall(request);
   *   // Do something.
   *   Webhook response = future.get();
   * }
   * }
   */
  public final UnaryCallable getWebhookCallable() {
    return stub.getWebhookCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Creates a webhook in the specified agent.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
   *   Webhook webhook = Webhook.newBuilder().build();
   *   Webhook response = webhooksClient.createWebhook(parent, webhook);
   * }
   * }
   *
   * @param parent Required. The agent to create a webhook for. Format:
   *     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
   * @param webhook Required. The webhook to create.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final Webhook createWebhook(AgentName parent, Webhook webhook) {
    CreateWebhookRequest request =
        CreateWebhookRequest.newBuilder()
            .setParent(parent == null ? null : parent.toString())
            .setWebhook(webhook)
            .build();
    return createWebhook(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Creates a webhook in the specified agent.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   String parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString();
   *   Webhook webhook = Webhook.newBuilder().build();
   *   Webhook response = webhooksClient.createWebhook(parent, webhook);
   * }
   * }
   *
   * @param parent Required. The agent to create a webhook for. Format:
   *     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
   * @param webhook Required. The webhook to create.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final Webhook createWebhook(String parent, Webhook webhook) {
    CreateWebhookRequest request =
        CreateWebhookRequest.newBuilder().setParent(parent).setWebhook(webhook).build();
    return createWebhook(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Creates a webhook in the specified agent.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   CreateWebhookRequest request =
   *       CreateWebhookRequest.newBuilder()
   *           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
   *           .setWebhook(Webhook.newBuilder().build())
   *           .build();
   *   Webhook response = webhooksClient.createWebhook(request);
   * }
   * }
   *
   * @param request The request object containing all of the parameters for the API call.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final Webhook createWebhook(CreateWebhookRequest request) {
    return createWebhookCallable().call(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Creates a webhook in the specified agent.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   CreateWebhookRequest request =
   *       CreateWebhookRequest.newBuilder()
   *           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
   *           .setWebhook(Webhook.newBuilder().build())
   *           .build();
   *   ApiFuture future = webhooksClient.createWebhookCallable().futureCall(request);
   *   // Do something.
   *   Webhook response = future.get();
   * }
   * }
   */
  public final UnaryCallable createWebhookCallable() {
    return stub.createWebhookCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Updates the specified webhook.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   Webhook webhook = Webhook.newBuilder().build();
   *   FieldMask updateMask = FieldMask.newBuilder().build();
   *   Webhook response = webhooksClient.updateWebhook(webhook, updateMask);
   * }
   * }
   *
   * @param webhook Required. The webhook to update.
   * @param updateMask The mask to control which fields get updated. If the mask is not present, all
   *     fields will be updated.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final Webhook updateWebhook(Webhook webhook, FieldMask updateMask) {
    UpdateWebhookRequest request =
        UpdateWebhookRequest.newBuilder().setWebhook(webhook).setUpdateMask(updateMask).build();
    return updateWebhook(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Updates the specified webhook.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   UpdateWebhookRequest request =
   *       UpdateWebhookRequest.newBuilder()
   *           .setWebhook(Webhook.newBuilder().build())
   *           .setUpdateMask(FieldMask.newBuilder().build())
   *           .build();
   *   Webhook response = webhooksClient.updateWebhook(request);
   * }
   * }
   *
   * @param request The request object containing all of the parameters for the API call.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final Webhook updateWebhook(UpdateWebhookRequest request) {
    return updateWebhookCallable().call(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Updates the specified webhook.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   UpdateWebhookRequest request =
   *       UpdateWebhookRequest.newBuilder()
   *           .setWebhook(Webhook.newBuilder().build())
   *           .setUpdateMask(FieldMask.newBuilder().build())
   *           .build();
   *   ApiFuture future = webhooksClient.updateWebhookCallable().futureCall(request);
   *   // Do something.
   *   Webhook response = future.get();
   * }
   * }
   */
  public final UnaryCallable updateWebhookCallable() {
    return stub.updateWebhookCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Deletes the specified webhook.
   *
   * Sample code:
   *
   * 
{@code
   * // 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]");
   *   webhooksClient.deleteWebhook(name);
   * }
   * }
   *
   * @param name Required. The name of the webhook to delete. Format:
   *     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final void deleteWebhook(WebhookName name) {
    DeleteWebhookRequest request =
        DeleteWebhookRequest.newBuilder().setName(name == null ? null : name.toString()).build();
    deleteWebhook(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Deletes the specified webhook.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   String name = WebhookName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]").toString();
   *   webhooksClient.deleteWebhook(name);
   * }
   * }
   *
   * @param name Required. The name of the webhook to delete. Format:
   *     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final void deleteWebhook(String name) {
    DeleteWebhookRequest request = DeleteWebhookRequest.newBuilder().setName(name).build();
    deleteWebhook(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Deletes the specified webhook.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   DeleteWebhookRequest request =
   *       DeleteWebhookRequest.newBuilder()
   *           .setName(WebhookName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]").toString())
   *           .setForce(true)
   *           .build();
   *   webhooksClient.deleteWebhook(request);
   * }
   * }
   *
   * @param request The request object containing all of the parameters for the API call.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final void deleteWebhook(DeleteWebhookRequest request) {
    deleteWebhookCallable().call(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Deletes the specified webhook.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   DeleteWebhookRequest request =
   *       DeleteWebhookRequest.newBuilder()
   *           .setName(WebhookName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]").toString())
   *           .setForce(true)
   *           .build();
   *   ApiFuture future = webhooksClient.deleteWebhookCallable().futureCall(request);
   *   // Do something.
   *   future.get();
   * }
   * }
   */
  public final UnaryCallable deleteWebhookCallable() {
    return stub.deleteWebhookCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Lists information about the supported locations for this service.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   ListLocationsRequest request =
   *       ListLocationsRequest.newBuilder()
   *           .setName("name3373707")
   *           .setFilter("filter-1274492040")
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .build();
   *   for (Location element : webhooksClient.listLocations(request).iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }
   *
   * @param request The request object containing all of the parameters for the API call.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final ListLocationsPagedResponse listLocations(ListLocationsRequest request) {
    return listLocationsPagedCallable().call(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Lists information about the supported locations for this service.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   ListLocationsRequest request =
   *       ListLocationsRequest.newBuilder()
   *           .setName("name3373707")
   *           .setFilter("filter-1274492040")
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .build();
   *   ApiFuture future = webhooksClient.listLocationsPagedCallable().futureCall(request);
   *   // Do something.
   *   for (Location element : future.get().iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }
   */
  public final UnaryCallable
      listLocationsPagedCallable() {
    return stub.listLocationsPagedCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Lists information about the supported locations for this service.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   ListLocationsRequest request =
   *       ListLocationsRequest.newBuilder()
   *           .setName("name3373707")
   *           .setFilter("filter-1274492040")
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .build();
   *   while (true) {
   *     ListLocationsResponse response = webhooksClient.listLocationsCallable().call(request);
   *     for (Location element : response.getLocationsList()) {
   *       // doThingsWith(element);
   *     }
   *     String nextPageToken = response.getNextPageToken();
   *     if (!Strings.isNullOrEmpty(nextPageToken)) {
   *       request = request.toBuilder().setPageToken(nextPageToken).build();
   *     } else {
   *       break;
   *     }
   *   }
   * }
   * }
   */
  public final UnaryCallable listLocationsCallable() {
    return stub.listLocationsCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Gets information about a location.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   *   Location response = webhooksClient.getLocation(request);
   * }
   * }
   *
   * @param request The request object containing all of the parameters for the API call.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final Location getLocation(GetLocationRequest request) {
    return getLocationCallable().call(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Gets information about a location.
   *
   * Sample code:
   *
   * 
{@code
   * // 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()) {
   *   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   *   ApiFuture future = webhooksClient.getLocationCallable().futureCall(request);
   *   // Do something.
   *   Location response = future.get();
   * }
   * }
   */
  public final UnaryCallable getLocationCallable() {
    return stub.getLocationCallable();
  }

  @Override
  public final void close() {
    stub.close();
  }

  @Override
  public void shutdown() {
    stub.shutdown();
  }

  @Override
  public boolean isShutdown() {
    return stub.isShutdown();
  }

  @Override
  public boolean isTerminated() {
    return stub.isTerminated();
  }

  @Override
  public void shutdownNow() {
    stub.shutdownNow();
  }

  @Override
  public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
    return stub.awaitTermination(duration, unit);
  }

  public static class ListWebhooksPagedResponse
      extends AbstractPagedListResponse<
          ListWebhooksRequest,
          ListWebhooksResponse,
          Webhook,
          ListWebhooksPage,
          ListWebhooksFixedSizeCollection> {

    public static ApiFuture createAsync(
        PageContext context,
        ApiFuture futureResponse) {
      ApiFuture futurePage =
          ListWebhooksPage.createEmptyPage().createPageAsync(context, futureResponse);
      return ApiFutures.transform(
          futurePage,
          input -> new ListWebhooksPagedResponse(input),
          MoreExecutors.directExecutor());
    }

    private ListWebhooksPagedResponse(ListWebhooksPage page) {
      super(page, ListWebhooksFixedSizeCollection.createEmptyCollection());
    }
  }

  public static class ListWebhooksPage
      extends AbstractPage {

    private ListWebhooksPage(
        PageContext context,
        ListWebhooksResponse response) {
      super(context, response);
    }

    private static ListWebhooksPage createEmptyPage() {
      return new ListWebhooksPage(null, null);
    }

    @Override
    protected ListWebhooksPage createPage(
        PageContext context,
        ListWebhooksResponse response) {
      return new ListWebhooksPage(context, response);
    }

    @Override
    public ApiFuture createPageAsync(
        PageContext context,
        ApiFuture futureResponse) {
      return super.createPageAsync(context, futureResponse);
    }
  }

  public static class ListWebhooksFixedSizeCollection
      extends AbstractFixedSizeCollection<
          ListWebhooksRequest,
          ListWebhooksResponse,
          Webhook,
          ListWebhooksPage,
          ListWebhooksFixedSizeCollection> {

    private ListWebhooksFixedSizeCollection(List pages, int collectionSize) {
      super(pages, collectionSize);
    }

    private static ListWebhooksFixedSizeCollection createEmptyCollection() {
      return new ListWebhooksFixedSizeCollection(null, 0);
    }

    @Override
    protected ListWebhooksFixedSizeCollection createCollection(
        List pages, int collectionSize) {
      return new ListWebhooksFixedSizeCollection(pages, collectionSize);
    }
  }

  public static class ListLocationsPagedResponse
      extends AbstractPagedListResponse<
          ListLocationsRequest,
          ListLocationsResponse,
          Location,
          ListLocationsPage,
          ListLocationsFixedSizeCollection> {

    public static ApiFuture createAsync(
        PageContext context,
        ApiFuture futureResponse) {
      ApiFuture futurePage =
          ListLocationsPage.createEmptyPage().createPageAsync(context, futureResponse);
      return ApiFutures.transform(
          futurePage,
          input -> new ListLocationsPagedResponse(input),
          MoreExecutors.directExecutor());
    }

    private ListLocationsPagedResponse(ListLocationsPage page) {
      super(page, ListLocationsFixedSizeCollection.createEmptyCollection());
    }
  }

  public static class ListLocationsPage
      extends AbstractPage<
          ListLocationsRequest, ListLocationsResponse, Location, ListLocationsPage> {

    private ListLocationsPage(
        PageContext context,
        ListLocationsResponse response) {
      super(context, response);
    }

    private static ListLocationsPage createEmptyPage() {
      return new ListLocationsPage(null, null);
    }

    @Override
    protected ListLocationsPage createPage(
        PageContext context,
        ListLocationsResponse response) {
      return new ListLocationsPage(context, response);
    }

    @Override
    public ApiFuture createPageAsync(
        PageContext context,
        ApiFuture futureResponse) {
      return super.createPageAsync(context, futureResponse);
    }
  }

  public static class ListLocationsFixedSizeCollection
      extends AbstractFixedSizeCollection<
          ListLocationsRequest,
          ListLocationsResponse,
          Location,
          ListLocationsPage,
          ListLocationsFixedSizeCollection> {

    private ListLocationsFixedSizeCollection(List pages, int collectionSize) {
      super(pages, collectionSize);
    }

    private static ListLocationsFixedSizeCollection createEmptyCollection() {
      return new ListLocationsFixedSizeCollection(null, 0);
    }

    @Override
    protected ListLocationsFixedSizeCollection createCollection(
        List pages, int collectionSize) {
      return new ListLocationsFixedSizeCollection(pages, collectionSize);
    }
  }
}
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() * *