com.google.cloud.apihub.v1.ApiHubPluginClient Maven / Gradle / Ivy
Show all versions of google-cloud-apihub Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.apihub.v1;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.apihub.v1.stub.ApiHubPluginStub;
import com.google.cloud.apihub.v1.stub.ApiHubPluginStubSettings;
import com.google.cloud.location.GetLocationRequest;
import com.google.cloud.location.ListLocationsRequest;
import com.google.cloud.location.ListLocationsResponse;
import com.google.cloud.location.Location;
import com.google.common.util.concurrent.MoreExecutors;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: This service is used for managing plugins inside 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:
*
*
{@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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
* PluginName name = PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]");
* Plugin response = apiHubPluginClient.getPlugin(name);
* }
* }
*
* Note: close() needs to be called on the ApiHubPluginClient 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
*
*
* GetPlugin
* Get details about an API Hub plugin.
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getPlugin(GetPluginRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getPlugin(PluginName name)
*
getPlugin(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.
*
* getPluginCallable()
*
*
*
*
* EnablePlugin
* Enables a plugin. The `state` of the plugin after enabling is `ENABLED`
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* enablePlugin(EnablePluginRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* enablePlugin(PluginName name)
*
enablePlugin(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.
*
* enablePluginCallable()
*
*
*
*
* DisablePlugin
* Disables a plugin. The `state` of the plugin after disabling is `DISABLED`
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* disablePlugin(DisablePluginRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* disablePlugin(PluginName name)
*
disablePlugin(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.
*
* disablePluginCallable()
*
*
*
*
* ListLocations
* Lists information about the supported locations for this service.
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listLocations(ListLocationsRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listLocationsPagedCallable()
*
listLocationsCallable()
*
*
*
*
* GetLocation
* Gets information about a location.
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getLocation(GetLocationRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getLocationCallable()
*
*
*
*
*
* See the individual methods for example code.
*
*
Many parameters require resource names to be formatted in a particular way. To assist with
* these names, this class includes a format method for each type of name, and additionally a parse
* method to extract the individual identifiers contained within names that are returned.
*
*
This class can be customized by passing in a custom instance of ApiHubPluginSettings to
* create(). For example:
*
*
To customize credentials:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* ApiHubPluginSettings apiHubPluginSettings =
* ApiHubPluginSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create(apiHubPluginSettings);
* }
*
* To customize the endpoint:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* ApiHubPluginSettings apiHubPluginSettings =
* ApiHubPluginSettings.newBuilder().setEndpoint(myEndpoint).build();
* ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create(apiHubPluginSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class ApiHubPluginClient implements BackgroundResource {
private final ApiHubPluginSettings settings;
private final ApiHubPluginStub stub;
/** Constructs an instance of ApiHubPluginClient with default settings. */
public static final ApiHubPluginClient create() throws IOException {
return create(ApiHubPluginSettings.newBuilder().build());
}
/**
* Constructs an instance of ApiHubPluginClient, 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 ApiHubPluginClient create(ApiHubPluginSettings settings) throws IOException {
return new ApiHubPluginClient(settings);
}
/**
* Constructs an instance of ApiHubPluginClient, using the given stub for making calls. This is
* for advanced usage - prefer using create(ApiHubPluginSettings).
*/
public static final ApiHubPluginClient create(ApiHubPluginStub stub) {
return new ApiHubPluginClient(stub);
}
/**
* Constructs an instance of ApiHubPluginClient, 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 ApiHubPluginClient(ApiHubPluginSettings settings) throws IOException {
this.settings = settings;
this.stub = ((ApiHubPluginStubSettings) settings.getStubSettings()).createStub();
}
protected ApiHubPluginClient(ApiHubPluginStub stub) {
this.settings = null;
this.stub = stub;
}
public final ApiHubPluginSettings getSettings() {
return settings;
}
public ApiHubPluginStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Get details about an API Hub plugin.
*
*
Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
* PluginName name = PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]");
* Plugin response = apiHubPluginClient.getPlugin(name);
* }
* }
*
* @param name Required. The name of the plugin to retrieve. Format:
* `projects/{project}/locations/{location}/plugins/{plugin}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Plugin getPlugin(PluginName name) {
GetPluginRequest request =
GetPluginRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getPlugin(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Get details about an API Hub plugin.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
* String name = PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString();
* Plugin response = apiHubPluginClient.getPlugin(name);
* }
* }
*
* @param name Required. The name of the plugin to retrieve. Format:
* `projects/{project}/locations/{location}/plugins/{plugin}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Plugin getPlugin(String name) {
GetPluginRequest request = GetPluginRequest.newBuilder().setName(name).build();
return getPlugin(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Get details about an API Hub plugin.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
* GetPluginRequest request =
* GetPluginRequest.newBuilder()
* .setName(PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
* .build();
* Plugin response = apiHubPluginClient.getPlugin(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Plugin getPlugin(GetPluginRequest request) {
return getPluginCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Get details about an API Hub plugin.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
* GetPluginRequest request =
* GetPluginRequest.newBuilder()
* .setName(PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
* .build();
* ApiFuture future = apiHubPluginClient.getPluginCallable().futureCall(request);
* // Do something.
* Plugin response = future.get();
* }
* }
*/
public final UnaryCallable getPluginCallable() {
return stub.getPluginCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Enables a plugin. The `state` of the plugin after enabling is `ENABLED`
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
* PluginName name = PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]");
* Plugin response = apiHubPluginClient.enablePlugin(name);
* }
* }
*
* @param name Required. The name of the plugin to enable. Format:
* `projects/{project}/locations/{location}/plugins/{plugin}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Plugin enablePlugin(PluginName name) {
EnablePluginRequest request =
EnablePluginRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return enablePlugin(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Enables a plugin. The `state` of the plugin after enabling is `ENABLED`
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
* String name = PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString();
* Plugin response = apiHubPluginClient.enablePlugin(name);
* }
* }
*
* @param name Required. The name of the plugin to enable. Format:
* `projects/{project}/locations/{location}/plugins/{plugin}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Plugin enablePlugin(String name) {
EnablePluginRequest request = EnablePluginRequest.newBuilder().setName(name).build();
return enablePlugin(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Enables a plugin. The `state` of the plugin after enabling is `ENABLED`
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
* EnablePluginRequest request =
* EnablePluginRequest.newBuilder()
* .setName(PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
* .build();
* Plugin response = apiHubPluginClient.enablePlugin(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Plugin enablePlugin(EnablePluginRequest request) {
return enablePluginCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Enables a plugin. The `state` of the plugin after enabling is `ENABLED`
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
* EnablePluginRequest request =
* EnablePluginRequest.newBuilder()
* .setName(PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
* .build();
* ApiFuture future = apiHubPluginClient.enablePluginCallable().futureCall(request);
* // Do something.
* Plugin response = future.get();
* }
* }
*/
public final UnaryCallable enablePluginCallable() {
return stub.enablePluginCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Disables a plugin. The `state` of the plugin after disabling is `DISABLED`
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
* PluginName name = PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]");
* Plugin response = apiHubPluginClient.disablePlugin(name);
* }
* }
*
* @param name Required. The name of the plugin to disable. Format:
* `projects/{project}/locations/{location}/plugins/{plugin}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Plugin disablePlugin(PluginName name) {
DisablePluginRequest request =
DisablePluginRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return disablePlugin(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Disables a plugin. The `state` of the plugin after disabling is `DISABLED`
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
* String name = PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString();
* Plugin response = apiHubPluginClient.disablePlugin(name);
* }
* }
*
* @param name Required. The name of the plugin to disable. Format:
* `projects/{project}/locations/{location}/plugins/{plugin}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Plugin disablePlugin(String name) {
DisablePluginRequest request = DisablePluginRequest.newBuilder().setName(name).build();
return disablePlugin(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Disables a plugin. The `state` of the plugin after disabling is `DISABLED`
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
* DisablePluginRequest request =
* DisablePluginRequest.newBuilder()
* .setName(PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
* .build();
* Plugin response = apiHubPluginClient.disablePlugin(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Plugin disablePlugin(DisablePluginRequest request) {
return disablePluginCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Disables a plugin. The `state` of the plugin after disabling is `DISABLED`
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
* DisablePluginRequest request =
* DisablePluginRequest.newBuilder()
* .setName(PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
* .build();
* ApiFuture future = apiHubPluginClient.disablePluginCallable().futureCall(request);
* // Do something.
* Plugin response = future.get();
* }
* }
*/
public final UnaryCallable disablePluginCallable() {
return stub.disablePluginCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (Location element : apiHubPluginClient.listLocations(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListLocationsPagedResponse listLocations(ListLocationsRequest request) {
return listLocationsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture future =
* apiHubPluginClient.listLocationsPagedCallable().futureCall(request);
* // Do something.
* for (Location element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listLocationsPagedCallable() {
return stub.listLocationsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* ListLocationsResponse response = apiHubPluginClient.listLocationsCallable().call(request);
* for (Location element : response.getLocationsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable listLocationsCallable() {
return stub.listLocationsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a location.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
* GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
* Location response = apiHubPluginClient.getLocation(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Location getLocation(GetLocationRequest request) {
return getLocationCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a location.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
* GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
* ApiFuture future = apiHubPluginClient.getLocationCallable().futureCall(request);
* // Do something.
* Location response = future.get();
* }
* }
*/
public final UnaryCallable getLocationCallable() {
return stub.getLocationCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListLocationsPagedResponse
extends AbstractPagedListResponse<
ListLocationsRequest,
ListLocationsResponse,
Location,
ListLocationsPage,
ListLocationsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListLocationsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListLocationsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListLocationsPagedResponse(ListLocationsPage page) {
super(page, ListLocationsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListLocationsPage
extends AbstractPage<
ListLocationsRequest, ListLocationsResponse, Location, ListLocationsPage> {
private ListLocationsPage(
PageContext context,
ListLocationsResponse response) {
super(context, response);
}
private static ListLocationsPage createEmptyPage() {
return new ListLocationsPage(null, null);
}
@Override
protected ListLocationsPage createPage(
PageContext context,
ListLocationsResponse response) {
return new ListLocationsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListLocationsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListLocationsRequest,
ListLocationsResponse,
Location,
ListLocationsPage,
ListLocationsFixedSizeCollection> {
private ListLocationsFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListLocationsFixedSizeCollection createEmptyCollection() {
return new ListLocationsFixedSizeCollection(null, 0);
}
@Override
protected ListLocationsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListLocationsFixedSizeCollection(pages, collectionSize);
}
}
}