com.google.cloud.compute.v1

Class NetworkClient

java.lang.Object

com.google.cloud.compute.v1.NetworkClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class NetworkClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Creates and runs virtual machines on Google Cloud Platform.

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 (NetworkClient networkClient = NetworkClient.create()) {
   ProjectGlobalNetworkName network = ProjectGlobalNetworkName.of("[PROJECT]", "[NETWORK]");
   NetworksAddPeeringRequest networksAddPeeringRequestResource = NetworksAddPeeringRequest.newBuilder().build();
   Operation response = networkClient.addPeeringNetwork(network, networksAddPeeringRequestResource);
 }
 
 

Note: close() needs to be called on the networkClient 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 NetworkSettings to create(). For example:

To customize credentials:

 
 NetworkSettings networkSettings =
     NetworkSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 NetworkClient networkClient =
     NetworkClient.create(networkSettings);
 
 

To customize the endpoint:

 
 NetworkSettings networkSettings =
     NetworkSettings.newBuilder().setEndpoint(myEndpoint).build();
 NetworkClient networkClient =
     NetworkClient.create(networkSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetworkClient.ListNetworksFixedSizeCollection
static class	NetworkClient.ListNetworksPage
static class	NetworkClient.ListNetworksPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NetworkClient(NetworkSettings settings) Constructs an instance of NetworkClient, using the given settings.
protected	NetworkClient(NetworkStub stub)

Method Summary

Modifier and Type	Method and Description
Operation	addPeeringNetwork(AddPeeringNetworkHttpRequest request) Adds a peering to the specified network.
Operation	addPeeringNetwork(ProjectGlobalNetworkName network, NetworksAddPeeringRequest networksAddPeeringRequestResource) Adds a peering to the specified network.
Operation	addPeeringNetwork(String network, NetworksAddPeeringRequest networksAddPeeringRequestResource) Adds a peering to the specified network.
com.google.api.gax.rpc.UnaryCallable<AddPeeringNetworkHttpRequest,Operation>	addPeeringNetworkCallable() Adds a peering to the specified network.
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static NetworkClient	create() Constructs an instance of NetworkClient with default settings.
static NetworkClient	create(NetworkSettings settings) Constructs an instance of NetworkClient, using the given settings.
static NetworkClient	create(NetworkStub stub) Constructs an instance of NetworkClient, using the given stub for making calls.
Operation	deleteNetwork(DeleteNetworkHttpRequest request) Deletes the specified network.
Operation	deleteNetwork(ProjectGlobalNetworkName network) Deletes the specified network.
Operation	deleteNetwork(String network) Deletes the specified network.
com.google.api.gax.rpc.UnaryCallable<DeleteNetworkHttpRequest,Operation>	deleteNetworkCallable() Deletes the specified network.
Network	getNetwork(GetNetworkHttpRequest request) Returns the specified network.
Network	getNetwork(ProjectGlobalNetworkName network) Returns the specified network.
Network	getNetwork(String network) Returns the specified network.
com.google.api.gax.rpc.UnaryCallable<GetNetworkHttpRequest,Network>	getNetworkCallable() Returns the specified network.
NetworkSettings	getSettings()
NetworkStub	getStub()
Operation	insertNetwork(InsertNetworkHttpRequest request) Creates a network in the specified project using the data included in the request.
Operation	insertNetwork(ProjectName project, Network networkResource) Creates a network in the specified project using the data included in the request.
Operation	insertNetwork(String project, Network networkResource) Creates a network in the specified project using the data included in the request.
com.google.api.gax.rpc.UnaryCallable<InsertNetworkHttpRequest,Operation>	insertNetworkCallable() Creates a network in the specified project using the data included in the request.
boolean	isShutdown()
boolean	isTerminated()
NetworkClient.ListNetworksPagedResponse	listNetworks(ListNetworksHttpRequest request) Retrieves the list of networks available to the specified project.
NetworkClient.ListNetworksPagedResponse	listNetworks(ProjectName project) Retrieves the list of networks available to the specified project.
NetworkClient.ListNetworksPagedResponse	listNetworks(String project) Retrieves the list of networks available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListNetworksHttpRequest,NetworkList>	listNetworksCallable() Retrieves the list of networks available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListNetworksHttpRequest,NetworkClient.ListNetworksPagedResponse>	listNetworksPagedCallable() Retrieves the list of networks available to the specified project.
Operation	patchNetwork(PatchNetworkHttpRequest request) Patches the specified network with the data included in the request.
Operation	patchNetwork(ProjectGlobalNetworkName network, Network networkResource, List<String> fieldMask) Patches the specified network with the data included in the request.
Operation	patchNetwork(String network, Network networkResource, List<String> fieldMask) Patches the specified network with the data included in the request.
com.google.api.gax.rpc.UnaryCallable<PatchNetworkHttpRequest,Operation>	patchNetworkCallable() Patches the specified network with the data included in the request.
Operation	removePeeringNetwork(ProjectGlobalNetworkName network, NetworksRemovePeeringRequest networksRemovePeeringRequestResource) Removes a peering from the specified network.
Operation	removePeeringNetwork(RemovePeeringNetworkHttpRequest request) Removes a peering from the specified network.
Operation	removePeeringNetwork(String network, NetworksRemovePeeringRequest networksRemovePeeringRequestResource) Removes a peering from the specified network.
com.google.api.gax.rpc.UnaryCallable<RemovePeeringNetworkHttpRequest,Operation>	removePeeringNetworkCallable() Removes a peering from the specified network.
void	shutdown()
void	shutdownNow()
Operation	switchToCustomModeNetwork(ProjectGlobalNetworkName network) Switches the network mode from auto subnet mode to custom subnet mode.
Operation	switchToCustomModeNetwork(String network) Switches the network mode from auto subnet mode to custom subnet mode.
Operation	switchToCustomModeNetwork(SwitchToCustomModeNetworkHttpRequest request) Switches the network mode from auto subnet mode to custom subnet mode.
com.google.api.gax.rpc.UnaryCallable<SwitchToCustomModeNetworkHttpRequest,Operation>	switchToCustomModeNetworkCallable() Switches the network mode from auto subnet mode to custom subnet mode.
Operation	updatePeeringNetwork(ProjectGlobalNetworkName network, NetworksUpdatePeeringRequest networksUpdatePeeringRequestResource, List<String> fieldMask) Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes
Operation	updatePeeringNetwork(String network, NetworksUpdatePeeringRequest networksUpdatePeeringRequestResource, List<String> fieldMask) Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes
Operation	updatePeeringNetwork(UpdatePeeringNetworkHttpRequest request) Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes
com.google.api.gax.rpc.UnaryCallable<UpdatePeeringNetworkHttpRequest,Operation>	updatePeeringNetworkCallable() Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NetworkClient

protected NetworkClient(NetworkSettings settings)
                 throws IOException

Constructs an instance of NetworkClient, 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.

Throws:

IOException

NetworkClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected NetworkClient(NetworkStub stub)

Method Detail

create

public static final NetworkClient create()
                                  throws IOException

Constructs an instance of NetworkClient with default settings.

Throws:

IOException

create

public static final NetworkClient create(NetworkSettings settings)
                                  throws IOException

Constructs an instance of NetworkClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final NetworkClient create(NetworkStub stub)

Constructs an instance of NetworkClient, using the given stub for making calls. This is for advanced usage - prefer to use NetworkSettings}.

getSettings

public final NetworkSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public NetworkStub getStub()

addPeeringNetwork

@BetaApi
public final Operation addPeeringNetwork(ProjectGlobalNetworkName network,
                                                  NetworksAddPeeringRequest networksAddPeeringRequestResource)

Adds a peering to the specified network.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   ProjectGlobalNetworkName network = ProjectGlobalNetworkName.of("[PROJECT]", "[NETWORK]");
   NetworksAddPeeringRequest networksAddPeeringRequestResource = NetworksAddPeeringRequest.newBuilder().build();
   Operation response = networkClient.addPeeringNetwork(network, networksAddPeeringRequestResource);
 }
 

Parameters:

network - Name of the network resource to add peering to.

networksAddPeeringRequestResource -

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

addPeeringNetwork

@BetaApi
public final Operation addPeeringNetwork(String network,
                                                  NetworksAddPeeringRequest networksAddPeeringRequestResource)

Adds a peering to the specified network.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   ProjectGlobalNetworkName network = ProjectGlobalNetworkName.of("[PROJECT]", "[NETWORK]");
   NetworksAddPeeringRequest networksAddPeeringRequestResource = NetworksAddPeeringRequest.newBuilder().build();
   Operation response = networkClient.addPeeringNetwork(network.toString(), networksAddPeeringRequestResource);
 }
 

Parameters:

network - Name of the network resource to add peering to.

networksAddPeeringRequestResource -

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

addPeeringNetwork

@BetaApi
public final Operation addPeeringNetwork(AddPeeringNetworkHttpRequest request)

Adds a peering to the specified network.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   String formattedNetwork = ProjectGlobalNetworkName.format("[PROJECT]", "[NETWORK]");
   NetworksAddPeeringRequest networksAddPeeringRequestResource = NetworksAddPeeringRequest.newBuilder().build();
   AddPeeringNetworkHttpRequest request = AddPeeringNetworkHttpRequest.newBuilder()
     .setNetwork(formattedNetwork)
     .setNetworksAddPeeringRequestResource(networksAddPeeringRequestResource)
     .build();
   Operation response = networkClient.addPeeringNetwork(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

addPeeringNetworkCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AddPeeringNetworkHttpRequest,Operation> addPeeringNetworkCallable()

Adds a peering to the specified network.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   String formattedNetwork = ProjectGlobalNetworkName.format("[PROJECT]", "[NETWORK]");
   NetworksAddPeeringRequest networksAddPeeringRequestResource = NetworksAddPeeringRequest.newBuilder().build();
   AddPeeringNetworkHttpRequest request = AddPeeringNetworkHttpRequest.newBuilder()
     .setNetwork(formattedNetwork)
     .setNetworksAddPeeringRequestResource(networksAddPeeringRequestResource)
     .build();
   ApiFuture<Operation> future = networkClient.addPeeringNetworkCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

deleteNetwork

@BetaApi
public final Operation deleteNetwork(ProjectGlobalNetworkName network)

Deletes the specified network.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   ProjectGlobalNetworkName network = ProjectGlobalNetworkName.of("[PROJECT]", "[NETWORK]");
   Operation response = networkClient.deleteNetwork(network);
 }
 

Parameters:

network - Name of the network to delete.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteNetwork

@BetaApi
public final Operation deleteNetwork(String network)

Deletes the specified network.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   ProjectGlobalNetworkName network = ProjectGlobalNetworkName.of("[PROJECT]", "[NETWORK]");
   Operation response = networkClient.deleteNetwork(network.toString());
 }
 

Parameters:

network - Name of the network to delete.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteNetwork

@BetaApi
public final Operation deleteNetwork(DeleteNetworkHttpRequest request)

Deletes the specified network.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   String formattedNetwork = ProjectGlobalNetworkName.format("[PROJECT]", "[NETWORK]");
   DeleteNetworkHttpRequest request = DeleteNetworkHttpRequest.newBuilder()
     .setNetwork(formattedNetwork)
     .build();
   Operation response = networkClient.deleteNetwork(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteNetworkCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<DeleteNetworkHttpRequest,Operation> deleteNetworkCallable()

Deletes the specified network.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   String formattedNetwork = ProjectGlobalNetworkName.format("[PROJECT]", "[NETWORK]");
   DeleteNetworkHttpRequest request = DeleteNetworkHttpRequest.newBuilder()
     .setNetwork(formattedNetwork)
     .build();
   ApiFuture<Operation> future = networkClient.deleteNetworkCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getNetwork

@BetaApi
public final Network getNetwork(ProjectGlobalNetworkName network)

Returns the specified network. Gets a list of available networks by making a list() request.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   ProjectGlobalNetworkName network = ProjectGlobalNetworkName.of("[PROJECT]", "[NETWORK]");
   Network response = networkClient.getNetwork(network);
 }
 

Parameters:

network - Name of the network to return.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getNetwork

@BetaApi
public final Network getNetwork(String network)

Returns the specified network. Gets a list of available networks by making a list() request.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   ProjectGlobalNetworkName network = ProjectGlobalNetworkName.of("[PROJECT]", "[NETWORK]");
   Network response = networkClient.getNetwork(network.toString());
 }
 

Parameters:

network - Name of the network to return.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getNetwork

@BetaApi
public final Network getNetwork(GetNetworkHttpRequest request)

Returns the specified network. Gets a list of available networks by making a list() request.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   String formattedNetwork = ProjectGlobalNetworkName.format("[PROJECT]", "[NETWORK]");
   GetNetworkHttpRequest request = GetNetworkHttpRequest.newBuilder()
     .setNetwork(formattedNetwork)
     .build();
   Network response = networkClient.getNetwork(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getNetworkCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetNetworkHttpRequest,Network> getNetworkCallable()

Returns the specified network. Gets a list of available networks by making a list() request.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   String formattedNetwork = ProjectGlobalNetworkName.format("[PROJECT]", "[NETWORK]");
   GetNetworkHttpRequest request = GetNetworkHttpRequest.newBuilder()
     .setNetwork(formattedNetwork)
     .build();
   ApiFuture<Network> future = networkClient.getNetworkCallable().futureCall(request);
   // Do something
   Network response = future.get();
 }
 

insertNetwork

@BetaApi
public final Operation insertNetwork(ProjectName project,
                                              Network networkResource)

Creates a network in the specified project using the data included in the request.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   Network networkResource = Network.newBuilder().build();
   Operation response = networkClient.insertNetwork(project, networkResource);
 }
 

Parameters:

project - Project ID for this request.

networkResource - Represents a VPC Network resource.

Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for v1.networks ==) (== resource_for beta.networks ==)

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

insertNetwork

@BetaApi
public final Operation insertNetwork(String project,
                                              Network networkResource)

Creates a network in the specified project using the data included in the request.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   Network networkResource = Network.newBuilder().build();
   Operation response = networkClient.insertNetwork(project.toString(), networkResource);
 }
 

Parameters:

project - Project ID for this request.

networkResource - Represents a VPC Network resource.

Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for v1.networks ==) (== resource_for beta.networks ==)

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

insertNetwork

@BetaApi
public final Operation insertNetwork(InsertNetworkHttpRequest request)

Creates a network in the specified project using the data included in the request.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   Network networkResource = Network.newBuilder().build();
   InsertNetworkHttpRequest request = InsertNetworkHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setNetworkResource(networkResource)
     .build();
   Operation response = networkClient.insertNetwork(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

insertNetworkCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<InsertNetworkHttpRequest,Operation> insertNetworkCallable()

Creates a network in the specified project using the data included in the request.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   Network networkResource = Network.newBuilder().build();
   InsertNetworkHttpRequest request = InsertNetworkHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setNetworkResource(networkResource)
     .build();
   ApiFuture<Operation> future = networkClient.insertNetworkCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listNetworks

@BetaApi
public final NetworkClient.ListNetworksPagedResponse listNetworks(ProjectName project)

Retrieves the list of networks available to the specified project.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (Network element : networkClient.listNetworks(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listNetworks

@BetaApi
public final NetworkClient.ListNetworksPagedResponse listNetworks(String project)

Retrieves the list of networks available to the specified project.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (Network element : networkClient.listNetworks(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listNetworks

@BetaApi
public final NetworkClient.ListNetworksPagedResponse listNetworks(ListNetworksHttpRequest request)

Retrieves the list of networks available to the specified project.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListNetworksHttpRequest request = ListNetworksHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (Network element : networkClient.listNetworks(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listNetworksPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListNetworksHttpRequest,NetworkClient.ListNetworksPagedResponse> listNetworksPagedCallable()

Retrieves the list of networks available to the specified project.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListNetworksHttpRequest request = ListNetworksHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<ListNetworksPagedResponse> future = networkClient.listNetworksPagedCallable().futureCall(request);
   // Do something
   for (Network element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listNetworksCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListNetworksHttpRequest,NetworkList> listNetworksCallable()

Retrieves the list of networks available to the specified project.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListNetworksHttpRequest request = ListNetworksHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     NetworkList response = networkClient.listNetworksCallable().call(request);
     for (Network element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

patchNetwork

@BetaApi
public final Operation patchNetwork(ProjectGlobalNetworkName network,
                                             Network networkResource,
                                             List<String> fieldMask)

Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   ProjectGlobalNetworkName network = ProjectGlobalNetworkName.of("[PROJECT]", "[NETWORK]");
   Network networkResource = Network.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = networkClient.patchNetwork(network, networkResource, fieldMask);
 }
 

Parameters:

network - Name of the network to update.

networkResource - Represents a VPC Network resource.

Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for v1.networks ==) (== resource_for beta.networks ==)

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

patchNetwork

@BetaApi
public final Operation patchNetwork(String network,
                                             Network networkResource,
                                             List<String> fieldMask)

Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   ProjectGlobalNetworkName network = ProjectGlobalNetworkName.of("[PROJECT]", "[NETWORK]");
   Network networkResource = Network.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = networkClient.patchNetwork(network.toString(), networkResource, fieldMask);
 }
 

Parameters:

network - Name of the network to update.

networkResource - Represents a VPC Network resource.

Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for v1.networks ==) (== resource_for beta.networks ==)

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

patchNetwork

@BetaApi
public final Operation patchNetwork(PatchNetworkHttpRequest request)

Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   String formattedNetwork = ProjectGlobalNetworkName.format("[PROJECT]", "[NETWORK]");
   Network networkResource = Network.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchNetworkHttpRequest request = PatchNetworkHttpRequest.newBuilder()
     .setNetwork(formattedNetwork)
     .setNetworkResource(networkResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = networkClient.patchNetwork(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

patchNetworkCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<PatchNetworkHttpRequest,Operation> patchNetworkCallable()

Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   String formattedNetwork = ProjectGlobalNetworkName.format("[PROJECT]", "[NETWORK]");
   Network networkResource = Network.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchNetworkHttpRequest request = PatchNetworkHttpRequest.newBuilder()
     .setNetwork(formattedNetwork)
     .setNetworkResource(networkResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = networkClient.patchNetworkCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

removePeeringNetwork

@BetaApi
public final Operation removePeeringNetwork(ProjectGlobalNetworkName network,
                                                     NetworksRemovePeeringRequest networksRemovePeeringRequestResource)

Removes a peering from the specified network.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   ProjectGlobalNetworkName network = ProjectGlobalNetworkName.of("[PROJECT]", "[NETWORK]");
   NetworksRemovePeeringRequest networksRemovePeeringRequestResource = NetworksRemovePeeringRequest.newBuilder().build();
   Operation response = networkClient.removePeeringNetwork(network, networksRemovePeeringRequestResource);
 }
 

Parameters:

network - Name of the network resource to remove peering from.

networksRemovePeeringRequestResource -

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

removePeeringNetwork

@BetaApi
public final Operation removePeeringNetwork(String network,
                                                     NetworksRemovePeeringRequest networksRemovePeeringRequestResource)

Removes a peering from the specified network.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   ProjectGlobalNetworkName network = ProjectGlobalNetworkName.of("[PROJECT]", "[NETWORK]");
   NetworksRemovePeeringRequest networksRemovePeeringRequestResource = NetworksRemovePeeringRequest.newBuilder().build();
   Operation response = networkClient.removePeeringNetwork(network.toString(), networksRemovePeeringRequestResource);
 }
 

Parameters:

network - Name of the network resource to remove peering from.

networksRemovePeeringRequestResource -

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

removePeeringNetwork

@BetaApi
public final Operation removePeeringNetwork(RemovePeeringNetworkHttpRequest request)

Removes a peering from the specified network.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   String formattedNetwork = ProjectGlobalNetworkName.format("[PROJECT]", "[NETWORK]");
   NetworksRemovePeeringRequest networksRemovePeeringRequestResource = NetworksRemovePeeringRequest.newBuilder().build();
   RemovePeeringNetworkHttpRequest request = RemovePeeringNetworkHttpRequest.newBuilder()
     .setNetwork(formattedNetwork)
     .setNetworksRemovePeeringRequestResource(networksRemovePeeringRequestResource)
     .build();
   Operation response = networkClient.removePeeringNetwork(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

removePeeringNetworkCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<RemovePeeringNetworkHttpRequest,Operation> removePeeringNetworkCallable()

Removes a peering from the specified network.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   String formattedNetwork = ProjectGlobalNetworkName.format("[PROJECT]", "[NETWORK]");
   NetworksRemovePeeringRequest networksRemovePeeringRequestResource = NetworksRemovePeeringRequest.newBuilder().build();
   RemovePeeringNetworkHttpRequest request = RemovePeeringNetworkHttpRequest.newBuilder()
     .setNetwork(formattedNetwork)
     .setNetworksRemovePeeringRequestResource(networksRemovePeeringRequestResource)
     .build();
   ApiFuture<Operation> future = networkClient.removePeeringNetworkCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

switchToCustomModeNetwork

@BetaApi
public final Operation switchToCustomModeNetwork(ProjectGlobalNetworkName network)

Switches the network mode from auto subnet mode to custom subnet mode.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   ProjectGlobalNetworkName network = ProjectGlobalNetworkName.of("[PROJECT]", "[NETWORK]");
   Operation response = networkClient.switchToCustomModeNetwork(network);
 }
 

Parameters:

network - Name of the network to be updated.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

switchToCustomModeNetwork

@BetaApi
public final Operation switchToCustomModeNetwork(String network)

Switches the network mode from auto subnet mode to custom subnet mode.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   ProjectGlobalNetworkName network = ProjectGlobalNetworkName.of("[PROJECT]", "[NETWORK]");
   Operation response = networkClient.switchToCustomModeNetwork(network.toString());
 }
 

Parameters:

network - Name of the network to be updated.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

switchToCustomModeNetwork

@BetaApi
public final Operation switchToCustomModeNetwork(SwitchToCustomModeNetworkHttpRequest request)

Switches the network mode from auto subnet mode to custom subnet mode.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   String formattedNetwork = ProjectGlobalNetworkName.format("[PROJECT]", "[NETWORK]");
   SwitchToCustomModeNetworkHttpRequest request = SwitchToCustomModeNetworkHttpRequest.newBuilder()
     .setNetwork(formattedNetwork)
     .build();
   Operation response = networkClient.switchToCustomModeNetwork(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

switchToCustomModeNetworkCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<SwitchToCustomModeNetworkHttpRequest,Operation> switchToCustomModeNetworkCallable()

Switches the network mode from auto subnet mode to custom subnet mode.

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   String formattedNetwork = ProjectGlobalNetworkName.format("[PROJECT]", "[NETWORK]");
   SwitchToCustomModeNetworkHttpRequest request = SwitchToCustomModeNetworkHttpRequest.newBuilder()
     .setNetwork(formattedNetwork)
     .build();
   ApiFuture<Operation> future = networkClient.switchToCustomModeNetworkCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

updatePeeringNetwork

@BetaApi
public final Operation updatePeeringNetwork(ProjectGlobalNetworkName network,
                                                     NetworksUpdatePeeringRequest networksUpdatePeeringRequestResource,
                                                     List<String> fieldMask)

Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   ProjectGlobalNetworkName network = ProjectGlobalNetworkName.of("[PROJECT]", "[NETWORK]");
   NetworksUpdatePeeringRequest networksUpdatePeeringRequestResource = NetworksUpdatePeeringRequest.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = networkClient.updatePeeringNetwork(network, networksUpdatePeeringRequestResource, fieldMask);
 }
 

Parameters:

network - Name of the network resource which the updated peering is belonging to.

networksUpdatePeeringRequestResource -

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updatePeeringNetwork

@BetaApi
public final Operation updatePeeringNetwork(String network,
                                                     NetworksUpdatePeeringRequest networksUpdatePeeringRequestResource,
                                                     List<String> fieldMask)

Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   ProjectGlobalNetworkName network = ProjectGlobalNetworkName.of("[PROJECT]", "[NETWORK]");
   NetworksUpdatePeeringRequest networksUpdatePeeringRequestResource = NetworksUpdatePeeringRequest.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = networkClient.updatePeeringNetwork(network.toString(), networksUpdatePeeringRequestResource, fieldMask);
 }
 

Parameters:

network - Name of the network resource which the updated peering is belonging to.

networksUpdatePeeringRequestResource -

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updatePeeringNetwork

@BetaApi
public final Operation updatePeeringNetwork(UpdatePeeringNetworkHttpRequest request)

Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   String formattedNetwork = ProjectGlobalNetworkName.format("[PROJECT]", "[NETWORK]");
   NetworksUpdatePeeringRequest networksUpdatePeeringRequestResource = NetworksUpdatePeeringRequest.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdatePeeringNetworkHttpRequest request = UpdatePeeringNetworkHttpRequest.newBuilder()
     .setNetwork(formattedNetwork)
     .setNetworksUpdatePeeringRequestResource(networksUpdatePeeringRequestResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = networkClient.updatePeeringNetwork(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updatePeeringNetworkCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<UpdatePeeringNetworkHttpRequest,Operation> updatePeeringNetworkCallable()

Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes

Sample code:

 try (NetworkClient networkClient = NetworkClient.create()) {
   String formattedNetwork = ProjectGlobalNetworkName.format("[PROJECT]", "[NETWORK]");
   NetworksUpdatePeeringRequest networksUpdatePeeringRequestResource = NetworksUpdatePeeringRequest.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdatePeeringNetworkHttpRequest request = UpdatePeeringNetworkHttpRequest.newBuilder()
     .setNetwork(formattedNetwork)
     .setNetworksUpdatePeeringRequestResource(networksUpdatePeeringRequestResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = networkClient.updatePeeringNetworkCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException