Package com.google.cloud.retail.v2alpha

Class BranchServiceClient

java.lang.Object
com.google.cloud.retail.v2alpha.BranchServiceClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@BetaApi @Generated("by gapic-generator-java") public class BranchServiceClient extends Object implements BackgroundResource
Service Description: Service for [Branch][google.cloud.retail.v2alpha.Branch] Management

[Branch][google.cloud.retail.v2alpha.Branch]es are automatically created when a [Catalog][google.cloud.retail.v2alpha.Catalog] is created. There are fixed three branches in each catalog, and may use [ListBranches][google.cloud.retail.v2alpha.BranchService.ListBranches] method to get the details of all branches.

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 (BranchServiceClient branchServiceClient = BranchServiceClient.create()) {
   CatalogName parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]");
   ListBranchesResponse response = branchServiceClient.listBranches(parent);
 }

Note: close() needs to be called on the BranchServiceClient 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

ListBranches

Lists all instances of [Branch][google.cloud.retail.v2alpha.Branch] under the specified parent [Catalog][google.cloud.retail.v2alpha.Catalog].

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listBranches(ListBranchesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listBranches(CatalogName parent)

  • listBranches(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.

  • listBranchesCallable()

GetBranch

Retrieves a [Branch][google.cloud.retail.v2alpha.Branch].

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getBranch(GetBranchRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getBranch(BranchName name)

  • getBranch(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.

  • getBranchCallable()

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 BranchServiceSettings 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
 BranchServiceSettings branchServiceSettings =
     BranchServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BranchServiceClient branchServiceClient = BranchServiceClient.create(branchServiceSettings);

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
 BranchServiceSettings branchServiceSettings =
     BranchServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 BranchServiceClient branchServiceClient = BranchServiceClient.create(branchServiceSettings);

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
 BranchServiceSettings branchServiceSettings =
     BranchServiceSettings.newHttpJsonBuilder().build();
 BranchServiceClient branchServiceClient = BranchServiceClient.create(branchServiceSettings);

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

  • Constructor Details

    • BranchServiceClient

      protected BranchServiceClient(BranchServiceSettings settings) throws IOException
      Constructs an instance of BranchServiceClient, 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

    • BranchServiceClient

      protected BranchServiceClient(BranchServiceStub stub)

  • Method Details

    • create

      public static final BranchServiceClient create() throws IOException
      Constructs an instance of BranchServiceClient with default settings.
      Throws:
      IOException

    • create

      public static final BranchServiceClient create(BranchServiceSettings settings) throws IOException
      Constructs an instance of BranchServiceClient, 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 BranchServiceClient create(BranchServiceStub stub)
      Constructs an instance of BranchServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(BranchServiceSettings).

    • getSettings

      public final BranchServiceSettings getSettings()

    • getStub

      public BranchServiceStub getStub()

    • listBranches

      public final ListBranchesResponse listBranches(CatalogName parent)
      Lists all instances of [Branch][google.cloud.retail.v2alpha.Branch] under the specified parent [Catalog][google.cloud.retail.v2alpha.Catalog].

      Sample 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 (BranchServiceClient branchServiceClient = BranchServiceClient.create()) {
   CatalogName parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]");
   ListBranchesResponse response = branchServiceClient.listBranches(parent);
 }
      Parameters:
      parent - Required. The parent catalog resource name.
      Throws:
      ApiException - if the remote call fails

    • listBranches

      public final ListBranchesResponse listBranches(String parent)
      Lists all instances of [Branch][google.cloud.retail.v2alpha.Branch] under the specified parent [Catalog][google.cloud.retail.v2alpha.Catalog].

      Sample 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 (BranchServiceClient branchServiceClient = BranchServiceClient.create()) {
   String parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString();
   ListBranchesResponse response = branchServiceClient.listBranches(parent);
 }
      Parameters:
      parent - Required. The parent catalog resource name.
      Throws:
      ApiException - if the remote call fails

    • listBranches

      public final ListBranchesResponse listBranches(ListBranchesRequest request)
      Lists all instances of [Branch][google.cloud.retail.v2alpha.Branch] under the specified parent [Catalog][google.cloud.retail.v2alpha.Catalog].

      Sample 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 (BranchServiceClient branchServiceClient = BranchServiceClient.create()) {
   ListBranchesRequest request =
       ListBranchesRequest.newBuilder()
           .setParent(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
           .setView(BranchView.forNumber(0))
           .build();
   ListBranchesResponse response = branchServiceClient.listBranches(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listBranchesCallable

      public final UnaryCallable<ListBranchesRequest,ListBranchesResponse> listBranchesCallable()
      Lists all instances of [Branch][google.cloud.retail.v2alpha.Branch] under the specified parent [Catalog][google.cloud.retail.v2alpha.Catalog].

      Sample 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 (BranchServiceClient branchServiceClient = BranchServiceClient.create()) {
   ListBranchesRequest request =
       ListBranchesRequest.newBuilder()
           .setParent(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
           .setView(BranchView.forNumber(0))
           .build();
   ApiFuture<ListBranchesResponse> future =
       branchServiceClient.listBranchesCallable().futureCall(request);
   // Do something.
   ListBranchesResponse response = future.get();
 }

    • getBranch

      public final Branch getBranch(BranchName name)
      Retrieves a [Branch][google.cloud.retail.v2alpha.Branch].

      Sample 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 (BranchServiceClient branchServiceClient = BranchServiceClient.create()) {
   BranchName name = BranchName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[BRANCH]");
   Branch response = branchServiceClient.getBranch(name);
 }
      Parameters:
      name - Required. The name of the branch to retrieve. Format: `projects/*/locations/global/catalogs/default_catalog/branches/some_branch_id`.

      "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the catalog.

      Throws:
      ApiException - if the remote call fails

    • getBranch

      public final Branch getBranch(String name)
      Retrieves a [Branch][google.cloud.retail.v2alpha.Branch].

      Sample 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 (BranchServiceClient branchServiceClient = BranchServiceClient.create()) {
   String name = BranchName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[BRANCH]").toString();
   Branch response = branchServiceClient.getBranch(name);
 }
      Parameters:
      name - Required. The name of the branch to retrieve. Format: `projects/*/locations/global/catalogs/default_catalog/branches/some_branch_id`.

      "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the catalog.

      Throws:
      ApiException - if the remote call fails

    • getBranch

      public final Branch getBranch(GetBranchRequest request)
      Retrieves a [Branch][google.cloud.retail.v2alpha.Branch].

      Sample 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 (BranchServiceClient branchServiceClient = BranchServiceClient.create()) {
   GetBranchRequest request =
       GetBranchRequest.newBuilder()
           .setName(BranchName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[BRANCH]").toString())
           .setView(BranchView.forNumber(0))
           .build();
   Branch response = branchServiceClient.getBranch(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getBranchCallable

      public final UnaryCallable<GetBranchRequest,Branch> getBranchCallable()
      Retrieves a [Branch][google.cloud.retail.v2alpha.Branch].

      Sample 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 (BranchServiceClient branchServiceClient = BranchServiceClient.create()) {
   GetBranchRequest request =
       GetBranchRequest.newBuilder()
           .setName(BranchName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[BRANCH]").toString())
           .setView(BranchView.forNumber(0))
           .build();
   ApiFuture<Branch> future = branchServiceClient.getBranchCallable().futureCall(request);
   // Do something.
   Branch response = future.get();
 }

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable

    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface BackgroundResource

    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface BackgroundResource

    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface BackgroundResource

    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface BackgroundResource

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface BackgroundResource
      Throws:
      InterruptedException