Class ProvisioningClient (0.6.0)

GitHub RepositoryProduct Reference

Service Description: This service is used for managing the data plane provisioning of 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 (ProvisioningClient provisioningClient = ProvisioningClient.create()) {
   ApiHubInstanceName name =
       ApiHubInstanceName.of("[PROJECT]", "[LOCATION]", "[API_HUB_INSTANCE]");
   ApiHubInstance response = provisioningClient.getApiHubInstance(name);
 }

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

Methods
Method Description Method Variants

CreateApiHubInstance

Provisions instance resources for the API Hub.

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

  • createApiHubInstanceAsync(CreateApiHubInstanceRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createApiHubInstanceAsync(LocationName parent, ApiHubInstance apiHubInstance, String apiHubInstanceId)

  • createApiHubInstanceAsync(String parent, ApiHubInstance apiHubInstance, String apiHubInstanceId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createApiHubInstanceOperationCallable()

  • createApiHubInstanceCallable()

GetApiHubInstance

Gets details of a single API Hub instance.

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

  • getApiHubInstance(GetApiHubInstanceRequest request)

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

  • getApiHubInstance(ApiHubInstanceName name)

  • getApiHubInstance(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getApiHubInstanceCallable()

LookupApiHubInstance

Looks up an Api Hub instance in a given GCP project. There will always be only one Api Hub instance for a GCP project across all locations.

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

  • lookupApiHubInstance(LookupApiHubInstanceRequest request)

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

  • lookupApiHubInstance(LocationName parent)

  • lookupApiHubInstance(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • lookupApiHubInstanceCallable()

ListLocations

Lists information about the supported locations for this service.

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

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

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

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ProvisioningSettings 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
 ProvisioningSettings provisioningSettings =
     ProvisioningSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ProvisioningClient provisioningClient = ProvisioningClient.create(provisioningSettings);

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
 ProvisioningSettings provisioningSettings =
     ProvisioningSettings.newBuilder().setEndpoint(myEndpoint).build();
 ProvisioningClient provisioningClient = ProvisioningClient.create(provisioningSettings);

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

Inheritance

java.lang.Object > ProvisioningClient

Static Methods

create()

public static final ProvisioningClient create()

Constructs an instance of ProvisioningClient with default settings.

Returns
Type Description
ProvisioningClient
Exceptions
Type Description
IOException

create(ProvisioningSettings settings)

public static final ProvisioningClient create(ProvisioningSettings settings)

Constructs an instance of ProvisioningClient, 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 ProvisioningSettings
Returns
Type Description
ProvisioningClient
Exceptions
Type Description
IOException

create(ProvisioningStub stub)

public static final ProvisioningClient create(ProvisioningStub stub)

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

Parameter
Name Description
stub ProvisioningStub
Returns
Type Description
ProvisioningClient

Constructors

ProvisioningClient(ProvisioningSettings settings)

protected ProvisioningClient(ProvisioningSettings settings)

Constructs an instance of ProvisioningClient, 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 ProvisioningSettings

ProvisioningClient(ProvisioningStub stub)

protected ProvisioningClient(ProvisioningStub stub)
Parameter
Name Description
stub ProvisioningStub

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

createApiHubInstanceAsync(CreateApiHubInstanceRequest request)

public final OperationFuture<ApiHubInstance,OperationMetadata> createApiHubInstanceAsync(CreateApiHubInstanceRequest request)

Provisions instance resources for 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 (ProvisioningClient provisioningClient = ProvisioningClient.create()) {
   CreateApiHubInstanceRequest request =
       CreateApiHubInstanceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setApiHubInstanceId("apiHubInstanceId-1318600853")
           .setApiHubInstance(ApiHubInstance.newBuilder().build())
           .build();
   ApiHubInstance response = provisioningClient.createApiHubInstanceAsync(request).get();
 }
Parameter
Name Description
request CreateApiHubInstanceRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<ApiHubInstance,OperationMetadata>

createApiHubInstanceAsync(LocationName parent, ApiHubInstance apiHubInstance, String apiHubInstanceId)

public final OperationFuture<ApiHubInstance,OperationMetadata> createApiHubInstanceAsync(LocationName parent, ApiHubInstance apiHubInstance, String apiHubInstanceId)

Provisions instance resources for 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 (ProvisioningClient provisioningClient = ProvisioningClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ApiHubInstance apiHubInstance = ApiHubInstance.newBuilder().build();
   String apiHubInstanceId = "apiHubInstanceId-1318600853";
   ApiHubInstance response =
       provisioningClient
           .createApiHubInstanceAsync(parent, apiHubInstance, apiHubInstanceId)
           .get();
 }
Parameters
Name Description
parent LocationName

Required. The parent resource for the Api Hub instance resource. Format: projects/{project}/locations/{location}
apiHubInstance ApiHubInstance

Required. The ApiHub instance.
apiHubInstanceId String

Optional. Identifier to assign to the Api Hub instance. Must be unique within scope of the parent resource. If the field is not provided, system generated id will be used.

This value should be 4-40 characters, and valid characters are /a-z[0-9]-_/.
Returns
Type Description
OperationFuture<ApiHubInstance,OperationMetadata>

createApiHubInstanceAsync(String parent, ApiHubInstance apiHubInstance, String apiHubInstanceId)

public final OperationFuture<ApiHubInstance,OperationMetadata> createApiHubInstanceAsync(String parent, ApiHubInstance apiHubInstance, String apiHubInstanceId)

Provisions instance resources for 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 (ProvisioningClient provisioningClient = ProvisioningClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   ApiHubInstance apiHubInstance = ApiHubInstance.newBuilder().build();
   String apiHubInstanceId = "apiHubInstanceId-1318600853";
   ApiHubInstance response =
       provisioningClient
           .createApiHubInstanceAsync(parent, apiHubInstance, apiHubInstanceId)
           .get();
 }
Parameters
Name Description
parent String

Required. The parent resource for the Api Hub instance resource. Format: projects/{project}/locations/{location}
apiHubInstance ApiHubInstance

Required. The ApiHub instance.
apiHubInstanceId String

Optional. Identifier to assign to the Api Hub instance. Must be unique within scope of the parent resource. If the field is not provided, system generated id will be used.

This value should be 4-40 characters, and valid characters are /a-z[0-9]-_/.
Returns
Type Description
OperationFuture<ApiHubInstance,OperationMetadata>

createApiHubInstanceCallable()

public final UnaryCallable<CreateApiHubInstanceRequest,Operation> createApiHubInstanceCallable()

Provisions instance resources for 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 (ProvisioningClient provisioningClient = ProvisioningClient.create()) {
   CreateApiHubInstanceRequest request =
       CreateApiHubInstanceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setApiHubInstanceId("apiHubInstanceId-1318600853")
           .setApiHubInstance(ApiHubInstance.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       provisioningClient.createApiHubInstanceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateApiHubInstanceRequest,Operation>

createApiHubInstanceOperationCallable()

public final OperationCallable<CreateApiHubInstanceRequest,ApiHubInstance,OperationMetadata> createApiHubInstanceOperationCallable()

Provisions instance resources for 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 (ProvisioningClient provisioningClient = ProvisioningClient.create()) {
   CreateApiHubInstanceRequest request =
       CreateApiHubInstanceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setApiHubInstanceId("apiHubInstanceId-1318600853")
           .setApiHubInstance(ApiHubInstance.newBuilder().build())
           .build();
   OperationFuture<ApiHubInstance, OperationMetadata> future =
       provisioningClient.createApiHubInstanceOperationCallable().futureCall(request);
   // Do something.
   ApiHubInstance response = future.get();
 }
Returns
Type Description
OperationCallable<CreateApiHubInstanceRequest,ApiHubInstance,OperationMetadata>

getApiHubInstance(ApiHubInstanceName name)

public final ApiHubInstance getApiHubInstance(ApiHubInstanceName name)

Gets details of a single API Hub 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 (ProvisioningClient provisioningClient = ProvisioningClient.create()) {
   ApiHubInstanceName name =
       ApiHubInstanceName.of("[PROJECT]", "[LOCATION]", "[API_HUB_INSTANCE]");
   ApiHubInstance response = provisioningClient.getApiHubInstance(name);
 }
Parameter
Name Description
name ApiHubInstanceName

Required. The name of the Api Hub instance to retrieve. Format: projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}.
Returns
Type Description
ApiHubInstance

getApiHubInstance(GetApiHubInstanceRequest request)

public final ApiHubInstance getApiHubInstance(GetApiHubInstanceRequest request)

Gets details of a single API Hub 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 (ProvisioningClient provisioningClient = ProvisioningClient.create()) {
   GetApiHubInstanceRequest request =
       GetApiHubInstanceRequest.newBuilder()
           .setName(
               ApiHubInstanceName.of("[PROJECT]", "[LOCATION]", "[API_HUB_INSTANCE]").toString())
           .build();
   ApiHubInstance response = provisioningClient.getApiHubInstance(request);
 }
Parameter
Name Description
request GetApiHubInstanceRequest

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

getApiHubInstance(String name)

public final ApiHubInstance getApiHubInstance(String name)

Gets details of a single API Hub 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 (ProvisioningClient provisioningClient = ProvisioningClient.create()) {
   String name =
       ApiHubInstanceName.of("[PROJECT]", "[LOCATION]", "[API_HUB_INSTANCE]").toString();
   ApiHubInstance response = provisioningClient.getApiHubInstance(name);
 }
Parameter
Name Description
name String

Required. The name of the Api Hub instance to retrieve. Format: projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}.
Returns
Type Description
ApiHubInstance

getApiHubInstanceCallable()

public final UnaryCallable<GetApiHubInstanceRequest,ApiHubInstance> getApiHubInstanceCallable()

Gets details of a single API Hub 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 (ProvisioningClient provisioningClient = ProvisioningClient.create()) {
   GetApiHubInstanceRequest request =
       GetApiHubInstanceRequest.newBuilder()
           .setName(
               ApiHubInstanceName.of("[PROJECT]", "[LOCATION]", "[API_HUB_INSTANCE]").toString())
           .build();
   ApiFuture<ApiHubInstance> future =
       provisioningClient.getApiHubInstanceCallable().futureCall(request);
   // Do something.
   ApiHubInstance response = future.get();
 }
Returns
Type Description
UnaryCallable<GetApiHubInstanceRequest,ApiHubInstance>

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 (ProvisioningClient provisioningClient = ProvisioningClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = provisioningClient.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 (ProvisioningClient provisioningClient = ProvisioningClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = provisioningClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getSettings()

public final ProvisioningSettings getSettings()
Returns
Type Description
ProvisioningSettings

getStub()

public ProvisioningStub getStub()
Returns
Type Description
ProvisioningStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listLocations(ListLocationsRequest request)

public final ProvisioningClient.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 (ProvisioningClient provisioningClient = ProvisioningClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : provisioningClient.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
ProvisioningClient.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 (ProvisioningClient provisioningClient = ProvisioningClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = provisioningClient.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,ProvisioningClient.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 (ProvisioningClient provisioningClient = ProvisioningClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       provisioningClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

lookupApiHubInstance(LocationName parent)

public final LookupApiHubInstanceResponse lookupApiHubInstance(LocationName parent)

Looks up an Api Hub instance in a given GCP project. There will always be only one Api Hub instance for a GCP project across all locations.

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 (ProvisioningClient provisioningClient = ProvisioningClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   LookupApiHubInstanceResponse response = provisioningClient.lookupApiHubInstance(parent);
 }
Parameter
Name Description
parent LocationName

Required. There will always be only one Api Hub instance for a GCP project across all locations. The parent resource for the Api Hub instance resource. Format: projects/{project}/locations/{location}
Returns
Type Description
LookupApiHubInstanceResponse

lookupApiHubInstance(LookupApiHubInstanceRequest request)

public final LookupApiHubInstanceResponse lookupApiHubInstance(LookupApiHubInstanceRequest request)

Looks up an Api Hub instance in a given GCP project. There will always be only one Api Hub instance for a GCP project across all locations.

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 (ProvisioningClient provisioningClient = ProvisioningClient.create()) {
   LookupApiHubInstanceRequest request =
       LookupApiHubInstanceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   LookupApiHubInstanceResponse response = provisioningClient.lookupApiHubInstance(request);
 }
Parameter
Name Description
request LookupApiHubInstanceRequest

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

lookupApiHubInstance(String parent)

public final LookupApiHubInstanceResponse lookupApiHubInstance(String parent)

Looks up an Api Hub instance in a given GCP project. There will always be only one Api Hub instance for a GCP project across all locations.

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 (ProvisioningClient provisioningClient = ProvisioningClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   LookupApiHubInstanceResponse response = provisioningClient.lookupApiHubInstance(parent);
 }
Parameter
Name Description
parent String

Required. There will always be only one Api Hub instance for a GCP project across all locations. The parent resource for the Api Hub instance resource. Format: projects/{project}/locations/{location}
Returns
Type Description
LookupApiHubInstanceResponse

lookupApiHubInstanceCallable()

public final UnaryCallable<LookupApiHubInstanceRequest,LookupApiHubInstanceResponse> lookupApiHubInstanceCallable()

Looks up an Api Hub instance in a given GCP project. There will always be only one Api Hub instance for a GCP project across all locations.

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 (ProvisioningClient provisioningClient = ProvisioningClient.create()) {
   LookupApiHubInstanceRequest request =
       LookupApiHubInstanceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ApiFuture<LookupApiHubInstanceResponse> future =
       provisioningClient.lookupApiHubInstanceCallable().futureCall(request);
   // Do something.
   LookupApiHubInstanceResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<LookupApiHubInstanceRequest,LookupApiHubInstanceResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()