Class BranchServiceClient (2.55.0)

GitHub RepositoryProduct Reference

Service Description: Service for Branch Management

Branches are automatically created when a Catalog is created. There are fixed three branches in each catalog, and may use 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 under the specified parent 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.

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.

Inheritance

java.lang.Object > BranchServiceClient

Static Methods

create()

public static final BranchServiceClient create()

Constructs an instance of BranchServiceClient with default settings.

Returns
Type Description
BranchServiceClient
Exceptions
Type Description
IOException

create(BranchServiceSettings settings)

public static final BranchServiceClient create(BranchServiceSettings settings)

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.

Parameter
Name Description
settings BranchServiceSettings
Returns
Type Description
BranchServiceClient
Exceptions
Type Description
IOException

create(BranchServiceStub stub)

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).

Parameter
Name Description
stub BranchServiceStub
Returns
Type Description
BranchServiceClient

Constructors

BranchServiceClient(BranchServiceSettings settings)

protected BranchServiceClient(BranchServiceSettings settings)

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.

Parameter
Name Description
settings BranchServiceSettings

BranchServiceClient(BranchServiceStub stub)

protected BranchServiceClient(BranchServiceStub stub)
Parameter
Name Description
stub BranchServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

getBranch(BranchName name)

public final Branch getBranch(BranchName name)

Retrieves a 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);
 }
Parameter
Name Description
name BranchName

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.
Returns
Type Description
Branch

getBranch(GetBranchRequest request)

public final Branch getBranch(GetBranchRequest request)

Retrieves a 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);
 }
Parameter
Name Description
request GetBranchRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Branch

getBranch(String name)

public final Branch getBranch(String name)

Retrieves a 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);
 }
Parameter
Name Description
name String

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.
Returns
Type Description
Branch

getBranchCallable()

public final UnaryCallable<GetBranchRequest,Branch> getBranchCallable()

Retrieves a 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();
 }
Returns
Type Description
UnaryCallable<GetBranchRequest,Branch>

getSettings()

public final BranchServiceSettings getSettings()
Returns
Type Description
BranchServiceSettings

getStub()

public BranchServiceStub getStub()
Returns
Type Description
BranchServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listBranches(CatalogName parent)

public final ListBranchesResponse listBranches(CatalogName parent)

Lists all instances of Branch under the specified parent 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);
 }
Parameter
Name Description
parent CatalogName

Required. The parent catalog resource name.
Returns
Type Description
ListBranchesResponse

listBranches(ListBranchesRequest request)

public final ListBranchesResponse listBranches(ListBranchesRequest request)

Lists all instances of Branch under the specified parent 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);
 }
Parameter
Name Description
request ListBranchesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ListBranchesResponse

listBranches(String parent)

public final ListBranchesResponse listBranches(String parent)

Lists all instances of Branch under the specified parent 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);
 }
Parameter
Name Description
parent String

Required. The parent catalog resource name.
Returns
Type Description
ListBranchesResponse

listBranchesCallable()

public final UnaryCallable<ListBranchesRequest,ListBranchesResponse> listBranchesCallable()

Lists all instances of Branch under the specified parent 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();
 }
Returns
Type Description
UnaryCallable<ListBranchesRequest,ListBranchesResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()