Class HubServiceClient (1.50.0)

GitHub RepositoryProduct Reference

Service Description: Network Connectivity Center is a hub-and-spoke abstraction for network connectivity management in Google Cloud. It reduces operational complexity through a simple, centralized connectivity management model.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   HubName name = HubName.of("[PROJECT]", "[HUB]");
   Hub response = hubServiceClient.getHub(name);
 }
 

Note: close() needs to be called on the HubServiceClient 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

ListHubs

Lists the Network Connectivity Center hubs associated with a given project.

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

  • listHubs(ListHubsRequest request)

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

  • listHubs(LocationName parent)

  • listHubs(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.

  • listHubsPagedCallable()

  • listHubsCallable()

GetHub

Gets details about a Network Connectivity Center hub.

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

  • getHub(GetHubRequest request)

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

  • getHub(HubName name)

  • getHub(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.

  • getHubCallable()

CreateHub

Creates a new Network Connectivity Center hub in the specified project.

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

  • createHubAsync(CreateHubRequest request)

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

  • createHubAsync(LocationName parent, Hub hub, String hubId)

  • createHubAsync(String parent, Hub hub, String hubId)

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

  • createHubOperationCallable()

  • createHubCallable()

UpdateHub

Updates the description and/or labels of a Network Connectivity Center hub.

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

  • updateHubAsync(UpdateHubRequest request)

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

  • updateHubAsync(Hub hub, FieldMask updateMask)

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

  • updateHubOperationCallable()

  • updateHubCallable()

DeleteHub

Deletes a Network Connectivity Center hub.

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

  • deleteHubAsync(DeleteHubRequest request)

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

  • deleteHubAsync(HubName name)

  • deleteHubAsync(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.

  • deleteHubOperationCallable()

  • deleteHubCallable()

ListHubSpokes

Lists the Network Connectivity Center spokes associated with a specified hub and location. The list includes both spokes that are attached to the hub and spokes that have been proposed but not yet accepted.

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

  • listHubSpokes(ListHubSpokesRequest request)

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

  • listHubSpokes(HubName name)

  • listHubSpokes(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.

  • listHubSpokesPagedCallable()

  • listHubSpokesCallable()

ListSpokes

Lists the Network Connectivity Center spokes in a specified project and location.

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

  • listSpokes(ListSpokesRequest request)

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

  • listSpokes(LocationName parent)

  • listSpokes(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.

  • listSpokesPagedCallable()

  • listSpokesCallable()

GetSpoke

Gets details about a Network Connectivity Center spoke.

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

  • getSpoke(GetSpokeRequest request)

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

  • getSpoke(SpokeName name)

  • getSpoke(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.

  • getSpokeCallable()

CreateSpoke

Creates a Network Connectivity Center spoke.

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

  • createSpokeAsync(CreateSpokeRequest request)

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

  • createSpokeAsync(LocationName parent, Spoke spoke, String spokeId)

  • createSpokeAsync(String parent, Spoke spoke, String spokeId)

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

  • createSpokeOperationCallable()

  • createSpokeCallable()

UpdateSpoke

Updates the parameters of a Network Connectivity Center spoke.

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

  • updateSpokeAsync(UpdateSpokeRequest request)

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

  • updateSpokeAsync(Spoke spoke, FieldMask updateMask)

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

  • updateSpokeOperationCallable()

  • updateSpokeCallable()

RejectHubSpoke

Rejects a Network Connectivity Center spoke from being attached to a hub. If the spoke was previously in the ACTIVE state, it transitions to the INACTIVE state and is no longer able to connect to other spokes that are attached to the hub.

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

  • rejectHubSpokeAsync(RejectHubSpokeRequest request)

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

  • rejectHubSpokeAsync(HubName name, SpokeName spokeUri)

  • rejectHubSpokeAsync(HubName name, String spokeUri)

  • rejectHubSpokeAsync(String name, SpokeName spokeUri)

  • rejectHubSpokeAsync(String name, String spokeUri)

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

  • rejectHubSpokeOperationCallable()

  • rejectHubSpokeCallable()

AcceptHubSpoke

Accepts a proposal to attach a Network Connectivity Center spoke to a hub.

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

  • acceptHubSpokeAsync(AcceptHubSpokeRequest request)

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

  • acceptHubSpokeAsync(HubName name, SpokeName spokeUri)

  • acceptHubSpokeAsync(HubName name, String spokeUri)

  • acceptHubSpokeAsync(String name, SpokeName spokeUri)

  • acceptHubSpokeAsync(String name, String spokeUri)

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

  • acceptHubSpokeOperationCallable()

  • acceptHubSpokeCallable()

DeleteSpoke

Deletes a Network Connectivity Center spoke.

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

  • deleteSpokeAsync(DeleteSpokeRequest request)

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

  • deleteSpokeAsync(SpokeName name)

  • deleteSpokeAsync(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.

  • deleteSpokeOperationCallable()

  • deleteSpokeCallable()

GetRouteTable

Gets details about a Network Connectivity Center route table.

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

  • getRouteTable(GetRouteTableRequest request)

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

  • getRouteTable(RouteTableName name)

  • getRouteTable(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.

  • getRouteTableCallable()

GetRoute

Gets details about the specified route.

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

  • getRoute(GetRouteRequest request)

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

  • getRoute(HubRouteName name)

  • getRoute(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.

  • getRouteCallable()

ListRoutes

Lists routes in a given project.

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

  • listRoutes(ListRoutesRequest request)

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

  • listRoutes(RouteTableName parent)

  • listRoutes(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.

  • listRoutesPagedCallable()

  • listRoutesCallable()

ListRouteTables

Lists route tables in a given project.

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

  • listRouteTables(ListRouteTablesRequest request)

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

  • listRouteTables(HubName parent)

  • listRouteTables(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.

  • listRouteTablesPagedCallable()

  • listRouteTablesCallable()

GetGroup

Gets details about a Network Connectivity Center group.

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

  • getGroup(GetGroupRequest request)

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

  • getGroup(GroupName name)

  • getGroup(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.

  • getGroupCallable()

ListGroups

Lists groups in a given hub.

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

  • listGroups(ListGroupsRequest request)

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

  • listGroups(HubName parent)

  • listGroups(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.

  • listGroupsPagedCallable()

  • listGroupsCallable()

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

SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

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

  • setIamPolicy(SetIamPolicyRequest request)

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

  • setIamPolicyCallable()

GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

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

  • getIamPolicy(GetIamPolicyRequest request)

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

  • getIamPolicyCallable()

TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

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

  • testIamPermissions(TestIamPermissionsRequest request)

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

  • testIamPermissionsCallable()

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 HubServiceSettings 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
 HubServiceSettings hubServiceSettings =
     HubServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 HubServiceClient hubServiceClient = HubServiceClient.create(hubServiceSettings);
 

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
 HubServiceSettings hubServiceSettings =
     HubServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 HubServiceClient hubServiceClient = HubServiceClient.create(hubServiceSettings);
 

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

Inheritance

java.lang.Object > HubServiceClient

Static Methods

create()

public static final HubServiceClient create()

Constructs an instance of HubServiceClient with default settings.

Returns
Type Description
HubServiceClient
Exceptions
Type Description
IOException

create(HubServiceSettings settings)

public static final HubServiceClient create(HubServiceSettings settings)

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

create(HubServiceStub stub)

public static final HubServiceClient create(HubServiceStub stub)

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

Parameter
Name Description
stub HubServiceStub
Returns
Type Description
HubServiceClient

Constructors

HubServiceClient(HubServiceSettings settings)

protected HubServiceClient(HubServiceSettings settings)

Constructs an instance of HubServiceClient, 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 HubServiceSettings

HubServiceClient(HubServiceStub stub)

protected HubServiceClient(HubServiceStub stub)
Parameter
Name Description
stub HubServiceStub

Methods

acceptHubSpokeAsync(AcceptHubSpokeRequest request)

public final OperationFuture<AcceptHubSpokeResponse,OperationMetadata> acceptHubSpokeAsync(AcceptHubSpokeRequest request)

Accepts a proposal to attach a Network Connectivity Center spoke to a 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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   AcceptHubSpokeRequest request =
       AcceptHubSpokeRequest.newBuilder()
           .setName(HubName.of("[PROJECT]", "[HUB]").toString())
           .setSpokeUri(SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]").toString())
           .setRequestId("requestId693933066")
           .build();
   AcceptHubSpokeResponse response = hubServiceClient.acceptHubSpokeAsync(request).get();
 }
 
Parameter
Name Description
request AcceptHubSpokeRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<AcceptHubSpokeResponse,OperationMetadata>

acceptHubSpokeAsync(HubName name, SpokeName spokeUri)

public final OperationFuture<AcceptHubSpokeResponse,OperationMetadata> acceptHubSpokeAsync(HubName name, SpokeName spokeUri)

Accepts a proposal to attach a Network Connectivity Center spoke to a 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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   HubName name = HubName.of("[PROJECT]", "[HUB]");
   SpokeName spokeUri = SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]");
   AcceptHubSpokeResponse response = hubServiceClient.acceptHubSpokeAsync(name, spokeUri).get();
 }
 
Parameters
Name Description
name HubName

Required. The name of the hub into which to accept the spoke.

spokeUri SpokeName

Required. The URI of the spoke to accept into the hub.

Returns
Type Description
OperationFuture<AcceptHubSpokeResponse,OperationMetadata>

acceptHubSpokeAsync(HubName name, String spokeUri)

public final OperationFuture<AcceptHubSpokeResponse,OperationMetadata> acceptHubSpokeAsync(HubName name, String spokeUri)

Accepts a proposal to attach a Network Connectivity Center spoke to a 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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   HubName name = HubName.of("[PROJECT]", "[HUB]");
   String spokeUri = SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]").toString();
   AcceptHubSpokeResponse response = hubServiceClient.acceptHubSpokeAsync(name, spokeUri).get();
 }
 
Parameters
Name Description
name HubName

Required. The name of the hub into which to accept the spoke.

spokeUri String

Required. The URI of the spoke to accept into the hub.

Returns
Type Description
OperationFuture<AcceptHubSpokeResponse,OperationMetadata>

acceptHubSpokeAsync(String name, SpokeName spokeUri)

public final OperationFuture<AcceptHubSpokeResponse,OperationMetadata> acceptHubSpokeAsync(String name, SpokeName spokeUri)

Accepts a proposal to attach a Network Connectivity Center spoke to a 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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   String name = HubName.of("[PROJECT]", "[HUB]").toString();
   SpokeName spokeUri = SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]");
   AcceptHubSpokeResponse response = hubServiceClient.acceptHubSpokeAsync(name, spokeUri).get();
 }
 
Parameters
Name Description
name String

Required. The name of the hub into which to accept the spoke.

spokeUri SpokeName

Required. The URI of the spoke to accept into the hub.

Returns
Type Description
OperationFuture<AcceptHubSpokeResponse,OperationMetadata>

acceptHubSpokeAsync(String name, String spokeUri)

public final OperationFuture<AcceptHubSpokeResponse,OperationMetadata> acceptHubSpokeAsync(String name, String spokeUri)

Accepts a proposal to attach a Network Connectivity Center spoke to a 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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   String name = HubName.of("[PROJECT]", "[HUB]").toString();
   String spokeUri = SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]").toString();
   AcceptHubSpokeResponse response = hubServiceClient.acceptHubSpokeAsync(name, spokeUri).get();
 }
 
Parameters
Name Description
name String

Required. The name of the hub into which to accept the spoke.

spokeUri String

Required. The URI of the spoke to accept into the hub.

Returns
Type Description
OperationFuture<AcceptHubSpokeResponse,OperationMetadata>

acceptHubSpokeCallable()

public final UnaryCallable<AcceptHubSpokeRequest,Operation> acceptHubSpokeCallable()

Accepts a proposal to attach a Network Connectivity Center spoke to a 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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   AcceptHubSpokeRequest request =
       AcceptHubSpokeRequest.newBuilder()
           .setName(HubName.of("[PROJECT]", "[HUB]").toString())
           .setSpokeUri(SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = hubServiceClient.acceptHubSpokeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<AcceptHubSpokeRequest,Operation>

acceptHubSpokeOperationCallable()

public final OperationCallable<AcceptHubSpokeRequest,AcceptHubSpokeResponse,OperationMetadata> acceptHubSpokeOperationCallable()

Accepts a proposal to attach a Network Connectivity Center spoke to a 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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   AcceptHubSpokeRequest request =
       AcceptHubSpokeRequest.newBuilder()
           .setName(HubName.of("[PROJECT]", "[HUB]").toString())
           .setSpokeUri(SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<AcceptHubSpokeResponse, OperationMetadata> future =
       hubServiceClient.acceptHubSpokeOperationCallable().futureCall(request);
   // Do something.
   AcceptHubSpokeResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<AcceptHubSpokeRequest,AcceptHubSpokeResponse,OperationMetadata>

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

createHubAsync(CreateHubRequest request)

public final OperationFuture<Hub,OperationMetadata> createHubAsync(CreateHubRequest request)

Creates a new Network Connectivity Center hub in the specified project.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   CreateHubRequest request =
       CreateHubRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setHubId("hubId99628272")
           .setHub(Hub.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Hub response = hubServiceClient.createHubAsync(request).get();
 }
 
Parameter
Name Description
request CreateHubRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Hub,OperationMetadata>

createHubAsync(LocationName parent, Hub hub, String hubId)

public final OperationFuture<Hub,OperationMetadata> createHubAsync(LocationName parent, Hub hub, String hubId)

Creates a new Network Connectivity Center hub in the specified project.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Hub hub = Hub.newBuilder().build();
   String hubId = "hubId99628272";
   Hub response = hubServiceClient.createHubAsync(parent, hub, hubId).get();
 }
 
Parameters
Name Description
parent LocationName

Required. The parent resource.

hub Hub

Required. The initial values for a new hub.

hubId String

Required. A unique identifier for the hub.

Returns
Type Description
OperationFuture<Hub,OperationMetadata>

createHubAsync(String parent, Hub hub, String hubId)

public final OperationFuture<Hub,OperationMetadata> createHubAsync(String parent, Hub hub, String hubId)

Creates a new Network Connectivity Center hub in the specified project.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Hub hub = Hub.newBuilder().build();
   String hubId = "hubId99628272";
   Hub response = hubServiceClient.createHubAsync(parent, hub, hubId).get();
 }
 
Parameters
Name Description
parent String

Required. The parent resource.

hub Hub

Required. The initial values for a new hub.

hubId String

Required. A unique identifier for the hub.

Returns
Type Description
OperationFuture<Hub,OperationMetadata>

createHubCallable()

public final UnaryCallable<CreateHubRequest,Operation> createHubCallable()

Creates a new Network Connectivity Center hub in the specified project.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   CreateHubRequest request =
       CreateHubRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setHubId("hubId99628272")
           .setHub(Hub.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = hubServiceClient.createHubCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateHubRequest,Operation>

createHubOperationCallable()

public final OperationCallable<CreateHubRequest,Hub,OperationMetadata> createHubOperationCallable()

Creates a new Network Connectivity Center hub in the specified project.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   CreateHubRequest request =
       CreateHubRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setHubId("hubId99628272")
           .setHub(Hub.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Hub, OperationMetadata> future =
       hubServiceClient.createHubOperationCallable().futureCall(request);
   // Do something.
   Hub response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateHubRequest,Hub,OperationMetadata>

createSpokeAsync(CreateSpokeRequest request)

public final OperationFuture<Spoke,OperationMetadata> createSpokeAsync(CreateSpokeRequest request)

Creates a Network Connectivity Center spoke.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   CreateSpokeRequest request =
       CreateSpokeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSpokeId("spokeId-1998996281")
           .setSpoke(Spoke.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Spoke response = hubServiceClient.createSpokeAsync(request).get();
 }
 
Parameter
Name Description
request CreateSpokeRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Spoke,OperationMetadata>

createSpokeAsync(LocationName parent, Spoke spoke, String spokeId)

public final OperationFuture<Spoke,OperationMetadata> createSpokeAsync(LocationName parent, Spoke spoke, String spokeId)

Creates a Network Connectivity Center spoke.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Spoke spoke = Spoke.newBuilder().build();
   String spokeId = "spokeId-1998996281";
   Spoke response = hubServiceClient.createSpokeAsync(parent, spoke, spokeId).get();
 }
 
Parameters
Name Description
parent LocationName

Required. The parent resource.

spoke Spoke

Required. The initial values for a new spoke.

spokeId String

Required. Unique id for the spoke to create.

Returns
Type Description
OperationFuture<Spoke,OperationMetadata>

createSpokeAsync(String parent, Spoke spoke, String spokeId)

public final OperationFuture<Spoke,OperationMetadata> createSpokeAsync(String parent, Spoke spoke, String spokeId)

Creates a Network Connectivity Center spoke.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Spoke spoke = Spoke.newBuilder().build();
   String spokeId = "spokeId-1998996281";
   Spoke response = hubServiceClient.createSpokeAsync(parent, spoke, spokeId).get();
 }
 
Parameters
Name Description
parent String

Required. The parent resource.

spoke Spoke

Required. The initial values for a new spoke.

spokeId String

Required. Unique id for the spoke to create.

Returns
Type Description
OperationFuture<Spoke,OperationMetadata>

createSpokeCallable()

public final UnaryCallable<CreateSpokeRequest,Operation> createSpokeCallable()

Creates a Network Connectivity Center spoke.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   CreateSpokeRequest request =
       CreateSpokeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSpokeId("spokeId-1998996281")
           .setSpoke(Spoke.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = hubServiceClient.createSpokeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateSpokeRequest,Operation>

createSpokeOperationCallable()

public final OperationCallable<CreateSpokeRequest,Spoke,OperationMetadata> createSpokeOperationCallable()

Creates a Network Connectivity Center spoke.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   CreateSpokeRequest request =
       CreateSpokeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSpokeId("spokeId-1998996281")
           .setSpoke(Spoke.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Spoke, OperationMetadata> future =
       hubServiceClient.createSpokeOperationCallable().futureCall(request);
   // Do something.
   Spoke response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateSpokeRequest,Spoke,OperationMetadata>

deleteHubAsync(DeleteHubRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteHubAsync(DeleteHubRequest request)

Deletes a Network Connectivity Center 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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   DeleteHubRequest request =
       DeleteHubRequest.newBuilder()
           .setName(HubName.of("[PROJECT]", "[HUB]").toString())
           .setRequestId("requestId693933066")
           .build();
   hubServiceClient.deleteHubAsync(request).get();
 }
 
Parameter
Name Description
request DeleteHubRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteHubAsync(HubName name)

public final OperationFuture<Empty,OperationMetadata> deleteHubAsync(HubName name)

Deletes a Network Connectivity Center 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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   HubName name = HubName.of("[PROJECT]", "[HUB]");
   hubServiceClient.deleteHubAsync(name).get();
 }
 
Parameter
Name Description
name HubName

Required. The name of the hub to delete.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteHubAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteHubAsync(String name)

Deletes a Network Connectivity Center 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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   String name = HubName.of("[PROJECT]", "[HUB]").toString();
   hubServiceClient.deleteHubAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. The name of the hub to delete.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteHubCallable()

public final UnaryCallable<DeleteHubRequest,Operation> deleteHubCallable()

Deletes a Network Connectivity Center 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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   DeleteHubRequest request =
       DeleteHubRequest.newBuilder()
           .setName(HubName.of("[PROJECT]", "[HUB]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = hubServiceClient.deleteHubCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteHubRequest,Operation>

deleteHubOperationCallable()

public final OperationCallable<DeleteHubRequest,Empty,OperationMetadata> deleteHubOperationCallable()

Deletes a Network Connectivity Center 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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   DeleteHubRequest request =
       DeleteHubRequest.newBuilder()
           .setName(HubName.of("[PROJECT]", "[HUB]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       hubServiceClient.deleteHubOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteHubRequest,Empty,OperationMetadata>

deleteSpokeAsync(DeleteSpokeRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteSpokeAsync(DeleteSpokeRequest request)

Deletes a Network Connectivity Center spoke.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   DeleteSpokeRequest request =
       DeleteSpokeRequest.newBuilder()
           .setName(SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]").toString())
           .setRequestId("requestId693933066")
           .build();
   hubServiceClient.deleteSpokeAsync(request).get();
 }
 
Parameter
Name Description
request DeleteSpokeRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteSpokeAsync(SpokeName name)

public final OperationFuture<Empty,OperationMetadata> deleteSpokeAsync(SpokeName name)

Deletes a Network Connectivity Center spoke.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   SpokeName name = SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]");
   hubServiceClient.deleteSpokeAsync(name).get();
 }
 
Parameter
Name Description
name SpokeName

Required. The name of the spoke to delete.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteSpokeAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteSpokeAsync(String name)

Deletes a Network Connectivity Center spoke.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   String name = SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]").toString();
   hubServiceClient.deleteSpokeAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. The name of the spoke to delete.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteSpokeCallable()

public final UnaryCallable<DeleteSpokeRequest,Operation> deleteSpokeCallable()

Deletes a Network Connectivity Center spoke.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   DeleteSpokeRequest request =
       DeleteSpokeRequest.newBuilder()
           .setName(SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = hubServiceClient.deleteSpokeCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteSpokeRequest,Operation>

deleteSpokeOperationCallable()

public final OperationCallable<DeleteSpokeRequest,Empty,OperationMetadata> deleteSpokeOperationCallable()

Deletes a Network Connectivity Center spoke.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   DeleteSpokeRequest request =
       DeleteSpokeRequest.newBuilder()
           .setName(SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       hubServiceClient.deleteSpokeOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteSpokeRequest,Empty,OperationMetadata>

getGroup(GetGroupRequest request)

public final Group getGroup(GetGroupRequest request)

Gets details about a Network Connectivity Center group.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   GetGroupRequest request =
       GetGroupRequest.newBuilder()
           .setName(GroupName.of("[PROJECT]", "[HUB]", "[GROUP]").toString())
           .build();
   Group response = hubServiceClient.getGroup(request);
 }
 
Parameter
Name Description
request GetGroupRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Group

getGroup(GroupName name)

public final Group getGroup(GroupName name)

Gets details about a Network Connectivity Center group.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   GroupName name = GroupName.of("[PROJECT]", "[HUB]", "[GROUP]");
   Group response = hubServiceClient.getGroup(name);
 }
 
Parameter
Name Description
name GroupName

Required. The name of the route table resource.

Returns
Type Description
Group

getGroup(String name)

public final Group getGroup(String name)

Gets details about a Network Connectivity Center group.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   String name = GroupName.of("[PROJECT]", "[HUB]", "[GROUP]").toString();
   Group response = hubServiceClient.getGroup(name);
 }
 
Parameter
Name Description
name String

Required. The name of the route table resource.

Returns
Type Description
Group

getGroupCallable()

public final UnaryCallable<GetGroupRequest,Group> getGroupCallable()

Gets details about a Network Connectivity Center group.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   GetGroupRequest request =
       GetGroupRequest.newBuilder()
           .setName(GroupName.of("[PROJECT]", "[HUB]", "[GROUP]").toString())
           .build();
   ApiFuture<Group> future = hubServiceClient.getGroupCallable().futureCall(request);
   // Do something.
   Group response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetGroupRequest,Group>

getHub(GetHubRequest request)

public final Hub getHub(GetHubRequest request)

Gets details about a Network Connectivity Center 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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   GetHubRequest request =
       GetHubRequest.newBuilder().setName(HubName.of("[PROJECT]", "[HUB]").toString()).build();
   Hub response = hubServiceClient.getHub(request);
 }
 
Parameter
Name Description
request GetHubRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Hub

getHub(HubName name)

public final Hub getHub(HubName name)

Gets details about a Network Connectivity Center 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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   HubName name = HubName.of("[PROJECT]", "[HUB]");
   Hub response = hubServiceClient.getHub(name);
 }
 
Parameter
Name Description
name HubName

Required. The name of the hub resource to get.

Returns
Type Description
Hub

getHub(String name)

public final Hub getHub(String name)

Gets details about a Network Connectivity Center 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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   String name = HubName.of("[PROJECT]", "[HUB]").toString();
   Hub response = hubServiceClient.getHub(name);
 }
 
Parameter
Name Description
name String

Required. The name of the hub resource to get.

Returns
Type Description
Hub

getHubCallable()

public final UnaryCallable<GetHubRequest,Hub> getHubCallable()

Gets details about a Network Connectivity Center 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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   GetHubRequest request =
       GetHubRequest.newBuilder().setName(HubName.of("[PROJECT]", "[HUB]").toString()).build();
   ApiFuture<Hub> future = hubServiceClient.getHubCallable().futureCall(request);
   // Do something.
   Hub response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetHubRequest,Hub>

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(GroupName.of("[PROJECT]", "[HUB]", "[GROUP]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = hubServiceClient.getIamPolicy(request);
 }
 
Parameter
Name Description
request com.google.iam.v1.GetIamPolicyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(GroupName.of("[PROJECT]", "[HUB]", "[GROUP]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = hubServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

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

getOperationsClient()

public final OperationsClient getOperationsClient()

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

getRoute(GetRouteRequest request)

public final Route getRoute(GetRouteRequest request)

Gets details about the specified route.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   GetRouteRequest request =
       GetRouteRequest.newBuilder()
           .setName(HubRouteName.of("[PROJECT]", "[HUB]", "[ROUTE_TABLE]", "[ROUTE]").toString())
           .build();
   Route response = hubServiceClient.getRoute(request);
 }
 
Parameter
Name Description
request GetRouteRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Route

getRoute(HubRouteName name)

public final Route getRoute(HubRouteName name)

Gets details about the specified route.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   HubRouteName name = HubRouteName.of("[PROJECT]", "[HUB]", "[ROUTE_TABLE]", "[ROUTE]");
   Route response = hubServiceClient.getRoute(name);
 }
 
Parameter
Name Description
name HubRouteName

Required. The name of the route resource.

Returns
Type Description
Route

getRoute(String name)

public final Route getRoute(String name)

Gets details about the specified route.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   String name = HubRouteName.of("[PROJECT]", "[HUB]", "[ROUTE_TABLE]", "[ROUTE]").toString();
   Route response = hubServiceClient.getRoute(name);
 }
 
Parameter
Name Description
name String

Required. The name of the route resource.

Returns
Type Description
Route

getRouteCallable()

public final UnaryCallable<GetRouteRequest,Route> getRouteCallable()

Gets details about the specified route.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   GetRouteRequest request =
       GetRouteRequest.newBuilder()
           .setName(HubRouteName.of("[PROJECT]", "[HUB]", "[ROUTE_TABLE]", "[ROUTE]").toString())
           .build();
   ApiFuture<Route> future = hubServiceClient.getRouteCallable().futureCall(request);
   // Do something.
   Route response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetRouteRequest,Route>

getRouteTable(GetRouteTableRequest request)

public final RouteTable getRouteTable(GetRouteTableRequest request)

Gets details about a Network Connectivity Center route table.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   GetRouteTableRequest request =
       GetRouteTableRequest.newBuilder()
           .setName(RouteTableName.of("[PROJECT]", "[HUB]", "[ROUTE_TABLE]").toString())
           .build();
   RouteTable response = hubServiceClient.getRouteTable(request);
 }
 
Parameter
Name Description
request GetRouteTableRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
RouteTable

getRouteTable(RouteTableName name)

public final RouteTable getRouteTable(RouteTableName name)

Gets details about a Network Connectivity Center route table.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   RouteTableName name = RouteTableName.of("[PROJECT]", "[HUB]", "[ROUTE_TABLE]");
   RouteTable response = hubServiceClient.getRouteTable(name);
 }
 
Parameter
Name Description
name RouteTableName

Required. The name of the route table resource.

Returns
Type Description
RouteTable

getRouteTable(String name)

public final RouteTable getRouteTable(String name)

Gets details about a Network Connectivity Center route table.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   String name = RouteTableName.of("[PROJECT]", "[HUB]", "[ROUTE_TABLE]").toString();
   RouteTable response = hubServiceClient.getRouteTable(name);
 }
 
Parameter
Name Description
name String

Required. The name of the route table resource.

Returns
Type Description
RouteTable

getRouteTableCallable()

public final UnaryCallable<GetRouteTableRequest,RouteTable> getRouteTableCallable()

Gets details about a Network Connectivity Center route table.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   GetRouteTableRequest request =
       GetRouteTableRequest.newBuilder()
           .setName(RouteTableName.of("[PROJECT]", "[HUB]", "[ROUTE_TABLE]").toString())
           .build();
   ApiFuture<RouteTable> future = hubServiceClient.getRouteTableCallable().futureCall(request);
   // Do something.
   RouteTable response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetRouteTableRequest,RouteTable>

getSettings()

public final HubServiceSettings getSettings()
Returns
Type Description
HubServiceSettings

getSpoke(GetSpokeRequest request)

public final Spoke getSpoke(GetSpokeRequest request)

Gets details about a Network Connectivity Center spoke.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   GetSpokeRequest request =
       GetSpokeRequest.newBuilder()
           .setName(SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]").toString())
           .build();
   Spoke response = hubServiceClient.getSpoke(request);
 }
 
Parameter
Name Description
request GetSpokeRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Spoke

getSpoke(SpokeName name)

public final Spoke getSpoke(SpokeName name)

Gets details about a Network Connectivity Center spoke.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   SpokeName name = SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]");
   Spoke response = hubServiceClient.getSpoke(name);
 }
 
Parameter
Name Description
name SpokeName

Required. The name of the spoke resource.

Returns
Type Description
Spoke

getSpoke(String name)

public final Spoke getSpoke(String name)

Gets details about a Network Connectivity Center spoke.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   String name = SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]").toString();
   Spoke response = hubServiceClient.getSpoke(name);
 }
 
Parameter
Name Description
name String

Required. The name of the spoke resource.

Returns
Type Description
Spoke

getSpokeCallable()

public final UnaryCallable<GetSpokeRequest,Spoke> getSpokeCallable()

Gets details about a Network Connectivity Center spoke.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   GetSpokeRequest request =
       GetSpokeRequest.newBuilder()
           .setName(SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]").toString())
           .build();
   ApiFuture<Spoke> future = hubServiceClient.getSpokeCallable().futureCall(request);
   // Do something.
   Spoke response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetSpokeRequest,Spoke>

getStub()

public HubServiceStub getStub()
Returns
Type Description
HubServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listGroups(HubName parent)

public final HubServiceClient.ListGroupsPagedResponse listGroups(HubName parent)

Lists groups in a given 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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   HubName parent = HubName.of("[PROJECT]", "[HUB]");
   for (Group element : hubServiceClient.listGroups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent HubName

Required. The parent resource's name.

Returns
Type Description
HubServiceClient.ListGroupsPagedResponse

listGroups(ListGroupsRequest request)

public final HubServiceClient.ListGroupsPagedResponse listGroups(ListGroupsRequest request)

Lists groups in a given 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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   ListGroupsRequest request =
       ListGroupsRequest.newBuilder()
           .setParent(HubName.of("[PROJECT]", "[HUB]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Group element : hubServiceClient.listGroups(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListGroupsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
HubServiceClient.ListGroupsPagedResponse

listGroups(String parent)

public final HubServiceClient.ListGroupsPagedResponse listGroups(String parent)

Lists groups in a given 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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   String parent = HubName.of("[PROJECT]", "[HUB]").toString();
   for (Group element : hubServiceClient.listGroups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The parent resource's name.

Returns
Type Description
HubServiceClient.ListGroupsPagedResponse

listGroupsCallable()

public final UnaryCallable<ListGroupsRequest,ListGroupsResponse> listGroupsCallable()

Lists groups in a given 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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   ListGroupsRequest request =
       ListGroupsRequest.newBuilder()
           .setParent(HubName.of("[PROJECT]", "[HUB]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListGroupsResponse response = hubServiceClient.listGroupsCallable().call(request);
     for (Group element : response.getGroupsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListGroupsRequest,ListGroupsResponse>

listGroupsPagedCallable()

public final UnaryCallable<ListGroupsRequest,HubServiceClient.ListGroupsPagedResponse> listGroupsPagedCallable()

Lists groups in a given 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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   ListGroupsRequest request =
       ListGroupsRequest.newBuilder()
           .setParent(HubName.of("[PROJECT]", "[HUB]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Group> future = hubServiceClient.listGroupsPagedCallable().futureCall(request);
   // Do something.
   for (Group element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListGroupsRequest,ListGroupsPagedResponse>

listHubSpokes(HubName name)

public final HubServiceClient.ListHubSpokesPagedResponse listHubSpokes(HubName name)

Lists the Network Connectivity Center spokes associated with a specified hub and location. The list includes both spokes that are attached to the hub and spokes that have been proposed but not yet accepted.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   HubName name = HubName.of("[PROJECT]", "[HUB]");
   for (Spoke element : hubServiceClient.listHubSpokes(name).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
name HubName

Required. The name of the hub.

Returns
Type Description
HubServiceClient.ListHubSpokesPagedResponse

listHubSpokes(ListHubSpokesRequest request)

public final HubServiceClient.ListHubSpokesPagedResponse listHubSpokes(ListHubSpokesRequest request)

Lists the Network Connectivity Center spokes associated with a specified hub and location. The list includes both spokes that are attached to the hub and spokes that have been proposed but not yet accepted.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   ListHubSpokesRequest request =
       ListHubSpokesRequest.newBuilder()
           .setName(HubName.of("[PROJECT]", "[HUB]").toString())
           .addAllSpokeLocations(new ArrayList<String>())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Spoke element : hubServiceClient.listHubSpokes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListHubSpokesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
HubServiceClient.ListHubSpokesPagedResponse

listHubSpokes(String name)

public final HubServiceClient.ListHubSpokesPagedResponse listHubSpokes(String name)

Lists the Network Connectivity Center spokes associated with a specified hub and location. The list includes both spokes that are attached to the hub and spokes that have been proposed but not yet accepted.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   String name = HubName.of("[PROJECT]", "[HUB]").toString();
   for (Spoke element : hubServiceClient.listHubSpokes(name).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
name String

Required. The name of the hub.

Returns
Type Description
HubServiceClient.ListHubSpokesPagedResponse

listHubSpokesCallable()

public final UnaryCallable<ListHubSpokesRequest,ListHubSpokesResponse> listHubSpokesCallable()

Lists the Network Connectivity Center spokes associated with a specified hub and location. The list includes both spokes that are attached to the hub and spokes that have been proposed but not yet accepted.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   ListHubSpokesRequest request =
       ListHubSpokesRequest.newBuilder()
           .setName(HubName.of("[PROJECT]", "[HUB]").toString())
           .addAllSpokeLocations(new ArrayList<String>())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListHubSpokesResponse response = hubServiceClient.listHubSpokesCallable().call(request);
     for (Spoke element : response.getSpokesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListHubSpokesRequest,ListHubSpokesResponse>

listHubSpokesPagedCallable()

public final UnaryCallable<ListHubSpokesRequest,HubServiceClient.ListHubSpokesPagedResponse> listHubSpokesPagedCallable()

Lists the Network Connectivity Center spokes associated with a specified hub and location. The list includes both spokes that are attached to the hub and spokes that have been proposed but not yet accepted.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   ListHubSpokesRequest request =
       ListHubSpokesRequest.newBuilder()
           .setName(HubName.of("[PROJECT]", "[HUB]").toString())
           .addAllSpokeLocations(new ArrayList<String>())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Spoke> future = hubServiceClient.listHubSpokesPagedCallable().futureCall(request);
   // Do something.
   for (Spoke element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListHubSpokesRequest,ListHubSpokesPagedResponse>

listHubs(ListHubsRequest request)

public final HubServiceClient.ListHubsPagedResponse listHubs(ListHubsRequest request)

Lists the Network Connectivity Center hubs associated with a given project.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   ListHubsRequest request =
       ListHubsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Hub element : hubServiceClient.listHubs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListHubsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
HubServiceClient.ListHubsPagedResponse

listHubs(LocationName parent)

public final HubServiceClient.ListHubsPagedResponse listHubs(LocationName parent)

Lists the Network Connectivity Center hubs associated with a given project.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Hub element : hubServiceClient.listHubs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. The parent resource's name.

Returns
Type Description
HubServiceClient.ListHubsPagedResponse

listHubs(String parent)

public final HubServiceClient.ListHubsPagedResponse listHubs(String parent)

Lists the Network Connectivity Center hubs associated with a given project.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Hub element : hubServiceClient.listHubs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The parent resource's name.

Returns
Type Description
HubServiceClient.ListHubsPagedResponse

listHubsCallable()

public final UnaryCallable<ListHubsRequest,ListHubsResponse> listHubsCallable()

Lists the Network Connectivity Center hubs associated with a given project.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   ListHubsRequest request =
       ListHubsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListHubsResponse response = hubServiceClient.listHubsCallable().call(request);
     for (Hub element : response.getHubsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListHubsRequest,ListHubsResponse>

listHubsPagedCallable()

public final UnaryCallable<ListHubsRequest,HubServiceClient.ListHubsPagedResponse> listHubsPagedCallable()

Lists the Network Connectivity Center hubs associated with a given project.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   ListHubsRequest request =
       ListHubsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Hub> future = hubServiceClient.listHubsPagedCallable().futureCall(request);
   // Do something.
   for (Hub element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListHubsRequest,ListHubsPagedResponse>

listLocations(ListLocationsRequest request)

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

listRouteTables(HubName parent)

public final HubServiceClient.ListRouteTablesPagedResponse listRouteTables(HubName parent)

Lists route tables in a given project.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   HubName parent = HubName.of("[PROJECT]", "[HUB]");
   for (RouteTable element : hubServiceClient.listRouteTables(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent HubName

Required. The parent resource's name.

Returns
Type Description
HubServiceClient.ListRouteTablesPagedResponse

listRouteTables(ListRouteTablesRequest request)

public final HubServiceClient.ListRouteTablesPagedResponse listRouteTables(ListRouteTablesRequest request)

Lists route tables in a given project.

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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   ListRouteTablesRequest request =
       ListRouteTablesRequest.newBuilder()
           .setParent(HubName.of("[PROJECT]", "[HUB]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (RouteTable element : hubServiceClient.listRouteTables(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListRouteTablesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
HubServiceClient.ListRouteTablesPagedResponse

listRouteTables(String parent)

public