Class ApiHubDependenciesClient (0.2.0)

Service Description: This service provides methods for various operations related to a Dependency in the API hub.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Dependency dependency = Dependency.newBuilder().build();
   String dependencyId = "dependencyId503788998";
   Dependency response =
       apiHubDependenciesClient.createDependency(parent, dependency, dependencyId);
 }
 

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

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 ApiHubDependenciesSettings 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
 ApiHubDependenciesSettings apiHubDependenciesSettings =
     ApiHubDependenciesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ApiHubDependenciesClient apiHubDependenciesClient =
     ApiHubDependenciesClient.create(apiHubDependenciesSettings);
 

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
 ApiHubDependenciesSettings apiHubDependenciesSettings =
     ApiHubDependenciesSettings.newBuilder().setEndpoint(myEndpoint).build();
 ApiHubDependenciesClient apiHubDependenciesClient =
     ApiHubDependenciesClient.create(apiHubDependenciesSettings);
 

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
 ApiHubDependenciesSettings apiHubDependenciesSettings =
     ApiHubDependenciesSettings.newHttpJsonBuilder().build();
 ApiHubDependenciesClient apiHubDependenciesClient =
     ApiHubDependenciesClient.create(apiHubDependenciesSettings);
 

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

Constructs an instance of ApiHubDependenciesClient with default settings.

Constructs an instance of ApiHubDependenciesClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Constructs an instance of ApiHubDependenciesClient, using the given stub for making calls. This is for advanced usage - prefer using create(ApiHubDependenciesSettings).

Constructs an instance of ApiHubDependenciesClient, 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.

Create a dependency between two entities in the API hub.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   CreateDependencyRequest request =
       CreateDependencyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDependencyId("dependencyId503788998")
           .setDependency(Dependency.newBuilder().build())
           .build();
   Dependency response = apiHubDependenciesClient.createDependency(request);
 }
 

Create a dependency between two entities in the API hub.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Dependency dependency = Dependency.newBuilder().build();
   String dependencyId = "dependencyId503788998";
   Dependency response =
       apiHubDependenciesClient.createDependency(parent, dependency, dependencyId);
 }
 

Create a dependency between two entities in the API hub.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Dependency dependency = Dependency.newBuilder().build();
   String dependencyId = "dependencyId503788998";
   Dependency response =
       apiHubDependenciesClient.createDependency(parent, dependency, dependencyId);
 }
 

Create a dependency between two entities in the API hub.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   CreateDependencyRequest request =
       CreateDependencyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDependencyId("dependencyId503788998")
           .setDependency(Dependency.newBuilder().build())
           .build();
   ApiFuture<Dependency> future =
       apiHubDependenciesClient.createDependencyCallable().futureCall(request);
   // Do something.
   Dependency response = future.get();
 }
 

Delete the dependency resource.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   DeleteDependencyRequest request =
       DeleteDependencyRequest.newBuilder()
           .setName(DependencyName.of("[PROJECT]", "[LOCATION]", "[DEPENDENCY]").toString())
           .build();
   apiHubDependenciesClient.deleteDependency(request);
 }
 

Delete the dependency resource.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   DependencyName name = DependencyName.of("[PROJECT]", "[LOCATION]", "[DEPENDENCY]");
   apiHubDependenciesClient.deleteDependency(name);
 }
 

Delete the dependency resource.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   String name = DependencyName.of("[PROJECT]", "[LOCATION]", "[DEPENDENCY]").toString();
   apiHubDependenciesClient.deleteDependency(name);
 }
 

Delete the dependency resource.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   DeleteDependencyRequest request =
       DeleteDependencyRequest.newBuilder()
           .setName(DependencyName.of("[PROJECT]", "[LOCATION]", "[DEPENDENCY]").toString())
           .build();
   ApiFuture<Empty> future =
       apiHubDependenciesClient.deleteDependencyCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Get details about a dependency resource in the API hub.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   DependencyName name = DependencyName.of("[PROJECT]", "[LOCATION]", "[DEPENDENCY]");
   Dependency response = apiHubDependenciesClient.getDependency(name);
 }
 

Get details about a dependency resource in the API hub.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   GetDependencyRequest request =
       GetDependencyRequest.newBuilder()
           .setName(DependencyName.of("[PROJECT]", "[LOCATION]", "[DEPENDENCY]").toString())
           .build();
   Dependency response = apiHubDependenciesClient.getDependency(request);
 }
 

Get details about a dependency resource in the API hub.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   String name = DependencyName.of("[PROJECT]", "[LOCATION]", "[DEPENDENCY]").toString();
   Dependency response = apiHubDependenciesClient.getDependency(name);
 }
 

Get details about a dependency resource in the API hub.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   GetDependencyRequest request =
       GetDependencyRequest.newBuilder()
           .setName(DependencyName.of("[PROJECT]", "[LOCATION]", "[DEPENDENCY]").toString())
           .build();
   ApiFuture<Dependency> future =
       apiHubDependenciesClient.getDependencyCallable().futureCall(request);
   // Do something.
   Dependency response = future.get();
 }
 

Gets information about a location.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = apiHubDependenciesClient.getLocation(request);
 }
 

Gets information about a location.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       apiHubDependenciesClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
 

List dependencies based on the provided filter and pagination parameters.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   ListDependenciesRequest request =
       ListDependenciesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Dependency element : apiHubDependenciesClient.listDependencies(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

List dependencies based on the provided filter and pagination parameters.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Dependency element : apiHubDependenciesClient.listDependencies(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

List dependencies based on the provided filter and pagination parameters.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Dependency element : apiHubDependenciesClient.listDependencies(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

List dependencies based on the provided filter and pagination parameters.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   ListDependenciesRequest request =
       ListDependenciesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListDependenciesResponse response =
         apiHubDependenciesClient.listDependenciesCallable().call(request);
     for (Dependency element : response.getDependenciesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

List dependencies based on the provided filter and pagination parameters.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   ListDependenciesRequest request =
       ListDependenciesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Dependency> future =
       apiHubDependenciesClient.listDependenciesPagedCallable().futureCall(request);
   // Do something.
   for (Dependency element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Lists information about the supported locations for this service.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : apiHubDependenciesClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Lists information about the supported locations for this service.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         apiHubDependenciesClient.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;
     }
   }
 }
 

Lists information about the supported locations for this service.

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       apiHubDependenciesClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Update a dependency based on the update_mask provided in the request.

The following fields in the dependency can be updated:

• description

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   Dependency dependency = Dependency.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Dependency response = apiHubDependenciesClient.updateDependency(dependency, updateMask);
 }
 

Update a dependency based on the update_mask provided in the request.

The following fields in the dependency can be updated:

• description

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   UpdateDependencyRequest request =
       UpdateDependencyRequest.newBuilder()
           .setDependency(Dependency.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Dependency response = apiHubDependenciesClient.updateDependency(request);
 }
 

Update a dependency based on the update_mask provided in the request.

The following fields in the dependency can be updated:

• description

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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
   UpdateDependencyRequest request =
       UpdateDependencyRequest.newBuilder()
           .setDependency(Dependency.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Dependency> future =
       apiHubDependenciesClient.updateDependencyCallable().futureCall(request);
   // Do something.
   Dependency response = future.get();
 }