Package com.google.cloud.networkconnectivity.v1 (1.28.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:


 // 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);
 }

PolicyBasedRoutingServiceClient

Service Description: Policy-Based Routing allows GCP customers to specify flexibile routing policies for Layer 4 traffic traversing through the connected service.

Sample for PolicyBasedRoutingServiceClient:


 // 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
     PolicyBasedRoutingServiceClient.create()) {
   PolicyBasedRouteName name = PolicyBasedRouteName.of("[PROJECT]", "[POLICY_BASED_ROUTE]");
   PolicyBasedRoute response = policyBasedRoutingServiceClient.getPolicyBasedRoute(name);
 }

Classes

AcceptHubSpokeRequest

The request for HubService.AcceptHubSpoke.

Protobuf type google.cloud.networkconnectivity.v1.AcceptHubSpokeRequest

AcceptHubSpokeRequest.Builder

The request for HubService.AcceptHubSpoke.

Protobuf type google.cloud.networkconnectivity.v1.AcceptHubSpokeRequest

AcceptHubSpokeResponse

The response for HubService.AcceptHubSpoke.

Protobuf type google.cloud.networkconnectivity.v1.AcceptHubSpokeResponse

AcceptHubSpokeResponse.Builder

The response for HubService.AcceptHubSpoke.

Protobuf type google.cloud.networkconnectivity.v1.AcceptHubSpokeResponse

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

CreatePolicyBasedRouteRequest

Request for [PolicyBasedRouting.CreatePolicyBasedRoute][] method.

Protobuf type google.cloud.networkconnectivity.v1.CreatePolicyBasedRouteRequest

CreatePolicyBasedRouteRequest.Builder

Request for [PolicyBasedRouting.CreatePolicyBasedRoute][] method.

Protobuf type google.cloud.networkconnectivity.v1.CreatePolicyBasedRouteRequest

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

DeletePolicyBasedRouteRequest

Request for [PolicyBasedRouting.DeletePolicyBasedRoute][] method.

Protobuf type google.cloud.networkconnectivity.v1.DeletePolicyBasedRouteRequest

DeletePolicyBasedRouteRequest.Builder

Request for [PolicyBasedRouting.DeletePolicyBasedRoute][] method.

Protobuf type google.cloud.networkconnectivity.v1.DeletePolicyBasedRouteRequest

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

GetGroupRequest

The request for HubService.GetGroup.

Protobuf type google.cloud.networkconnectivity.v1.GetGroupRequest

GetGroupRequest.Builder

The request for HubService.GetGroup.

Protobuf type google.cloud.networkconnectivity.v1.GetGroupRequest

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

GetPolicyBasedRouteRequest

Request for [PolicyBasedRouting.GetPolicyBasedRoute][] method.

Protobuf type google.cloud.networkconnectivity.v1.GetPolicyBasedRouteRequest

GetPolicyBasedRouteRequest.Builder

Request for [PolicyBasedRouting.GetPolicyBasedRoute][] method.

Protobuf type google.cloud.networkconnectivity.v1.GetPolicyBasedRouteRequest

GetRouteRequest

The request for HubService.GetRoute.

Protobuf type google.cloud.networkconnectivity.v1.GetRouteRequest

GetRouteRequest.Builder

The request for HubService.GetRoute.

Protobuf type google.cloud.networkconnectivity.v1.GetRouteRequest

GetRouteTableRequest

The request for HubService.GetRouteTable.

Protobuf type google.cloud.networkconnectivity.v1.GetRouteTableRequest

GetRouteTableRequest.Builder

The request for HubService.GetRouteTable.

Protobuf type google.cloud.networkconnectivity.v1.GetRouteTableRequest

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

Group

A group represents a subset of spokes attached to a hub.

Protobuf type google.cloud.networkconnectivity.v1.Group

Group.Builder

A group represents a subset of spokes attached to a hub.

Protobuf type google.cloud.networkconnectivity.v1.Group

GroupName

GroupName.Builder

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

Hub

A Network Connectivity Center hub is a global management resource to which you attach spokes. A single hub can contain spokes from multiple regions. However, if any of a hub's spokes use the site-to-site data transfer feature, the resources associated with those spokes must all be in the same VPC network. Spokes that do not use site-to-site data transfer can be associated with any VPC network in your project.

Protobuf type google.cloud.networkconnectivity.v1.Hub

Hub.Builder

A Network Connectivity Center hub is a global management resource to which you attach spokes. A single hub can contain spokes from multiple regions. However, if any of a hub's spokes use the site-to-site data transfer feature, the resources associated with those spokes must all be in the same VPC network. Spokes that do not use site-to-site data transfer can be associated with any VPC network in your project.

Protobuf type google.cloud.networkconnectivity.v1.Hub

HubName

HubName.Builder

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

HubProto

HubRouteName

HubRouteName.Builder

Builder for projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}.

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.

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

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

  1. 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.
  2. 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.
  3. 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:


 // 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.

HubServiceClient.ListGroupsFixedSizeCollection

HubServiceClient.ListGroupsPage

HubServiceClient.ListGroupsPagedResponse

HubServiceClient.ListHubSpokesFixedSizeCollection

HubServiceClient.ListHubSpokesPage

HubServiceClient.ListHubSpokesPagedResponse

HubServiceClient.ListHubsFixedSizeCollection

HubServiceClient.ListHubsPage

HubServiceClient.ListHubsPagedResponse

HubServiceClient.ListLocationsFixedSizeCollection

HubServiceClient.ListLocationsPage

HubServiceClient.ListLocationsPagedResponse

HubServiceClient.ListRouteTablesFixedSizeCollection

HubServiceClient.ListRouteTablesPage

HubServiceClient.ListRouteTablesPagedResponse

HubServiceClient.ListRoutesFixedSizeCollection

HubServiceClient.ListRoutesPage

HubServiceClient.ListRoutesPagedResponse

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

A stub to allow clients to do synchronous rpc calls to service HubService.

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.HubServiceFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service HubService.

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.HubServiceImplBase

Base class for the server implementation of the service HubService.

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.HubServiceStub

A stub to allow clients to do asynchronous rpc calls to service HubService.

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.

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:


 // 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.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

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

LinkedRouterApplianceInstances

A collection of router appliance instances. If you configure multiple router appliance instances to receive data from the same set of sites outside of Google Cloud, we recommend that you associate those instances with the same spoke.

Protobuf type google.cloud.networkconnectivity.v1.LinkedRouterApplianceInstances

LinkedRouterApplianceInstances.Builder

A collection of router appliance instances. If you configure multiple router appliance instances to receive data from the same set of sites outside of Google Cloud, we recommend that you associate those instances with the same spoke.

Protobuf type google.cloud.networkconnectivity.v1.LinkedRouterApplianceInstances

LinkedVpcNetwork

An existing VPC network.

Protobuf type google.cloud.networkconnectivity.v1.LinkedVpcNetwork

LinkedVpcNetwork.Builder

An existing VPC network.

Protobuf type google.cloud.networkconnectivity.v1.LinkedVpcNetwork

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

LinkedVpnTunnels.Builder

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

ListGroupsRequest

Request for HubService.ListGroups method.

Protobuf type google.cloud.networkconnectivity.v1.ListGroupsRequest

ListGroupsRequest.Builder

Request for HubService.ListGroups method.

Protobuf type google.cloud.networkconnectivity.v1.ListGroupsRequest

ListGroupsResponse

Response for HubService.ListGroups method.

Protobuf type google.cloud.networkconnectivity.v1.ListGroupsResponse

ListGroupsResponse.Builder

Response for HubService.ListGroups method.

Protobuf type google.cloud.networkconnectivity.v1.ListGroupsResponse

ListHubSpokesRequest

The request for HubService.ListHubSpokes.

Protobuf type google.cloud.networkconnectivity.v1.ListHubSpokesRequest

ListHubSpokesRequest.Builder

The request for HubService.ListHubSpokes.

Protobuf type google.cloud.networkconnectivity.v1.ListHubSpokesRequest

ListHubSpokesResponse

The response for HubService.ListHubSpokes.

Protobuf type google.cloud.networkconnectivity.v1.ListHubSpokesResponse

ListHubSpokesResponse.Builder

The response for HubService.ListHubSpokes.

Protobuf type google.cloud.networkconnectivity.v1.ListHubSpokesResponse

ListHubsRequest

Request for HubService.ListHubs method.

Protobuf type google.cloud.networkconnectivity.v1.ListHubsRequest

ListHubsRequest.Builder

Request for HubService.ListHubs method.

Protobuf type google.cloud.networkconnectivity.v1.ListHubsRequest

ListHubsResponse

Response for HubService.ListHubs method.

Protobuf type google.cloud.networkconnectivity.v1.ListHubsResponse

ListHubsResponse.Builder

Response for HubService.ListHubs method.

Protobuf type google.cloud.networkconnectivity.v1.ListHubsResponse

ListPolicyBasedRoutesRequest

Request for [PolicyBasedRouting.ListPolicyBasedRoutes][] method.

Protobuf type google.cloud.networkconnectivity.v1.ListPolicyBasedRoutesRequest

ListPolicyBasedRoutesRequest.Builder

Request for [PolicyBasedRouting.ListPolicyBasedRoutes][] method.

Protobuf type google.cloud.networkconnectivity.v1.ListPolicyBasedRoutesRequest

ListPolicyBasedRoutesResponse

Response for [PolicyBasedRouting.ListPolicyBasedRoutes][] method.

Protobuf type google.cloud.networkconnectivity.v1.ListPolicyBasedRoutesResponse

ListPolicyBasedRoutesResponse.Builder

Response for [PolicyBasedRouting.ListPolicyBasedRoutes][] method.

Protobuf type google.cloud.networkconnectivity.v1.ListPolicyBasedRoutesResponse

ListRouteTablesRequest

Request for HubService.ListRouteTables method.

Protobuf type google.cloud.networkconnectivity.v1.ListRouteTablesRequest

ListRouteTablesRequest.Builder

Request for HubService.ListRouteTables method.

Protobuf type google.cloud.networkconnectivity.v1.ListRouteTablesRequest

ListRouteTablesResponse

Response for HubService.ListRouteTables method.

Protobuf type google.cloud.networkconnectivity.v1.ListRouteTablesResponse

ListRouteTablesResponse.Builder

Response for HubService.ListRouteTables method.

Protobuf type google.cloud.networkconnectivity.v1.ListRouteTablesResponse

ListRoutesRequest

Request for HubService.ListRoutes method.

Protobuf type google.cloud.networkconnectivity.v1.ListRoutesRequest

ListRoutesRequest.Builder

Request for HubService.ListRoutes method.

Protobuf type google.cloud.networkconnectivity.v1.ListRoutesRequest

ListRoutesResponse

Response for HubService.ListRoutes method.

Protobuf type google.cloud.networkconnectivity.v1.ListRoutesResponse

ListRoutesResponse.Builder

Response for HubService.ListRoutes method.

Protobuf type google.cloud.networkconnectivity.v1.ListRoutesResponse

ListSpokesRequest

The request for HubService.ListSpokes.

Protobuf type google.cloud.networkconnectivity.v1.ListSpokesRequest

ListSpokesRequest.Builder

The request for HubService.ListSpokes.

Protobuf type google.cloud.networkconnectivity.v1.ListSpokesRequest

ListSpokesResponse

The response for HubService.ListSpokes.

Protobuf type google.cloud.networkconnectivity.v1.ListSpokesResponse

ListSpokesResponse.Builder

The response for HubService.ListSpokes.

Protobuf type google.cloud.networkconnectivity.v1.ListSpokesResponse

LocationMetadata

Metadata about locations

Protobuf type google.cloud.networkconnectivity.v1.LocationMetadata

LocationMetadata.Builder

Metadata about locations

Protobuf type google.cloud.networkconnectivity.v1.LocationMetadata

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

NextHopVpcNetwork

Protobuf type google.cloud.networkconnectivity.v1.NextHopVpcNetwork

NextHopVpcNetwork.Builder

Protobuf type google.cloud.networkconnectivity.v1.NextHopVpcNetwork

OperationMetadata

Represents the metadata of the long-running operation.

Protobuf type google.cloud.networkconnectivity.v1.OperationMetadata

OperationMetadata.Builder

Represents the metadata of the long-running operation.

Protobuf type google.cloud.networkconnectivity.v1.OperationMetadata

PolicyBasedRoute

Policy Based Routes (PBR) are more powerful routes that allows GCP customers to route their L4 network traffic based on not just destination IP, but also source IP, protocol and more. A PBR always take precedence when it conflicts with other types of routes. Next id: 22

Protobuf type google.cloud.networkconnectivity.v1.PolicyBasedRoute

PolicyBasedRoute.Builder

Policy Based Routes (PBR) are more powerful routes that allows GCP customers to route their L4 network traffic based on not just destination IP, but also source IP, protocol and more. A PBR always take precedence when it conflicts with other types of routes. Next id: 22

Protobuf type google.cloud.networkconnectivity.v1.PolicyBasedRoute

PolicyBasedRoute.Filter

Filter matches L4 traffic.

Protobuf type google.cloud.networkconnectivity.v1.PolicyBasedRoute.Filter

PolicyBasedRoute.Filter.Builder

Filter matches L4 traffic.

Protobuf type google.cloud.networkconnectivity.v1.PolicyBasedRoute.Filter

PolicyBasedRoute.InterconnectAttachment

InterconnectAttachment to which this route applies to.

Protobuf type google.cloud.networkconnectivity.v1.PolicyBasedRoute.InterconnectAttachment

PolicyBasedRoute.InterconnectAttachment.Builder

InterconnectAttachment to which this route applies to.

Protobuf type google.cloud.networkconnectivity.v1.PolicyBasedRoute.InterconnectAttachment

PolicyBasedRoute.VirtualMachine

VM instances to which this policy based route applies to.

Protobuf type google.cloud.networkconnectivity.v1.PolicyBasedRoute.VirtualMachine

PolicyBasedRoute.VirtualMachine.Builder

VM instances to which this policy based route applies to.

Protobuf type google.cloud.networkconnectivity.v1.PolicyBasedRoute.VirtualMachine

PolicyBasedRoute.Warnings

Informational warning message.

Protobuf type google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings

PolicyBasedRoute.Warnings.Builder

Informational warning message.

Protobuf type google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings

PolicyBasedRouteName

PolicyBasedRouteName.Builder

Builder for projects/{project}/locations/global/PolicyBasedRoutes/{policy_based_route}.

PolicyBasedRoutingProto

PolicyBasedRoutingServiceClient

Service Description: Policy-Based Routing allows GCP customers to specify flexibile routing policies for Layer 4 traffic traversing through the connected service.

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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
     PolicyBasedRoutingServiceClient.create()) {
   PolicyBasedRouteName name = PolicyBasedRouteName.of("[PROJECT]", "[POLICY_BASED_ROUTE]");
   PolicyBasedRoute response = policyBasedRoutingServiceClient.getPolicyBasedRoute(name);
 }

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

  1. 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.
  2. 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.
  3. 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 PolicyBasedRoutingServiceSettings 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
 PolicyBasedRoutingServiceSettings policyBasedRoutingServiceSettings =
     PolicyBasedRoutingServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
     PolicyBasedRoutingServiceClient.create(policyBasedRoutingServiceSettings);

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
 PolicyBasedRoutingServiceSettings policyBasedRoutingServiceSettings =
     PolicyBasedRoutingServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
     PolicyBasedRoutingServiceClient.create(policyBasedRoutingServiceSettings);

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

PolicyBasedRoutingServiceClient.ListLocationsFixedSizeCollection

PolicyBasedRoutingServiceClient.ListLocationsPage

PolicyBasedRoutingServiceClient.ListLocationsPagedResponse

PolicyBasedRoutingServiceClient.ListPolicyBasedRoutesFixedSizeCollection

PolicyBasedRoutingServiceClient.ListPolicyBasedRoutesPage

PolicyBasedRoutingServiceClient.ListPolicyBasedRoutesPagedResponse

PolicyBasedRoutingServiceGrpc

Policy-Based Routing allows GCP customers to specify flexibile routing policies for Layer 4 traffic traversing through the connected service.

PolicyBasedRoutingServiceGrpc.PolicyBasedRoutingServiceBlockingStub

A stub to allow clients to do synchronous rpc calls to service PolicyBasedRoutingService.

Policy-Based Routing allows GCP customers to specify flexibile routing policies for Layer 4 traffic traversing through the connected service.

PolicyBasedRoutingServiceGrpc.PolicyBasedRoutingServiceFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service PolicyBasedRoutingService.

Policy-Based Routing allows GCP customers to specify flexibile routing policies for Layer 4 traffic traversing through the connected service.

PolicyBasedRoutingServiceGrpc.PolicyBasedRoutingServiceImplBase

Base class for the server implementation of the service PolicyBasedRoutingService.

Policy-Based Routing allows GCP customers to specify flexibile routing policies for Layer 4 traffic traversing through the connected service.

PolicyBasedRoutingServiceGrpc.PolicyBasedRoutingServiceStub

A stub to allow clients to do asynchronous rpc calls to service PolicyBasedRoutingService.

Policy-Based Routing allows GCP customers to specify flexibile routing policies for Layer 4 traffic traversing through the connected service.

PolicyBasedRoutingServiceSettings

Settings class to configure an instance of PolicyBasedRoutingServiceClient.

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 getPolicyBasedRoute to 30 seconds:


 // 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
 PolicyBasedRoutingServiceSettings.Builder policyBasedRoutingServiceSettingsBuilder =
     PolicyBasedRoutingServiceSettings.newBuilder();
 policyBasedRoutingServiceSettingsBuilder
     .getPolicyBasedRouteSettings()
     .setRetrySettings(
         policyBasedRoutingServiceSettingsBuilder
             .getPolicyBasedRouteSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 PolicyBasedRoutingServiceSettings policyBasedRoutingServiceSettings =
     policyBasedRoutingServiceSettingsBuilder.build();

PolicyBasedRoutingServiceSettings.Builder

Builder for PolicyBasedRoutingServiceSettings.

RejectHubSpokeRequest

The request for HubService.RejectHubSpoke.

Protobuf type google.cloud.networkconnectivity.v1.RejectHubSpokeRequest

RejectHubSpokeRequest.Builder

The request for HubService.RejectHubSpoke.

Protobuf type google.cloud.networkconnectivity.v1.RejectHubSpokeRequest

RejectHubSpokeResponse

The response for HubService.RejectHubSpoke.

Protobuf type google.cloud.networkconnectivity.v1.RejectHubSpokeResponse

RejectHubSpokeResponse.Builder

The response for HubService.RejectHubSpoke.

Protobuf type google.cloud.networkconnectivity.v1.RejectHubSpokeResponse

Route

A route defines a path from VM instances within a spoke to a specific destination resource. Only VPC spokes have routes.

Protobuf type google.cloud.networkconnectivity.v1.Route

Route.Builder

A route defines a path from VM instances within a spoke to a specific destination resource. Only VPC spokes have routes.

Protobuf type google.cloud.networkconnectivity.v1.Route

RouteTable

Protobuf type google.cloud.networkconnectivity.v1.RouteTable

RouteTable.Builder

Protobuf type google.cloud.networkconnectivity.v1.RouteTable

RouteTableName

RouteTableName.Builder

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

RouterApplianceInstance

A router appliance instance is a Compute Engine virtual machine (VM) instance that acts as a BGP speaker. A router appliance instance is specified by the URI of the VM and the internal IP address of one of the VM's network interfaces.

Protobuf type google.cloud.networkconnectivity.v1.RouterApplianceInstance

RouterApplianceInstance.Builder

A router appliance instance is a Compute Engine virtual machine (VM) instance that acts as a BGP speaker. A router appliance instance is specified by the URI of the VM and the internal IP address of one of the VM's network interfaces.

Protobuf type google.cloud.networkconnectivity.v1.RouterApplianceInstance

RoutingVPC

RoutingVPC contains information about the VPC networks associated with the spokes of a Network Connectivity Center hub.

Protobuf type google.cloud.networkconnectivity.v1.RoutingVPC

RoutingVPC.Builder

RoutingVPC contains information about the VPC networks associated with the spokes of a Network Connectivity Center hub.

Protobuf type google.cloud.networkconnectivity.v1.RoutingVPC

Spoke

A Network Connectivity Center spoke represents one or more network connectivity resources.

When you create a spoke, you associate it with a hub. You must also identify a value for exactly one of the following fields:

  • linked_vpn_tunnels
  • linked_interconnect_attachments
  • linked_router_appliance_instances
  • linked_vpc_network

Protobuf type google.cloud.networkconnectivity.v1.Spoke

Spoke.Builder

A Network Connectivity Center spoke represents one or more network connectivity resources.

When you create a spoke, you associate it with a hub. You must also identify a value for exactly one of the following fields:

  • linked_vpn_tunnels
  • linked_interconnect_attachments
  • linked_router_appliance_instances
  • linked_vpc_network

Protobuf type google.cloud.networkconnectivity.v1.Spoke

Spoke.StateReason

The reason a spoke is inactive.

Protobuf type google.cloud.networkconnectivity.v1.Spoke.StateReason

Spoke.StateReason.Builder

The reason a spoke is inactive.

Protobuf type google.cloud.networkconnectivity.v1.Spoke.StateReason

SpokeName

SpokeName.Builder

Builder for projects/{project}/locations/{location}/spokes/{spoke}.

SpokeSummary

Summarizes information about the spokes associated with a hub. The summary includes a count of spokes according to type and according to state. If any spokes are inactive, the summary also lists the reasons they are inactive, including a count for each reason.

Protobuf type google.cloud.networkconnectivity.v1.SpokeSummary

SpokeSummary.Builder

Summarizes information about the spokes associated with a hub. The summary includes a count of spokes according to type and according to state. If any spokes are inactive, the summary also lists the reasons they are inactive, including a count for each reason.

Protobuf type google.cloud.networkconnectivity.v1.SpokeSummary

SpokeSummary.SpokeStateCount

The number of spokes that are in a particular state and associated with a given hub.

Protobuf type google.cloud.networkconnectivity.v1.SpokeSummary.SpokeStateCount

SpokeSummary.SpokeStateCount.Builder

The number of spokes that are in a particular state and associated with a given hub.

Protobuf type google.cloud.networkconnectivity.v1.SpokeSummary.SpokeStateCount

SpokeSummary.SpokeStateReasonCount

The number of spokes in the hub that are inactive for this reason.

Protobuf type google.cloud.networkconnectivity.v1.SpokeSummary.SpokeStateReasonCount

SpokeSummary.SpokeStateReasonCount.Builder

The number of spokes in the hub that are inactive for this reason.

Protobuf type google.cloud.networkconnectivity.v1.SpokeSummary.SpokeStateReasonCount

SpokeSummary.SpokeTypeCount

The number of spokes of a given type that are associated with a specific hub. The type indicates what kind of resource is associated with the spoke.

Protobuf type google.cloud.networkconnectivity.v1.SpokeSummary.SpokeTypeCount

SpokeSummary.SpokeTypeCount.Builder

The number of spokes of a given type that are associated with a specific hub. The type indicates what kind of resource is associated with the spoke.

Protobuf type google.cloud.networkconnectivity.v1.SpokeSummary.SpokeTypeCount

UpdateHubRequest

Request for HubService.UpdateHub method.

Protobuf type google.cloud.networkconnectivity.v1.UpdateHubRequest

UpdateHubRequest.Builder

Request for HubService.UpdateHub method.

Protobuf type google.cloud.networkconnectivity.v1.UpdateHubRequest

UpdateSpokeRequest

Request for HubService.UpdateSpoke method.

Protobuf type google.cloud.networkconnectivity.v1.UpdateSpokeRequest

UpdateSpokeRequest.Builder

Request for HubService.UpdateSpoke method.

Protobuf type google.cloud.networkconnectivity.v1.UpdateSpokeRequest

Interfaces

AcceptHubSpokeRequestOrBuilder

AcceptHubSpokeResponseOrBuilder

CreateHubRequestOrBuilder

CreatePolicyBasedRouteRequestOrBuilder

CreateSpokeRequestOrBuilder

DeleteHubRequestOrBuilder

DeletePolicyBasedRouteRequestOrBuilder

DeleteSpokeRequestOrBuilder

GetGroupRequestOrBuilder

GetHubRequestOrBuilder

GetPolicyBasedRouteRequestOrBuilder

GetRouteRequestOrBuilder

GetRouteTableRequestOrBuilder

GetSpokeRequestOrBuilder

GroupOrBuilder

HubOrBuilder

HubServiceGrpc.AsyncService

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.

LinkedInterconnectAttachmentsOrBuilder

LinkedRouterApplianceInstancesOrBuilder

LinkedVpcNetworkOrBuilder

LinkedVpnTunnelsOrBuilder

ListGroupsRequestOrBuilder

ListGroupsResponseOrBuilder

ListHubSpokesRequestOrBuilder

ListHubSpokesResponseOrBuilder

ListHubsRequestOrBuilder

ListHubsResponseOrBuilder

ListPolicyBasedRoutesRequestOrBuilder

ListPolicyBasedRoutesResponseOrBuilder

ListRouteTablesRequestOrBuilder

ListRouteTablesResponseOrBuilder

ListRoutesRequestOrBuilder

ListRoutesResponseOrBuilder

ListSpokesRequestOrBuilder

ListSpokesResponseOrBuilder

LocationMetadataOrBuilder

NextHopVpcNetworkOrBuilder

OperationMetadataOrBuilder

PolicyBasedRoute.FilterOrBuilder

PolicyBasedRoute.InterconnectAttachmentOrBuilder

PolicyBasedRoute.VirtualMachineOrBuilder

PolicyBasedRoute.WarningsOrBuilder

PolicyBasedRouteOrBuilder

PolicyBasedRoutingServiceGrpc.AsyncService

Policy-Based Routing allows GCP customers to specify flexibile routing policies for Layer 4 traffic traversing through the connected service.

RejectHubSpokeRequestOrBuilder

RejectHubSpokeResponseOrBuilder

RouteOrBuilder

RouteTableOrBuilder

RouterApplianceInstanceOrBuilder

RoutingVPCOrBuilder

Spoke.StateReasonOrBuilder

SpokeOrBuilder

SpokeSummary.SpokeStateCountOrBuilder

SpokeSummary.SpokeStateReasonCountOrBuilder

SpokeSummary.SpokeTypeCountOrBuilder

SpokeSummaryOrBuilder

UpdateHubRequestOrBuilder

UpdateSpokeRequestOrBuilder

Enums

ListHubSpokesRequest.SpokeView

Enum that controls which spoke fields are included in the response.

Protobuf enum google.cloud.networkconnectivity.v1.ListHubSpokesRequest.SpokeView

LocationFeature

Supported features for a location

Protobuf enum google.cloud.networkconnectivity.v1.LocationFeature

PolicyBasedRoute.Filter.ProtocolVersion

The internet protocol version.

Protobuf enum google.cloud.networkconnectivity.v1.PolicyBasedRoute.Filter.ProtocolVersion

PolicyBasedRoute.NextHopCase

PolicyBasedRoute.OtherRoutes

The other routing cases.

Protobuf enum google.cloud.networkconnectivity.v1.PolicyBasedRoute.OtherRoutes

PolicyBasedRoute.TargetCase

PolicyBasedRoute.Warnings.Code

Warning code for Policy Based Routing. Expect to add values in the future.

Protobuf enum google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings.Code

RouteType

The route's type

Protobuf enum google.cloud.networkconnectivity.v1.RouteType

Spoke.StateReason.Code

The Code enum represents the various reasons a state can be INACTIVE.

Protobuf enum google.cloud.networkconnectivity.v1.Spoke.StateReason.Code

SpokeType

The SpokeType enum represents the type of spoke. The type reflects the kind of resource that a spoke is associated with.

Protobuf enum google.cloud.networkconnectivity.v1.SpokeType

State

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

Protobuf enum google.cloud.networkconnectivity.v1.State