Package com.google.cloud.networkconnectivity.v1 (0.5.0)

A client to Network Connectivity API

The interfaces provided are listed below, along with usage samples.

HubServiceClient

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.

Sample for HubServiceClient:


 try (HubServiceClient hubServiceClient = HubServiceClient.create()) {
   HubName name = HubName.of("[PROJECT]", "[HUB]");
   Hub response = hubServiceClient.getHub(name);
 }

Classes

CommonProto

CreateHubRequest

Request for HubService.CreateHub method.

Protobuf type google.cloud.networkconnectivity.v1.CreateHubRequest

CreateHubRequest.Builder

Request for HubService.CreateHub method.

Protobuf type google.cloud.networkconnectivity.v1.CreateHubRequest

CreateSpokeRequest

The request for HubService.CreateSpoke.

Protobuf type google.cloud.networkconnectivity.v1.CreateSpokeRequest

CreateSpokeRequest.Builder

The request for HubService.CreateSpoke.

Protobuf type google.cloud.networkconnectivity.v1.CreateSpokeRequest

DeleteHubRequest

The request for HubService.DeleteHub.

Protobuf type google.cloud.networkconnectivity.v1.DeleteHubRequest

DeleteHubRequest.Builder

The request for HubService.DeleteHub.

Protobuf type google.cloud.networkconnectivity.v1.DeleteHubRequest

DeleteSpokeRequest

The request for HubService.DeleteSpoke.

Protobuf type google.cloud.networkconnectivity.v1.DeleteSpokeRequest

DeleteSpokeRequest.Builder

The request for HubService.DeleteSpoke.

Protobuf type google.cloud.networkconnectivity.v1.DeleteSpokeRequest

GetHubRequest

Request for HubService.GetHub method.

Protobuf type google.cloud.networkconnectivity.v1.GetHubRequest

GetHubRequest.Builder

Request for HubService.GetHub method.

Protobuf type google.cloud.networkconnectivity.v1.GetHubRequest

GetSpokeRequest

The request for HubService.GetSpoke.

Protobuf type google.cloud.networkconnectivity.v1.GetSpokeRequest

GetSpokeRequest.Builder

The request for HubService.GetSpoke.

Protobuf type google.cloud.networkconnectivity.v1.GetSpokeRequest

Hub

A hub is a collection of spokes. A single hub can contain spokes from multiple regions. However, all of a hub's spokes must be associated with resources that reside in the same VPC network.

Protobuf type google.cloud.networkconnectivity.v1.Hub

Hub.Builder

A hub is a collection of spokes. A single hub can contain spokes from multiple regions. However, all of a hub's spokes must be associated with resources that reside in the same VPC network.

Protobuf type google.cloud.networkconnectivity.v1.Hub

HubName

HubName.Builder

Builder for projects/{project}/locations/global/hubs/{hub}.

HubProto

HubServiceClient

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:


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

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

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

This class can be customized by passing in a custom instance of HubServiceSettings to create(). For example:

To customize credentials:


 HubServiceSettings hubServiceSettings =
     HubServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 HubServiceClient hubServiceClient = HubServiceClient.create(hubServiceSettings);

To customize the endpoint:


 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.

HubServiceClient.ListHubsFixedSizeCollection

HubServiceClient.ListHubsPage

HubServiceClient.ListHubsPagedResponse

HubServiceClient.ListSpokesFixedSizeCollection

HubServiceClient.ListSpokesPage

HubServiceClient.ListSpokesPagedResponse

HubServiceGrpc

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.

HubServiceGrpc.HubServiceBlockingStub

HubServiceGrpc.HubServiceFutureStub

HubServiceGrpc.HubServiceImplBase

HubServiceGrpc.HubServiceStub

HubServiceSettings

Settings class to configure an instance of HubServiceClient.

The default instance has everything set to sensible defaults:

The default service address (networkconnectivity.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getHub to 30 seconds:


 HubServiceSettings.Builder hubServiceSettingsBuilder = HubServiceSettings.newBuilder();
 hubServiceSettingsBuilder
     .getHubSettings()
     .setRetrySettings(
         hubServiceSettingsBuilder
             .getHubSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 HubServiceSettings hubServiceSettings = hubServiceSettingsBuilder.build();

HubServiceSettings.Builder

Builder for HubServiceSettings.

LinkedInterconnectAttachments

A collection of VLAN attachment resources. These resources should be redundant attachments that all advertise the same prefixes to Google Cloud. Alternatively, in active/passive configurations, all attachments should be capable of advertising the same prefixes.

Protobuf type google.cloud.networkconnectivity.v1.LinkedInterconnectAttachments

LinkedInterconnectAttachments.Builder

Protobuf type google.cloud.networkconnectivity.v1.LinkedInterconnectAttachments

LinkedRouterApplianceInstances

A collection of router appliance instances. If you have multiple router appliance instances connected to the same site, they should all be attached to the same spoke.

Protobuf type google.cloud.networkconnectivity.v1.LinkedRouterApplianceInstances

LinkedRouterApplianceInstances.Builder

A collection of router appliance instances. If you have multiple router appliance instances connected to the same site, they should all be attached to the same spoke.

Protobuf type google.cloud.networkconnectivity.v1.LinkedRouterApplianceInstances

LinkedVpnTunnels

A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes.

Protobuf type google.cloud.networkconnectivity.v1.LinkedVpnTunnels

linked_vpn_tunnels
linked_interconnect_attachments
linked_router_appliance_instances

Protobuf type google.cloud.networkconnectivity.v1.Spoke

Spoke.Builder

linked_vpn_tunnels
linked_interconnect_attachments
linked_router_appliance_instances

Protobuf type google.cloud.networkconnectivity.v1.Spoke

Enums

State

The State enum represents the lifecycle stage of a Network Connectivity Center resource.

Protobuf enum google.cloud.networkconnectivity.v1.State

Package com.google.cloud.networkconnectivity.v1 (0.5.0)

HubServiceClient

Classes

Interfaces

Enums