CatalogServiceClient.java

/*
 * Copyright 2021 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.retail.v2;

import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
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.retail.v2.stub.CatalogServiceStub;
import com.google.cloud.retail.v2.stub.CatalogServiceStubSettings;
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 catalog configuration.
 *
 * <p>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:
 *
 * <pre>{@code
 * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
 *   Catalog catalog = Catalog.newBuilder().build();
 *   FieldMask updateMask = FieldMask.newBuilder().build();
 *   Catalog response = catalogServiceClient.updateCatalog(catalog, updateMask);
 * }
 * }</pre>
 *
 * <p>Note: close() needs to be called on the CatalogServiceClient object to clean up resources such
 * as threads. In the example above, try-with-resources is used, which automatically calls close().
 *
 * <p>The surface of this class includes several types of Java methods for each of the API's
 * methods:
 *
 * <ol>
 *   <li>A "flattened" method. With this type of method, the fields of the request type have been
 *       converted into function parameters. It may be the case that not all fields are available as
 *       parameters, and not every API method will have a flattened method entry point.
 *   <li>A "request object" method. This type of method only takes one parameter, a request object,
 *       which must be constructed before the call. Not every API method will have a request object
 *       method.
 *   <li>A "callable" method. This type of method takes no parameters and returns an immutable API
 *       callable object, which can be used to initiate calls to the service.
 * </ol>
 *
 * <p>See the individual methods for example code.
 *
 * <p>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.
 *
 * <p>This class can be customized by passing in a custom instance of CatalogServiceSettings to
 * create(). For example:
 *
 * <p>To customize credentials:
 *
 * <pre>{@code
 * CatalogServiceSettings catalogServiceSettings =
 *     CatalogServiceSettings.newBuilder()
 *         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
 *         .build();
 * CatalogServiceClient catalogServiceClient = CatalogServiceClient.create(catalogServiceSettings);
 * }</pre>
 *
 * <p>To customize the endpoint:
 *
 * <pre>{@code
 * CatalogServiceSettings catalogServiceSettings =
 *     CatalogServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 * CatalogServiceClient catalogServiceClient = CatalogServiceClient.create(catalogServiceSettings);
 * }</pre>
 *
 * <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
 */
@Generated("by gapic-generator-java")
public class CatalogServiceClient implements BackgroundResource {
  private final CatalogServiceSettings settings;
  private final CatalogServiceStub stub;

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

  /**
   * Constructs an instance of CatalogServiceClient, 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 CatalogServiceClient create(CatalogServiceSettings settings)
      throws IOException {
    return new CatalogServiceClient(settings);
  }

  /**
   * Constructs an instance of CatalogServiceClient, using the given stub for making calls. This is
   * for advanced usage - prefer using create(CatalogServiceSettings).
   */
  @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
  public static final CatalogServiceClient create(CatalogServiceStub stub) {
    return new CatalogServiceClient(stub);
  }

  /**
   * Constructs an instance of CatalogServiceClient, 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 CatalogServiceClient(CatalogServiceSettings settings) throws IOException {
    this.settings = settings;
    this.stub = ((CatalogServiceStubSettings) settings.getStubSettings()).createStub();
  }

  @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
  protected CatalogServiceClient(CatalogServiceStub stub) {
    this.settings = null;
    this.stub = stub;
  }

  public final CatalogServiceSettings getSettings() {
    return settings;
  }

  @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
  public CatalogServiceStub getStub() {
    return stub;
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Lists all the [Catalog][google.cloud.retail.v2.Catalog]s associated with the project.
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   *   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   *   for (Catalog element : catalogServiceClient.listCatalogs(parent).iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }</pre>
   *
   * @param parent Required. The account resource name with an associated location.
   *     <p>If the caller does not have permission to list
   *     [Catalog][google.cloud.retail.v2.Catalog]s under this location, regardless of whether or
   *     not this location exists, a PERMISSION_DENIED error is returned.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final ListCatalogsPagedResponse listCatalogs(LocationName parent) {
    ListCatalogsRequest request =
        ListCatalogsRequest.newBuilder()
            .setParent(parent == null ? null : parent.toString())
            .build();
    return listCatalogs(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Lists all the [Catalog][google.cloud.retail.v2.Catalog]s associated with the project.
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   *   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   *   for (Catalog element : catalogServiceClient.listCatalogs(parent).iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }</pre>
   *
   * @param parent Required. The account resource name with an associated location.
   *     <p>If the caller does not have permission to list
   *     [Catalog][google.cloud.retail.v2.Catalog]s under this location, regardless of whether or
   *     not this location exists, a PERMISSION_DENIED error is returned.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final ListCatalogsPagedResponse listCatalogs(String parent) {
    ListCatalogsRequest request = ListCatalogsRequest.newBuilder().setParent(parent).build();
    return listCatalogs(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Lists all the [Catalog][google.cloud.retail.v2.Catalog]s associated with the project.
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   *   ListCatalogsRequest request =
   *       ListCatalogsRequest.newBuilder()
   *           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .build();
   *   for (Catalog element : catalogServiceClient.listCatalogs(request).iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }</pre>
   *
   * @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 ListCatalogsPagedResponse listCatalogs(ListCatalogsRequest request) {
    return listCatalogsPagedCallable().call(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Lists all the [Catalog][google.cloud.retail.v2.Catalog]s associated with the project.
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   *   ListCatalogsRequest request =
   *       ListCatalogsRequest.newBuilder()
   *           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .build();
   *   ApiFuture<Catalog> future =
   *       catalogServiceClient.listCatalogsPagedCallable().futureCall(request);
   *   // Do something.
   *   for (Catalog element : future.get().iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }</pre>
   */
  public final UnaryCallable<ListCatalogsRequest, ListCatalogsPagedResponse>
      listCatalogsPagedCallable() {
    return stub.listCatalogsPagedCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Lists all the [Catalog][google.cloud.retail.v2.Catalog]s associated with the project.
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   *   ListCatalogsRequest request =
   *       ListCatalogsRequest.newBuilder()
   *           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .build();
   *   while (true) {
   *     ListCatalogsResponse response = catalogServiceClient.listCatalogsCallable().call(request);
   *     for (Catalog element : response.getResponsesList()) {
   *       // doThingsWith(element);
   *     }
   *     String nextPageToken = response.getNextPageToken();
   *     if (!Strings.isNullOrEmpty(nextPageToken)) {
   *       request = request.toBuilder().setPageToken(nextPageToken).build();
   *     } else {
   *       break;
   *     }
   *   }
   * }
   * }</pre>
   */
  public final UnaryCallable<ListCatalogsRequest, ListCatalogsResponse> listCatalogsCallable() {
    return stub.listCatalogsCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Updates the [Catalog][google.cloud.retail.v2.Catalog]s.
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   *   Catalog catalog = Catalog.newBuilder().build();
   *   FieldMask updateMask = FieldMask.newBuilder().build();
   *   Catalog response = catalogServiceClient.updateCatalog(catalog, updateMask);
   * }
   * }</pre>
   *
   * @param catalog Required. The [Catalog][google.cloud.retail.v2.Catalog] to update.
   *     <p>If the caller does not have permission to update the
   *     [Catalog][google.cloud.retail.v2.Catalog], regardless of whether or not it exists, a
   *     PERMISSION_DENIED error is returned.
   *     <p>If the [Catalog][google.cloud.retail.v2.Catalog] to update does not exist, a NOT_FOUND
   *     error is returned.
   * @param updateMask Indicates which fields in the provided
   *     [Catalog][google.cloud.retail.v2.Catalog] to update.
   *     <p>If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final Catalog updateCatalog(Catalog catalog, FieldMask updateMask) {
    UpdateCatalogRequest request =
        UpdateCatalogRequest.newBuilder().setCatalog(catalog).setUpdateMask(updateMask).build();
    return updateCatalog(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Updates the [Catalog][google.cloud.retail.v2.Catalog]s.
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   *   UpdateCatalogRequest request =
   *       UpdateCatalogRequest.newBuilder()
   *           .setCatalog(Catalog.newBuilder().build())
   *           .setUpdateMask(FieldMask.newBuilder().build())
   *           .build();
   *   Catalog response = catalogServiceClient.updateCatalog(request);
   * }
   * }</pre>
   *
   * @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 Catalog updateCatalog(UpdateCatalogRequest request) {
    return updateCatalogCallable().call(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Updates the [Catalog][google.cloud.retail.v2.Catalog]s.
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   *   UpdateCatalogRequest request =
   *       UpdateCatalogRequest.newBuilder()
   *           .setCatalog(Catalog.newBuilder().build())
   *           .setUpdateMask(FieldMask.newBuilder().build())
   *           .build();
   *   ApiFuture<Catalog> future = catalogServiceClient.updateCatalogCallable().futureCall(request);
   *   // Do something.
   *   Catalog response = future.get();
   * }
   * }</pre>
   */
  public final UnaryCallable<UpdateCatalogRequest, Catalog> updateCatalogCallable() {
    return stub.updateCatalogCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Set a specified branch id as default branch. API methods such as
   * [SearchService.Search][google.cloud.retail.v2.SearchService.Search],
   * [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct],
   * [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts] will treat
   * requests using "default_branch" to the actual branch id set as default.
   *
   * <p>For example, if `projects/&#42;/locations/&#42;/catalogs/&#42;/branches/1` is set as
   * default, setting [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to
   * `projects/&#42;/locations/&#42;/catalogs/&#42;/branches/default_branch` is equivalent to
   * setting [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to
   * `projects/&#42;/locations/&#42;/catalogs/&#42;/branches/1`.
   *
   * <p>Using multiple branches can be useful when developers would like to have a staging branch to
   * test and verify for future usage. When it becomes ready, developers switch on the staging
   * branch using this API while keeping using
   * `projects/&#42;/locations/&#42;/catalogs/&#42;/branches/default_branch` as
   * [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to route the traffic to
   * this staging branch.
   *
   * <p>CAUTION: If you have live predict/search traffic, switching the default branch could
   * potentially cause outages if the ID space of the new branch is very different from the old one.
   *
   * <p>More specifically:
   *
   * <ul>
   *   <li>PredictionService will only return product IDs from branch {newBranch}.
   *   <li>SearchService will only return product IDs from branch {newBranch} (if branch is not
   *       explicitly set).
   *   <li>UserEventService will only join events with products from branch {newBranch}.
   * </ul>
   *
   * <p>This feature is only available for users who have Retail Search enabled. Contact Retail
   * Support (retail-search-support{@literal @}google.com) if you are interested in using Retail
   * Search.
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   *   CatalogName catalog = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]");
   *   catalogServiceClient.setDefaultBranch(catalog);
   * }
   * }</pre>
   *
   * @param catalog Full resource name of the catalog, such as
   *     `projects/&#42;/locations/global/catalogs/default_catalog`.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final void setDefaultBranch(CatalogName catalog) {
    SetDefaultBranchRequest request =
        SetDefaultBranchRequest.newBuilder()
            .setCatalog(catalog == null ? null : catalog.toString())
            .build();
    setDefaultBranch(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Set a specified branch id as default branch. API methods such as
   * [SearchService.Search][google.cloud.retail.v2.SearchService.Search],
   * [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct],
   * [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts] will treat
   * requests using "default_branch" to the actual branch id set as default.
   *
   * <p>For example, if `projects/&#42;/locations/&#42;/catalogs/&#42;/branches/1` is set as
   * default, setting [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to
   * `projects/&#42;/locations/&#42;/catalogs/&#42;/branches/default_branch` is equivalent to
   * setting [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to
   * `projects/&#42;/locations/&#42;/catalogs/&#42;/branches/1`.
   *
   * <p>Using multiple branches can be useful when developers would like to have a staging branch to
   * test and verify for future usage. When it becomes ready, developers switch on the staging
   * branch using this API while keeping using
   * `projects/&#42;/locations/&#42;/catalogs/&#42;/branches/default_branch` as
   * [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to route the traffic to
   * this staging branch.
   *
   * <p>CAUTION: If you have live predict/search traffic, switching the default branch could
   * potentially cause outages if the ID space of the new branch is very different from the old one.
   *
   * <p>More specifically:
   *
   * <ul>
   *   <li>PredictionService will only return product IDs from branch {newBranch}.
   *   <li>SearchService will only return product IDs from branch {newBranch} (if branch is not
   *       explicitly set).
   *   <li>UserEventService will only join events with products from branch {newBranch}.
   * </ul>
   *
   * <p>This feature is only available for users who have Retail Search enabled. Contact Retail
   * Support (retail-search-support{@literal @}google.com) if you are interested in using Retail
   * Search.
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   *   String catalog = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString();
   *   catalogServiceClient.setDefaultBranch(catalog);
   * }
   * }</pre>
   *
   * @param catalog Full resource name of the catalog, such as
   *     `projects/&#42;/locations/global/catalogs/default_catalog`.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final void setDefaultBranch(String catalog) {
    SetDefaultBranchRequest request =
        SetDefaultBranchRequest.newBuilder().setCatalog(catalog).build();
    setDefaultBranch(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Set a specified branch id as default branch. API methods such as
   * [SearchService.Search][google.cloud.retail.v2.SearchService.Search],
   * [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct],
   * [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts] will treat
   * requests using "default_branch" to the actual branch id set as default.
   *
   * <p>For example, if `projects/&#42;/locations/&#42;/catalogs/&#42;/branches/1` is set as
   * default, setting [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to
   * `projects/&#42;/locations/&#42;/catalogs/&#42;/branches/default_branch` is equivalent to
   * setting [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to
   * `projects/&#42;/locations/&#42;/catalogs/&#42;/branches/1`.
   *
   * <p>Using multiple branches can be useful when developers would like to have a staging branch to
   * test and verify for future usage. When it becomes ready, developers switch on the staging
   * branch using this API while keeping using
   * `projects/&#42;/locations/&#42;/catalogs/&#42;/branches/default_branch` as
   * [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to route the traffic to
   * this staging branch.
   *
   * <p>CAUTION: If you have live predict/search traffic, switching the default branch could
   * potentially cause outages if the ID space of the new branch is very different from the old one.
   *
   * <p>More specifically:
   *
   * <ul>
   *   <li>PredictionService will only return product IDs from branch {newBranch}.
   *   <li>SearchService will only return product IDs from branch {newBranch} (if branch is not
   *       explicitly set).
   *   <li>UserEventService will only join events with products from branch {newBranch}.
   * </ul>
   *
   * <p>This feature is only available for users who have Retail Search enabled. Contact Retail
   * Support (retail-search-support{@literal @}google.com) if you are interested in using Retail
   * Search.
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   *   SetDefaultBranchRequest request =
   *       SetDefaultBranchRequest.newBuilder()
   *           .setCatalog(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
   *           .setBranchId(
   *               BranchName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[BRANCH]").toString())
   *           .setNote("note3387378")
   *           .build();
   *   catalogServiceClient.setDefaultBranch(request);
   * }
   * }</pre>
   *
   * @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 setDefaultBranch(SetDefaultBranchRequest request) {
    setDefaultBranchCallable().call(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Set a specified branch id as default branch. API methods such as
   * [SearchService.Search][google.cloud.retail.v2.SearchService.Search],
   * [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct],
   * [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts] will treat
   * requests using "default_branch" to the actual branch id set as default.
   *
   * <p>For example, if `projects/&#42;/locations/&#42;/catalogs/&#42;/branches/1` is set as
   * default, setting [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to
   * `projects/&#42;/locations/&#42;/catalogs/&#42;/branches/default_branch` is equivalent to
   * setting [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to
   * `projects/&#42;/locations/&#42;/catalogs/&#42;/branches/1`.
   *
   * <p>Using multiple branches can be useful when developers would like to have a staging branch to
   * test and verify for future usage. When it becomes ready, developers switch on the staging
   * branch using this API while keeping using
   * `projects/&#42;/locations/&#42;/catalogs/&#42;/branches/default_branch` as
   * [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to route the traffic to
   * this staging branch.
   *
   * <p>CAUTION: If you have live predict/search traffic, switching the default branch could
   * potentially cause outages if the ID space of the new branch is very different from the old one.
   *
   * <p>More specifically:
   *
   * <ul>
   *   <li>PredictionService will only return product IDs from branch {newBranch}.
   *   <li>SearchService will only return product IDs from branch {newBranch} (if branch is not
   *       explicitly set).
   *   <li>UserEventService will only join events with products from branch {newBranch}.
   * </ul>
   *
   * <p>This feature is only available for users who have Retail Search enabled. Contact Retail
   * Support (retail-search-support{@literal @}google.com) if you are interested in using Retail
   * Search.
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   *   SetDefaultBranchRequest request =
   *       SetDefaultBranchRequest.newBuilder()
   *           .setCatalog(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
   *           .setBranchId(
   *               BranchName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[BRANCH]").toString())
   *           .setNote("note3387378")
   *           .build();
   *   ApiFuture<Empty> future = catalogServiceClient.setDefaultBranchCallable().futureCall(request);
   *   // Do something.
   *   future.get();
   * }
   * }</pre>
   */
  public final UnaryCallable<SetDefaultBranchRequest, Empty> setDefaultBranchCallable() {
    return stub.setDefaultBranchCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Get which branch is currently default branch set by
   * [CatalogService.SetDefaultBranch][google.cloud.retail.v2.CatalogService.SetDefaultBranch]
   * method under a specified parent catalog.
   *
   * <p>This feature is only available for users who have Retail Search enabled. Contact Retail
   * Support (retail-search-support{@literal @}google.com) if you are interested in using Retail
   * Search.
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   *   CatalogName catalog = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]");
   *   GetDefaultBranchResponse response = catalogServiceClient.getDefaultBranch(catalog);
   * }
   * }</pre>
   *
   * @param catalog The parent catalog resource name, such as
   *     `projects/&#42;/locations/global/catalogs/default_catalog`.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final GetDefaultBranchResponse getDefaultBranch(CatalogName catalog) {
    GetDefaultBranchRequest request =
        GetDefaultBranchRequest.newBuilder()
            .setCatalog(catalog == null ? null : catalog.toString())
            .build();
    return getDefaultBranch(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Get which branch is currently default branch set by
   * [CatalogService.SetDefaultBranch][google.cloud.retail.v2.CatalogService.SetDefaultBranch]
   * method under a specified parent catalog.
   *
   * <p>This feature is only available for users who have Retail Search enabled. Contact Retail
   * Support (retail-search-support{@literal @}google.com) if you are interested in using Retail
   * Search.
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   *   String catalog = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString();
   *   GetDefaultBranchResponse response = catalogServiceClient.getDefaultBranch(catalog);
   * }
   * }</pre>
   *
   * @param catalog The parent catalog resource name, such as
   *     `projects/&#42;/locations/global/catalogs/default_catalog`.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final GetDefaultBranchResponse getDefaultBranch(String catalog) {
    GetDefaultBranchRequest request =
        GetDefaultBranchRequest.newBuilder().setCatalog(catalog).build();
    return getDefaultBranch(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Get which branch is currently default branch set by
   * [CatalogService.SetDefaultBranch][google.cloud.retail.v2.CatalogService.SetDefaultBranch]
   * method under a specified parent catalog.
   *
   * <p>This feature is only available for users who have Retail Search enabled. Contact Retail
   * Support (retail-search-support{@literal @}google.com) if you are interested in using Retail
   * Search.
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   *   GetDefaultBranchRequest request =
   *       GetDefaultBranchRequest.newBuilder()
   *           .setCatalog(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
   *           .build();
   *   GetDefaultBranchResponse response = catalogServiceClient.getDefaultBranch(request);
   * }
   * }</pre>
   *
   * @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 GetDefaultBranchResponse getDefaultBranch(GetDefaultBranchRequest request) {
    return getDefaultBranchCallable().call(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Get which branch is currently default branch set by
   * [CatalogService.SetDefaultBranch][google.cloud.retail.v2.CatalogService.SetDefaultBranch]
   * method under a specified parent catalog.
   *
   * <p>This feature is only available for users who have Retail Search enabled. Contact Retail
   * Support (retail-search-support{@literal @}google.com) if you are interested in using Retail
   * Search.
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   *   GetDefaultBranchRequest request =
   *       GetDefaultBranchRequest.newBuilder()
   *           .setCatalog(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
   *           .build();
   *   ApiFuture<GetDefaultBranchResponse> future =
   *       catalogServiceClient.getDefaultBranchCallable().futureCall(request);
   *   // Do something.
   *   GetDefaultBranchResponse response = future.get();
   * }
   * }</pre>
   */
  public final UnaryCallable<GetDefaultBranchRequest, GetDefaultBranchResponse>
      getDefaultBranchCallable() {
    return stub.getDefaultBranchCallable();
  }

  @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 ListCatalogsPagedResponse
      extends AbstractPagedListResponse<
          ListCatalogsRequest,
          ListCatalogsResponse,
          Catalog,
          ListCatalogsPage,
          ListCatalogsFixedSizeCollection> {

    public static ApiFuture<ListCatalogsPagedResponse> createAsync(
        PageContext<ListCatalogsRequest, ListCatalogsResponse, Catalog> context,
        ApiFuture<ListCatalogsResponse> futureResponse) {
      ApiFuture<ListCatalogsPage> futurePage =
          ListCatalogsPage.createEmptyPage().createPageAsync(context, futureResponse);
      return ApiFutures.transform(
          futurePage,
          input -> new ListCatalogsPagedResponse(input),
          MoreExecutors.directExecutor());
    }

    private ListCatalogsPagedResponse(ListCatalogsPage page) {
      super(page, ListCatalogsFixedSizeCollection.createEmptyCollection());
    }
  }

  public static class ListCatalogsPage
      extends AbstractPage<ListCatalogsRequest, ListCatalogsResponse, Catalog, ListCatalogsPage> {

    private ListCatalogsPage(
        PageContext<ListCatalogsRequest, ListCatalogsResponse, Catalog> context,
        ListCatalogsResponse response) {
      super(context, response);
    }

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

    @Override
    protected ListCatalogsPage createPage(
        PageContext<ListCatalogsRequest, ListCatalogsResponse, Catalog> context,
        ListCatalogsResponse response) {
      return new ListCatalogsPage(context, response);
    }

    @Override
    public ApiFuture<ListCatalogsPage> createPageAsync(
        PageContext<ListCatalogsRequest, ListCatalogsResponse, Catalog> context,
        ApiFuture<ListCatalogsResponse> futureResponse) {
      return super.createPageAsync(context, futureResponse);
    }
  }

  public static class ListCatalogsFixedSizeCollection
      extends AbstractFixedSizeCollection<
          ListCatalogsRequest,
          ListCatalogsResponse,
          Catalog,
          ListCatalogsPage,
          ListCatalogsFixedSizeCollection> {

    private ListCatalogsFixedSizeCollection(List<ListCatalogsPage> pages, int collectionSize) {
      super(pages, collectionSize);
    }

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

    @Override
    protected ListCatalogsFixedSizeCollection createCollection(
        List<ListCatalogsPage> pages, int collectionSize) {
      return new ListCatalogsFixedSizeCollection(pages, collectionSize);
    }
  }
}