GitHub Repository | Product Reference |
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:
// 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().
Method | Description | Method Variants |
---|---|---|
GetPlugin |
Get an API Hub plugin. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
EnablePlugin |
Enables a plugin. The |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DisablePlugin |
Disables a plugin. The |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreatePlugin |
Create an API Hub plugin resource in the API hub. Once a plugin is created, it can be used to create plugin instances. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListPlugins |
List all the plugins in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeletePlugin |
Delete a Plugin in API hub. Note, only user owned plugins can be deleted via this method. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreatePluginInstance |
Creates a Plugin instance in the API hub. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ExecutePluginInstanceAction |
Executes a plugin instance in the API hub. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetPluginInstance |
Get an API Hub plugin instance. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListPluginInstances |
List all the plugins in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
EnablePluginInstanceAction |
Enables a plugin instance in the API hub. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DisablePluginInstanceAction |
Disables a plugin instance in the API hub. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdatePluginInstance |
Updates a plugin instance in the API hub. The following fields in the plugin_instance can be updated currently:
The update_mask should be used to specify the fields being updated. To update the auth_config and additional_config of the plugin instance, use the ApplyPluginInstanceConfig method. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeletePluginInstance |
Deletes a plugin instance in the API hub. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation |
Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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:
// 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:
// 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.
Static Methods
create()
public static final ApiHubPluginClient create()
Constructs an instance of ApiHubPluginClient with default settings.
Returns | |
---|---|
Type | Description |
ApiHubPluginClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ApiHubPluginSettings settings)
public static final ApiHubPluginClient create(ApiHubPluginSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings |
ApiHubPluginSettings |
Returns | |
---|---|
Type | Description |
ApiHubPluginClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ApiHubPluginStub stub)
public static final ApiHubPluginClient create(ApiHubPluginStub stub)
Constructs an instance of ApiHubPluginClient, using the given stub for making calls. This is for advanced usage - prefer using create(ApiHubPluginSettings).
Parameter | |
---|---|
Name | Description |
stub |
ApiHubPluginStub |
Returns | |
---|---|
Type | Description |
ApiHubPluginClient |
Constructors
ApiHubPluginClient(ApiHubPluginSettings settings)
protected ApiHubPluginClient(ApiHubPluginSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings |
ApiHubPluginSettings |
ApiHubPluginClient(ApiHubPluginStub stub)
protected ApiHubPluginClient(ApiHubPluginStub stub)
Parameter | |
---|---|
Name | Description |
stub |
ApiHubPluginStub |
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()
createPlugin(CreatePluginRequest request)
public final Plugin createPlugin(CreatePluginRequest request)
Create an API Hub plugin resource in the API hub. Once a plugin is created, it can be used to create plugin instances.
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
CreatePluginRequest request =
CreatePluginRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPluginId("pluginId-1859618898")
.setPlugin(Plugin.newBuilder().build())
.build();
Plugin response = apiHubPluginClient.createPlugin(request);
}
Parameter | |
---|---|
Name | Description |
request |
CreatePluginRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Plugin |
createPlugin(LocationName parent, Plugin plugin, String pluginId)
public final Plugin createPlugin(LocationName parent, Plugin plugin, String pluginId)
Create an API Hub plugin resource in the API hub. Once a plugin is created, it can be used to create plugin instances.
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Plugin plugin = Plugin.newBuilder().build();
String pluginId = "pluginId-1859618898";
Plugin response = apiHubPluginClient.createPlugin(parent, plugin, pluginId);
}
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The parent resource where this plugin will be created. Format:
|
plugin |
Plugin Required. The plugin to create. |
pluginId |
String Optional. The ID to use for the Plugin resource, which will become the final component of the Plugin's resource name. This field is optional.
This value should be 4-63 characters, overall resource name which will be of format
|
Returns | |
---|---|
Type | Description |
Plugin |
createPlugin(String parent, Plugin plugin, String pluginId)
public final Plugin createPlugin(String parent, Plugin plugin, String pluginId)
Create an API Hub plugin resource in the API hub. Once a plugin is created, it can be used to create plugin instances.
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Plugin plugin = Plugin.newBuilder().build();
String pluginId = "pluginId-1859618898";
Plugin response = apiHubPluginClient.createPlugin(parent, plugin, pluginId);
}
Parameters | |
---|---|
Name | Description |
parent |
String Required. The parent resource where this plugin will be created. Format:
|
plugin |
Plugin Required. The plugin to create. |
pluginId |
String Optional. The ID to use for the Plugin resource, which will become the final component of the Plugin's resource name. This field is optional.
This value should be 4-63 characters, overall resource name which will be of format
|
Returns | |
---|---|
Type | Description |
Plugin |
createPluginCallable()
public final UnaryCallable<CreatePluginRequest,Plugin> createPluginCallable()
Create an API Hub plugin resource in the API hub. Once a plugin is created, it can be used to create plugin instances.
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
CreatePluginRequest request =
CreatePluginRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPluginId("pluginId-1859618898")
.setPlugin(Plugin.newBuilder().build())
.build();
ApiFuture<Plugin> future = apiHubPluginClient.createPluginCallable().futureCall(request);
// Do something.
Plugin response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreatePluginRequest,Plugin> |
createPluginInstanceAsync(CreatePluginInstanceRequest request)
public final OperationFuture<PluginInstance,OperationMetadata> createPluginInstanceAsync(CreatePluginInstanceRequest request)
Creates a Plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
CreatePluginInstanceRequest request =
CreatePluginInstanceRequest.newBuilder()
.setParent(PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
.setPluginInstanceId("pluginInstanceId-1741818845")
.setPluginInstance(PluginInstance.newBuilder().build())
.build();
PluginInstance response = apiHubPluginClient.createPluginInstanceAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
CreatePluginInstanceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<PluginInstance,OperationMetadata> |
createPluginInstanceAsync(PluginName parent, PluginInstance pluginInstance, String pluginInstanceId)
public final OperationFuture<PluginInstance,OperationMetadata> createPluginInstanceAsync(PluginName parent, PluginInstance pluginInstance, String pluginInstanceId)
Creates a Plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
PluginName parent = PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]");
PluginInstance pluginInstance = PluginInstance.newBuilder().build();
String pluginInstanceId = "pluginInstanceId-1741818845";
PluginInstance response =
apiHubPluginClient
.createPluginInstanceAsync(parent, pluginInstance, pluginInstanceId)
.get();
}
Parameters | |
---|---|
Name | Description |
parent |
PluginName Required. The parent of the plugin instance resource. Format:
|
pluginInstance |
PluginInstance Required. The plugin instance to create. |
pluginInstanceId |
String Optional. The ID to use for the plugin instance, which will become the final component of the plugin instance's resource name. This field is optional.
This value should be 4-63 characters, and valid characters are /a-z[0-9]-_/. |
Returns | |
---|---|
Type | Description |
OperationFuture<PluginInstance,OperationMetadata> |
createPluginInstanceAsync(String parent, PluginInstance pluginInstance, String pluginInstanceId)
public final OperationFuture<PluginInstance,OperationMetadata> createPluginInstanceAsync(String parent, PluginInstance pluginInstance, String pluginInstanceId)
Creates a Plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
String parent = PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString();
PluginInstance pluginInstance = PluginInstance.newBuilder().build();
String pluginInstanceId = "pluginInstanceId-1741818845";
PluginInstance response =
apiHubPluginClient
.createPluginInstanceAsync(parent, pluginInstance, pluginInstanceId)
.get();
}
Parameters | |
---|---|
Name | Description |
parent |
String Required. The parent of the plugin instance resource. Format:
|
pluginInstance |
PluginInstance Required. The plugin instance to create. |
pluginInstanceId |
String Optional. The ID to use for the plugin instance, which will become the final component of the plugin instance's resource name. This field is optional.
This value should be 4-63 characters, and valid characters are /a-z[0-9]-_/. |
Returns | |
---|---|
Type | Description |
OperationFuture<PluginInstance,OperationMetadata> |
createPluginInstanceCallable()
public final UnaryCallable<CreatePluginInstanceRequest,Operation> createPluginInstanceCallable()
Creates a Plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
CreatePluginInstanceRequest request =
CreatePluginInstanceRequest.newBuilder()
.setParent(PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
.setPluginInstanceId("pluginInstanceId-1741818845")
.setPluginInstance(PluginInstance.newBuilder().build())
.build();
ApiFuture<Operation> future =
apiHubPluginClient.createPluginInstanceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreatePluginInstanceRequest,Operation> |
createPluginInstanceOperationCallable()
public final OperationCallable<CreatePluginInstanceRequest,PluginInstance,OperationMetadata> createPluginInstanceOperationCallable()
Creates a Plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
CreatePluginInstanceRequest request =
CreatePluginInstanceRequest.newBuilder()
.setParent(PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
.setPluginInstanceId("pluginInstanceId-1741818845")
.setPluginInstance(PluginInstance.newBuilder().build())
.build();
OperationFuture<PluginInstance, OperationMetadata> future =
apiHubPluginClient.createPluginInstanceOperationCallable().futureCall(request);
// Do something.
PluginInstance response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreatePluginInstanceRequest,PluginInstance,OperationMetadata> |
deletePluginAsync(DeletePluginRequest request)
public final OperationFuture<Empty,OperationMetadata> deletePluginAsync(DeletePluginRequest request)
Delete a Plugin in API hub. Note, only user owned plugins can be deleted via this method.
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
DeletePluginRequest request =
DeletePluginRequest.newBuilder()
.setName(PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
.build();
apiHubPluginClient.deletePluginAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
DeletePluginRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deletePluginAsync(PluginName name)
public final OperationFuture<Empty,OperationMetadata> deletePluginAsync(PluginName name)
Delete a Plugin in API hub. Note, only user owned plugins can be deleted via this method.
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
PluginName name = PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]");
apiHubPluginClient.deletePluginAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
PluginName Required. The name of the Plugin resource to delete. Format:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deletePluginAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deletePluginAsync(String name)
Delete a Plugin in API hub. Note, only user owned plugins can be deleted via this method.
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
String name = PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString();
apiHubPluginClient.deletePluginAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the Plugin resource to delete. Format:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deletePluginCallable()
public final UnaryCallable<DeletePluginRequest,Operation> deletePluginCallable()
Delete a Plugin in API hub. Note, only user owned plugins can be deleted via this method.
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
DeletePluginRequest request =
DeletePluginRequest.newBuilder()
.setName(PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
.build();
ApiFuture<Operation> future = apiHubPluginClient.deletePluginCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeletePluginRequest,Operation> |
deletePluginInstanceAsync(DeletePluginInstanceRequest request)
public final OperationFuture<Empty,OperationMetadata> deletePluginInstanceAsync(DeletePluginInstanceRequest request)
Deletes a plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
DeletePluginInstanceRequest request =
DeletePluginInstanceRequest.newBuilder()
.setName(
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]")
.toString())
.build();
apiHubPluginClient.deletePluginInstanceAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
DeletePluginInstanceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deletePluginInstanceAsync(PluginInstanceName name)
public final OperationFuture<Empty,OperationMetadata> deletePluginInstanceAsync(PluginInstanceName name)
Deletes a plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
PluginInstanceName name =
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]");
apiHubPluginClient.deletePluginInstanceAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
PluginInstanceName Required. The name of the plugin instance to delete. Format:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deletePluginInstanceAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deletePluginInstanceAsync(String name)
Deletes a plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
String name =
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]").toString();
apiHubPluginClient.deletePluginInstanceAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the plugin instance to delete. Format:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deletePluginInstanceCallable()
public final UnaryCallable<DeletePluginInstanceRequest,Operation> deletePluginInstanceCallable()
Deletes a plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
DeletePluginInstanceRequest request =
DeletePluginInstanceRequest.newBuilder()
.setName(
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]")
.toString())
.build();
ApiFuture<Operation> future =
apiHubPluginClient.deletePluginInstanceCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeletePluginInstanceRequest,Operation> |
deletePluginInstanceOperationCallable()
public final OperationCallable<DeletePluginInstanceRequest,Empty,OperationMetadata> deletePluginInstanceOperationCallable()
Deletes a plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
DeletePluginInstanceRequest request =
DeletePluginInstanceRequest.newBuilder()
.setName(
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]")
.toString())
.build();
OperationFuture<Empty, OperationMetadata> future =
apiHubPluginClient.deletePluginInstanceOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeletePluginInstanceRequest,Empty,OperationMetadata> |
deletePluginOperationCallable()
public final OperationCallable<DeletePluginRequest,Empty,OperationMetadata> deletePluginOperationCallable()
Delete a Plugin in API hub. Note, only user owned plugins can be deleted via this method.
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
DeletePluginRequest request =
DeletePluginRequest.newBuilder()
.setName(PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
.build();
OperationFuture<Empty, OperationMetadata> future =
apiHubPluginClient.deletePluginOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeletePluginRequest,Empty,OperationMetadata> |
disablePlugin(DisablePluginRequest request)
public final Plugin disablePlugin(DisablePluginRequest request)
Disables a plugin. The state
of the plugin after disabling is DISABLED
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
DisablePluginRequest request =
DisablePluginRequest.newBuilder()
.setName(PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
.build();
Plugin response = apiHubPluginClient.disablePlugin(request);
}
Parameter | |
---|---|
Name | Description |
request |
DisablePluginRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Plugin |
disablePlugin(PluginName name)
public final Plugin disablePlugin(PluginName name)
Disables a plugin. The state
of the plugin after disabling is DISABLED
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
PluginName name = PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]");
Plugin response = apiHubPluginClient.disablePlugin(name);
}
Parameter | |
---|---|
Name | Description |
name |
PluginName Required. The name of the plugin to disable. Format:
|
Returns | |
---|---|
Type | Description |
Plugin |
disablePlugin(String name)
public final Plugin disablePlugin(String name)
Disables a plugin. The state
of the plugin after disabling is DISABLED
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
String name = PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString();
Plugin response = apiHubPluginClient.disablePlugin(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the plugin to disable. Format:
|
Returns | |
---|---|
Type | Description |
Plugin |
disablePluginCallable()
public final UnaryCallable<DisablePluginRequest,Plugin> disablePluginCallable()
Disables a plugin. The state
of the plugin after disabling is DISABLED
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
DisablePluginRequest request =
DisablePluginRequest.newBuilder()
.setName(PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
.build();
ApiFuture<Plugin> future = apiHubPluginClient.disablePluginCallable().futureCall(request);
// Do something.
Plugin response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DisablePluginRequest,Plugin> |
disablePluginInstanceActionAsync(DisablePluginInstanceActionRequest request)
public final OperationFuture<DisablePluginInstanceActionResponse,OperationMetadata> disablePluginInstanceActionAsync(DisablePluginInstanceActionRequest request)
Disables a plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
DisablePluginInstanceActionRequest request =
DisablePluginInstanceActionRequest.newBuilder()
.setName(
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]")
.toString())
.setActionId("actionId-1656172047")
.build();
DisablePluginInstanceActionResponse response =
apiHubPluginClient.disablePluginInstanceActionAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
DisablePluginInstanceActionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<DisablePluginInstanceActionResponse,OperationMetadata> |
disablePluginInstanceActionAsync(PluginInstanceName name, String actionId)
public final OperationFuture<DisablePluginInstanceActionResponse,OperationMetadata> disablePluginInstanceActionAsync(PluginInstanceName name, String actionId)
Disables a plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
PluginInstanceName name =
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]");
String actionId = "actionId-1656172047";
DisablePluginInstanceActionResponse response =
apiHubPluginClient.disablePluginInstanceActionAsync(name, actionId).get();
}
Parameters | |
---|---|
Name | Description |
name |
PluginInstanceName Required. The name of the plugin instance to disable. Format:
|
actionId |
String Required. The action id to disable. |
Returns | |
---|---|
Type | Description |
OperationFuture<DisablePluginInstanceActionResponse,OperationMetadata> |
disablePluginInstanceActionAsync(String name, String actionId)
public final OperationFuture<DisablePluginInstanceActionResponse,OperationMetadata> disablePluginInstanceActionAsync(String name, String actionId)
Disables a plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
String name =
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]").toString();
String actionId = "actionId-1656172047";
DisablePluginInstanceActionResponse response =
apiHubPluginClient.disablePluginInstanceActionAsync(name, actionId).get();
}
Parameters | |
---|---|
Name | Description |
name |
String Required. The name of the plugin instance to disable. Format:
|
actionId |
String Required. The action id to disable. |
Returns | |
---|---|
Type | Description |
OperationFuture<DisablePluginInstanceActionResponse,OperationMetadata> |
disablePluginInstanceActionCallable()
public final UnaryCallable<DisablePluginInstanceActionRequest,Operation> disablePluginInstanceActionCallable()
Disables a plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
DisablePluginInstanceActionRequest request =
DisablePluginInstanceActionRequest.newBuilder()
.setName(
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]")
.toString())
.setActionId("actionId-1656172047")
.build();
ApiFuture<Operation> future =
apiHubPluginClient.disablePluginInstanceActionCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DisablePluginInstanceActionRequest,Operation> |
disablePluginInstanceActionOperationCallable()
public final OperationCallable<DisablePluginInstanceActionRequest,DisablePluginInstanceActionResponse,OperationMetadata> disablePluginInstanceActionOperationCallable()
Disables a plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
DisablePluginInstanceActionRequest request =
DisablePluginInstanceActionRequest.newBuilder()
.setName(
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]")
.toString())
.setActionId("actionId-1656172047")
.build();
OperationFuture<DisablePluginInstanceActionResponse, OperationMetadata> future =
apiHubPluginClient.disablePluginInstanceActionOperationCallable().futureCall(request);
// Do something.
DisablePluginInstanceActionResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DisablePluginInstanceActionRequest,DisablePluginInstanceActionResponse,OperationMetadata> |
enablePlugin(EnablePluginRequest request)
public final Plugin enablePlugin(EnablePluginRequest request)
Enables a plugin. The state
of the plugin after enabling is ENABLED
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
EnablePluginRequest request =
EnablePluginRequest.newBuilder()
.setName(PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
.build();
Plugin response = apiHubPluginClient.enablePlugin(request);
}
Parameter | |
---|---|
Name | Description |
request |
EnablePluginRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Plugin |
enablePlugin(PluginName name)
public final Plugin enablePlugin(PluginName name)
Enables a plugin. The state
of the plugin after enabling is ENABLED
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
PluginName name = PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]");
Plugin response = apiHubPluginClient.enablePlugin(name);
}
Parameter | |
---|---|
Name | Description |
name |
PluginName Required. The name of the plugin to enable. Format:
|
Returns | |
---|---|
Type | Description |
Plugin |
enablePlugin(String name)
public final Plugin enablePlugin(String name)
Enables a plugin. The state
of the plugin after enabling is ENABLED
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
String name = PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString();
Plugin response = apiHubPluginClient.enablePlugin(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the plugin to enable. Format:
|
Returns | |
---|---|
Type | Description |
Plugin |
enablePluginCallable()
public final UnaryCallable<EnablePluginRequest,Plugin> enablePluginCallable()
Enables a plugin. The state
of the plugin after enabling is ENABLED
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
EnablePluginRequest request =
EnablePluginRequest.newBuilder()
.setName(PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
.build();
ApiFuture<Plugin> future = apiHubPluginClient.enablePluginCallable().futureCall(request);
// Do something.
Plugin response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<EnablePluginRequest,Plugin> |
enablePluginInstanceActionAsync(EnablePluginInstanceActionRequest request)
public final OperationFuture<EnablePluginInstanceActionResponse,OperationMetadata> enablePluginInstanceActionAsync(EnablePluginInstanceActionRequest request)
Enables a plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
EnablePluginInstanceActionRequest request =
EnablePluginInstanceActionRequest.newBuilder()
.setName(
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]")
.toString())
.setActionId("actionId-1656172047")
.build();
EnablePluginInstanceActionResponse response =
apiHubPluginClient.enablePluginInstanceActionAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
EnablePluginInstanceActionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<EnablePluginInstanceActionResponse,OperationMetadata> |
enablePluginInstanceActionAsync(PluginInstanceName name, String actionId)
public final OperationFuture<EnablePluginInstanceActionResponse,OperationMetadata> enablePluginInstanceActionAsync(PluginInstanceName name, String actionId)
Enables a plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
PluginInstanceName name =
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]");
String actionId = "actionId-1656172047";
EnablePluginInstanceActionResponse response =
apiHubPluginClient.enablePluginInstanceActionAsync(name, actionId).get();
}
Parameters | |
---|---|
Name | Description |
name |
PluginInstanceName Required. The name of the plugin instance to enable. Format:
|
actionId |
String Required. The action id to enable. |
Returns | |
---|---|
Type | Description |
OperationFuture<EnablePluginInstanceActionResponse,OperationMetadata> |
enablePluginInstanceActionAsync(String name, String actionId)
public final OperationFuture<EnablePluginInstanceActionResponse,OperationMetadata> enablePluginInstanceActionAsync(String name, String actionId)
Enables a plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
String name =
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]").toString();
String actionId = "actionId-1656172047";
EnablePluginInstanceActionResponse response =
apiHubPluginClient.enablePluginInstanceActionAsync(name, actionId).get();
}
Parameters | |
---|---|
Name | Description |
name |
String Required. The name of the plugin instance to enable. Format:
|
actionId |
String Required. The action id to enable. |
Returns | |
---|---|
Type | Description |
OperationFuture<EnablePluginInstanceActionResponse,OperationMetadata> |
enablePluginInstanceActionCallable()
public final UnaryCallable<EnablePluginInstanceActionRequest,Operation> enablePluginInstanceActionCallable()
Enables a plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
EnablePluginInstanceActionRequest request =
EnablePluginInstanceActionRequest.newBuilder()
.setName(
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]")
.toString())
.setActionId("actionId-1656172047")
.build();
ApiFuture<Operation> future =
apiHubPluginClient.enablePluginInstanceActionCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<EnablePluginInstanceActionRequest,Operation> |
enablePluginInstanceActionOperationCallable()
public final OperationCallable<EnablePluginInstanceActionRequest,EnablePluginInstanceActionResponse,OperationMetadata> enablePluginInstanceActionOperationCallable()
Enables a plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
EnablePluginInstanceActionRequest request =
EnablePluginInstanceActionRequest.newBuilder()
.setName(
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]")
.toString())
.setActionId("actionId-1656172047")
.build();
OperationFuture<EnablePluginInstanceActionResponse, OperationMetadata> future =
apiHubPluginClient.enablePluginInstanceActionOperationCallable().futureCall(request);
// Do something.
EnablePluginInstanceActionResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<EnablePluginInstanceActionRequest,EnablePluginInstanceActionResponse,OperationMetadata> |
executePluginInstanceActionAsync(ExecutePluginInstanceActionRequest request)
public final OperationFuture<ExecutePluginInstanceActionResponse,OperationMetadata> executePluginInstanceActionAsync(ExecutePluginInstanceActionRequest request)
Executes a plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
ExecutePluginInstanceActionRequest request =
ExecutePluginInstanceActionRequest.newBuilder()
.setName(
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]")
.toString())
.setActionExecutionDetail(ActionExecutionDetail.newBuilder().build())
.build();
ExecutePluginInstanceActionResponse response =
apiHubPluginClient.executePluginInstanceActionAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
ExecutePluginInstanceActionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<ExecutePluginInstanceActionResponse,OperationMetadata> |
executePluginInstanceActionAsync(PluginInstanceName name, ActionExecutionDetail actionExecutionDetail)
public final OperationFuture<ExecutePluginInstanceActionResponse,OperationMetadata> executePluginInstanceActionAsync(PluginInstanceName name, ActionExecutionDetail actionExecutionDetail)
Executes a plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
PluginInstanceName name =
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]");
ActionExecutionDetail actionExecutionDetail = ActionExecutionDetail.newBuilder().build();
ExecutePluginInstanceActionResponse response =
apiHubPluginClient.executePluginInstanceActionAsync(name, actionExecutionDetail).get();
}
Parameters | |
---|---|
Name | Description |
name |
PluginInstanceName Required. The name of the plugin instance to execute. Format:
|
actionExecutionDetail |
ActionExecutionDetail Required. The execution details for the action to execute. |
Returns | |
---|---|
Type | Description |
OperationFuture<ExecutePluginInstanceActionResponse,OperationMetadata> |
executePluginInstanceActionAsync(String name, ActionExecutionDetail actionExecutionDetail)
public final OperationFuture<ExecutePluginInstanceActionResponse,OperationMetadata> executePluginInstanceActionAsync(String name, ActionExecutionDetail actionExecutionDetail)
Executes a plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
String name =
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]").toString();
ActionExecutionDetail actionExecutionDetail = ActionExecutionDetail.newBuilder().build();
ExecutePluginInstanceActionResponse response =
apiHubPluginClient.executePluginInstanceActionAsync(name, actionExecutionDetail).get();
}
Parameters | |
---|---|
Name | Description |
name |
String Required. The name of the plugin instance to execute. Format:
|
actionExecutionDetail |
ActionExecutionDetail Required. The execution details for the action to execute. |
Returns | |
---|---|
Type | Description |
OperationFuture<ExecutePluginInstanceActionResponse,OperationMetadata> |
executePluginInstanceActionCallable()
public final UnaryCallable<ExecutePluginInstanceActionRequest,Operation> executePluginInstanceActionCallable()
Executes a plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
ExecutePluginInstanceActionRequest request =
ExecutePluginInstanceActionRequest.newBuilder()
.setName(
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]")
.toString())
.setActionExecutionDetail(ActionExecutionDetail.newBuilder().build())
.build();
ApiFuture<Operation> future =
apiHubPluginClient.executePluginInstanceActionCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ExecutePluginInstanceActionRequest,Operation> |
executePluginInstanceActionOperationCallable()
public final OperationCallable<ExecutePluginInstanceActionRequest,ExecutePluginInstanceActionResponse,OperationMetadata> executePluginInstanceActionOperationCallable()
Executes a plugin instance 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
ExecutePluginInstanceActionRequest request =
ExecutePluginInstanceActionRequest.newBuilder()
.setName(
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]")
.toString())
.setActionExecutionDetail(ActionExecutionDetail.newBuilder().build())
.build();
OperationFuture<ExecutePluginInstanceActionResponse, OperationMetadata> future =
apiHubPluginClient.executePluginInstanceActionOperationCallable().futureCall(request);
// Do something.
ExecutePluginInstanceActionResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<ExecutePluginInstanceActionRequest,ExecutePluginInstanceActionResponse,OperationMetadata> |
getHttpJsonOperationsClient()
public final OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Returns | |
---|---|
Type | Description |
OperationsClient |
getLocation(GetLocationRequest request)
public final Location getLocation(GetLocationRequest 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = apiHubPluginClient.getLocation(request);
}
Parameter | |
---|---|
Name | Description |
request |
com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.cloud.location.Location |
getLocationCallable()
public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = apiHubPluginClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getPlugin(GetPluginRequest request)
public final Plugin getPlugin(GetPluginRequest request)
Get an API Hub plugin.
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
GetPluginRequest request =
GetPluginRequest.newBuilder()
.setName(PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
.build();
Plugin response = apiHubPluginClient.getPlugin(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetPluginRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Plugin |
getPlugin(PluginName name)
public final Plugin getPlugin(PluginName name)
Get an API Hub plugin.
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
PluginName name = PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]");
Plugin response = apiHubPluginClient.getPlugin(name);
}
Parameter | |
---|---|
Name | Description |
name |
PluginName Required. The name of the plugin to retrieve. Format:
|
Returns | |
---|---|
Type | Description |
Plugin |
getPlugin(String name)
public final Plugin getPlugin(String name)
Get an API Hub plugin.
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
String name = PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString();
Plugin response = apiHubPluginClient.getPlugin(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the plugin to retrieve. Format:
|
Returns | |
---|---|
Type | Description |
Plugin |
getPluginCallable()
public final UnaryCallable<GetPluginRequest,Plugin> getPluginCallable()
Get an API Hub plugin.
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
GetPluginRequest request =
GetPluginRequest.newBuilder()
.setName(PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
.build();
ApiFuture<Plugin> future = apiHubPluginClient.getPluginCallable().futureCall(request);
// Do something.
Plugin response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetPluginRequest,Plugin> |
getPluginInstance(GetPluginInstanceRequest request)
public final PluginInstance getPluginInstance(GetPluginInstanceRequest request)
Get an API Hub plugin instance.
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
GetPluginInstanceRequest request =
GetPluginInstanceRequest.newBuilder()
.setName(
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]")
.toString())
.build();
PluginInstance response = apiHubPluginClient.getPluginInstance(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetPluginInstanceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
PluginInstance |
getPluginInstance(PluginInstanceName name)
public final PluginInstance getPluginInstance(PluginInstanceName name)
Get an API Hub plugin instance.
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
PluginInstanceName name =
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]");
PluginInstance response = apiHubPluginClient.getPluginInstance(name);
}
Parameter | |
---|---|
Name | Description |
name |
PluginInstanceName Required. The name of the plugin instance to retrieve. Format:
|
Returns | |
---|---|
Type | Description |
PluginInstance |
getPluginInstance(String name)
public final PluginInstance getPluginInstance(String name)
Get an API Hub plugin instance.
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
String name =
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]").toString();
PluginInstance response = apiHubPluginClient.getPluginInstance(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the plugin instance to retrieve. Format:
|
Returns | |
---|---|
Type | Description |
PluginInstance |
getPluginInstanceCallable()
public final UnaryCallable<GetPluginInstanceRequest,PluginInstance> getPluginInstanceCallable()
Get an API Hub plugin instance.
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
GetPluginInstanceRequest request =
GetPluginInstanceRequest.newBuilder()
.setName(
PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]")
.toString())
.build();
ApiFuture<PluginInstance> future =
apiHubPluginClient.getPluginInstanceCallable().futureCall(request);
// Do something.
PluginInstance response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetPluginInstanceRequest,PluginInstance> |
getSettings()
public final ApiHubPluginSettings getSettings()
Returns | |
---|---|
Type | Description |
ApiHubPluginSettings |
getStub()
public ApiHubPluginStub getStub()
Returns | |
---|---|
Type | Description |
ApiHubPluginStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listLocations(ListLocationsRequest request)
public final ApiHubPluginClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)
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 (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);
}
}
Parameter | |
---|---|
Name | Description |
request |
com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ApiHubPluginClient.ListLocationsPagedResponse |
listLocationsCallable()
public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()
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 (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;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
listLocationsPagedCallable()
public final UnaryCallable<ListLocationsRequest,ApiHubPluginClient.ListLocationsPagedResponse> listLocationsPagedCallable()
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
apiHubPluginClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
listPluginInstances(ListPluginInstancesRequest request)
public final ApiHubPluginClient.ListPluginInstancesPagedResponse listPluginInstances(ListPluginInstancesRequest request)
List all the plugins in a given project and location. -
can be used as wildcard value for
{plugin_id}
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
ListPluginInstancesRequest request =
ListPluginInstancesRequest.newBuilder()
.setParent(PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (PluginInstance element : apiHubPluginClient.listPluginInstances(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListPluginInstancesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ApiHubPluginClient.ListPluginInstancesPagedResponse |
listPluginInstances(PluginName parent)
public final ApiHubPluginClient.ListPluginInstancesPagedResponse listPluginInstances(PluginName parent)
List all the plugins in a given project and location. -
can be used as wildcard value for
{plugin_id}
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
PluginName parent = PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]");
for (PluginInstance element : apiHubPluginClient.listPluginInstances(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
PluginName Required. The parent resource where this plugin will be created. Format:
|
Returns | |
---|---|
Type | Description |
ApiHubPluginClient.ListPluginInstancesPagedResponse |
listPluginInstances(String parent)
public final ApiHubPluginClient.ListPluginInstancesPagedResponse listPluginInstances(String parent)
List all the plugins in a given project and location. -
can be used as wildcard value for
{plugin_id}
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
String parent = PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString();
for (PluginInstance element : apiHubPluginClient.listPluginInstances(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The parent resource where this plugin will be created. Format:
|
Returns | |
---|---|
Type | Description |
ApiHubPluginClient.ListPluginInstancesPagedResponse |
listPluginInstancesCallable()
public final UnaryCallable<ListPluginInstancesRequest,ListPluginInstancesResponse> listPluginInstancesCallable()
List all the plugins in a given project and location. -
can be used as wildcard value for
{plugin_id}
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
ListPluginInstancesRequest request =
ListPluginInstancesRequest.newBuilder()
.setParent(PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListPluginInstancesResponse response =
apiHubPluginClient.listPluginInstancesCallable().call(request);
for (PluginInstance element : response.getPluginInstancesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListPluginInstancesRequest,ListPluginInstancesResponse> |
listPluginInstancesPagedCallable()
public final UnaryCallable<ListPluginInstancesRequest,ApiHubPluginClient.ListPluginInstancesPagedResponse> listPluginInstancesPagedCallable()
List all the plugins in a given project and location. -
can be used as wildcard value for
{plugin_id}
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
ListPluginInstancesRequest request =
ListPluginInstancesRequest.newBuilder()
.setParent(PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<PluginInstance> future =
apiHubPluginClient.listPluginInstancesPagedCallable().futureCall(request);
// Do something.
for (PluginInstance element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListPluginInstancesRequest,ListPluginInstancesPagedResponse> |
listPlugins(ListPluginsRequest request)
public final ApiHubPluginClient.ListPluginsPagedResponse listPlugins(ListPluginsRequest request)
List all the plugins in a given project and 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
ListPluginsRequest request =
ListPluginsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Plugin element : apiHubPluginClient.listPlugins(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListPluginsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ApiHubPluginClient.ListPluginsPagedResponse |
listPlugins(LocationName parent)
public final ApiHubPluginClient.ListPluginsPagedResponse listPlugins(LocationName parent)
List all the plugins in a given project and 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Plugin element : apiHubPluginClient.listPlugins(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
LocationName Required. The parent resource where this plugin will be created. Format:
|
Returns | |
---|---|
Type | Description |
ApiHubPluginClient.ListPluginsPagedResponse |
listPlugins(String parent)
public final ApiHubPluginClient.ListPluginsPagedResponse listPlugins(String parent)
List all the plugins in a given project and 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Plugin element : apiHubPluginClient.listPlugins(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The parent resource where this plugin will be created. Format:
|
Returns | |
---|---|
Type | Description |
ApiHubPluginClient.ListPluginsPagedResponse |
listPluginsCallable()
public final UnaryCallable<ListPluginsRequest,ListPluginsResponse> listPluginsCallable()
List all the plugins in a given project and 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
ListPluginsRequest request =
ListPluginsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListPluginsResponse response = apiHubPluginClient.listPluginsCallable().call(request);
for (Plugin element : response.getPluginsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListPluginsRequest,ListPluginsResponse> |
listPluginsPagedCallable()
public final UnaryCallable<ListPluginsRequest,ApiHubPluginClient.ListPluginsPagedResponse> listPluginsPagedCallable()
List all the plugins in a given project and 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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
ListPluginsRequest request =
ListPluginsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Plugin> future = apiHubPluginClient.listPluginsPagedCallable().futureCall(request);
// Do something.
for (Plugin element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListPluginsRequest,ListPluginsPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updatePluginInstance(PluginInstance pluginInstance, FieldMask updateMask)
public final PluginInstance updatePluginInstance(PluginInstance pluginInstance, FieldMask updateMask)
Updates a plugin instance in the API hub. The following fields in the plugin_instance can be updated currently:
- display_name
- schedule_cron_expression
The update_mask should be used to specify the fields being updated.
To update the auth_config and additional_config of the plugin instance, use the ApplyPluginInstanceConfig method.
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
PluginInstance pluginInstance = PluginInstance.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
PluginInstance response = apiHubPluginClient.updatePluginInstance(pluginInstance, updateMask);
}
Parameters | |
---|---|
Name | Description |
pluginInstance |
PluginInstance Required. The plugin instance to update. |
updateMask |
FieldMask Optional. The list of fields to update. |
Returns | |
---|---|
Type | Description |
PluginInstance |
updatePluginInstance(UpdatePluginInstanceRequest request)
public final PluginInstance updatePluginInstance(UpdatePluginInstanceRequest request)
Updates a plugin instance in the API hub. The following fields in the plugin_instance can be updated currently:
- display_name
- schedule_cron_expression
The update_mask should be used to specify the fields being updated.
To update the auth_config and additional_config of the plugin instance, use the ApplyPluginInstanceConfig method.
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
UpdatePluginInstanceRequest request =
UpdatePluginInstanceRequest.newBuilder()
.setPluginInstance(PluginInstance.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
PluginInstance response = apiHubPluginClient.updatePluginInstance(request);
}
Parameter | |
---|---|
Name | Description |
request |
UpdatePluginInstanceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
PluginInstance |
updatePluginInstanceCallable()
public final UnaryCallable<UpdatePluginInstanceRequest,PluginInstance> updatePluginInstanceCallable()
Updates a plugin instance in the API hub. The following fields in the plugin_instance can be updated currently:
- display_name
- schedule_cron_expression
The update_mask should be used to specify the fields being updated.
To update the auth_config and additional_config of the plugin instance, use the ApplyPluginInstanceConfig method.
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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
UpdatePluginInstanceRequest request =
UpdatePluginInstanceRequest.newBuilder()
.setPluginInstance(PluginInstance.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<PluginInstance> future =
apiHubPluginClient.updatePluginInstanceCallable().futureCall(request);
// Do something.
PluginInstance response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdatePluginInstanceRequest,PluginInstance> |