com.google.cloud.compute.v1

Class SubnetworkClient

java.lang.Object

com.google.cloud.compute.v1.SubnetworkClient

All Implemented Interfaces:

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

@Generated(value="by gapic-generator")
 @BetaApi
public class SubnetworkClient
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 (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectRegionSubnetworkName subnetwork = ProjectRegionSubnetworkName.of("[PROJECT]", "[REGION]", "[SUBNETWORK]");
   Operation response = subnetworkClient.deleteSubnetwork(subnetwork);
 }
 
 

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

To customize credentials:

 
 SubnetworkSettings subnetworkSettings =
     SubnetworkSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SubnetworkClient subnetworkClient =
     SubnetworkClient.create(subnetworkSettings);
 
 

To customize the endpoint:

 
 SubnetworkSettings subnetworkSettings =
     SubnetworkSettings.newBuilder().setEndpoint(myEndpoint).build();
 SubnetworkClient subnetworkClient =
     SubnetworkClient.create(subnetworkSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubnetworkClient.AggregatedListSubnetworksFixedSizeCollection
static class	SubnetworkClient.AggregatedListSubnetworksPage
static class	SubnetworkClient.AggregatedListSubnetworksPagedResponse
static class	SubnetworkClient.ListSubnetworksFixedSizeCollection
static class	SubnetworkClient.ListSubnetworksPage
static class	SubnetworkClient.ListSubnetworksPagedResponse
static class	SubnetworkClient.ListUsableSubnetworksFixedSizeCollection
static class	SubnetworkClient.ListUsableSubnetworksPage
static class	SubnetworkClient.ListUsableSubnetworksPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SubnetworkClient(SubnetworkSettings settings) Constructs an instance of SubnetworkClient, using the given settings.
protected	SubnetworkClient(SubnetworkStub stub)

Method Summary

Modifier and Type	Method and Description
SubnetworkClient.AggregatedListSubnetworksPagedResponse	aggregatedListSubnetworks(AggregatedListSubnetworksHttpRequest request) Retrieves an aggregated list of subnetworks.
SubnetworkClient.AggregatedListSubnetworksPagedResponse	aggregatedListSubnetworks(ProjectName project) Retrieves an aggregated list of subnetworks.
SubnetworkClient.AggregatedListSubnetworksPagedResponse	aggregatedListSubnetworks(String project) Retrieves an aggregated list of subnetworks.
com.google.api.gax.rpc.UnaryCallable<AggregatedListSubnetworksHttpRequest,SubnetworkAggregatedList>	aggregatedListSubnetworksCallable() Retrieves an aggregated list of subnetworks.
com.google.api.gax.rpc.UnaryCallable<AggregatedListSubnetworksHttpRequest,SubnetworkClient.AggregatedListSubnetworksPagedResponse>	aggregatedListSubnetworksPagedCallable() Retrieves an aggregated list of subnetworks.
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static SubnetworkClient	create() Constructs an instance of SubnetworkClient with default settings.
static SubnetworkClient	create(SubnetworkSettings settings) Constructs an instance of SubnetworkClient, using the given settings.
static SubnetworkClient	create(SubnetworkStub stub) Constructs an instance of SubnetworkClient, using the given stub for making calls.
Operation	deleteSubnetwork(DeleteSubnetworkHttpRequest request) Deletes the specified subnetwork.
Operation	deleteSubnetwork(ProjectRegionSubnetworkName subnetwork) Deletes the specified subnetwork.
Operation	deleteSubnetwork(String subnetwork) Deletes the specified subnetwork.
com.google.api.gax.rpc.UnaryCallable<DeleteSubnetworkHttpRequest,Operation>	deleteSubnetworkCallable() Deletes the specified subnetwork.
Operation	expandIpCidrRangeSubnetwork(ExpandIpCidrRangeSubnetworkHttpRequest request) Expands the IP CIDR range of the subnetwork to a specified value.
Operation	expandIpCidrRangeSubnetwork(ProjectRegionSubnetworkName subnetwork, SubnetworksExpandIpCidrRangeRequest subnetworksExpandIpCidrRangeRequestResource) Expands the IP CIDR range of the subnetwork to a specified value.
Operation	expandIpCidrRangeSubnetwork(String subnetwork, SubnetworksExpandIpCidrRangeRequest subnetworksExpandIpCidrRangeRequestResource) Expands the IP CIDR range of the subnetwork to a specified value.
com.google.api.gax.rpc.UnaryCallable<ExpandIpCidrRangeSubnetworkHttpRequest,Operation>	expandIpCidrRangeSubnetworkCallable() Expands the IP CIDR range of the subnetwork to a specified value.
Policy	getIamPolicySubnetwork(GetIamPolicySubnetworkHttpRequest request) Gets the access control policy for a resource.
Policy	getIamPolicySubnetwork(ProjectRegionSubnetworkResourceName resource) Gets the access control policy for a resource.
Policy	getIamPolicySubnetwork(String resource) Gets the access control policy for a resource.
com.google.api.gax.rpc.UnaryCallable<GetIamPolicySubnetworkHttpRequest,Policy>	getIamPolicySubnetworkCallable() Gets the access control policy for a resource.
SubnetworkSettings	getSettings()
SubnetworkStub	getStub()
Subnetwork	getSubnetwork(GetSubnetworkHttpRequest request) Returns the specified subnetwork.
Subnetwork	getSubnetwork(ProjectRegionSubnetworkName subnetwork) Returns the specified subnetwork.
Subnetwork	getSubnetwork(String subnetwork) Returns the specified subnetwork.
com.google.api.gax.rpc.UnaryCallable<GetSubnetworkHttpRequest,Subnetwork>	getSubnetworkCallable() Returns the specified subnetwork.
Operation	insertSubnetwork(InsertSubnetworkHttpRequest request) Creates a subnetwork in the specified project using the data included in the request.
Operation	insertSubnetwork(ProjectRegionName region, Subnetwork subnetworkResource) Creates a subnetwork in the specified project using the data included in the request.
Operation	insertSubnetwork(String region, Subnetwork subnetworkResource) Creates a subnetwork in the specified project using the data included in the request.
com.google.api.gax.rpc.UnaryCallable<InsertSubnetworkHttpRequest,Operation>	insertSubnetworkCallable() Creates a subnetwork in the specified project using the data included in the request.
boolean	isShutdown()
boolean	isTerminated()
SubnetworkClient.ListSubnetworksPagedResponse	listSubnetworks(ListSubnetworksHttpRequest request) Retrieves a list of subnetworks available to the specified project.
SubnetworkClient.ListSubnetworksPagedResponse	listSubnetworks(ProjectRegionName region) Retrieves a list of subnetworks available to the specified project.
SubnetworkClient.ListSubnetworksPagedResponse	listSubnetworks(String region) Retrieves a list of subnetworks available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListSubnetworksHttpRequest,SubnetworkList>	listSubnetworksCallable() Retrieves a list of subnetworks available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListSubnetworksHttpRequest,SubnetworkClient.ListSubnetworksPagedResponse>	listSubnetworksPagedCallable() Retrieves a list of subnetworks available to the specified project.
SubnetworkClient.ListUsableSubnetworksPagedResponse	listUsableSubnetworks(ListUsableSubnetworksHttpRequest request) Retrieves an aggregated list of all usable subnetworks in the project.
SubnetworkClient.ListUsableSubnetworksPagedResponse	listUsableSubnetworks(ProjectName project) Retrieves an aggregated list of all usable subnetworks in the project.
SubnetworkClient.ListUsableSubnetworksPagedResponse	listUsableSubnetworks(String project) Retrieves an aggregated list of all usable subnetworks in the project.
com.google.api.gax.rpc.UnaryCallable<ListUsableSubnetworksHttpRequest,UsableSubnetworksAggregatedList>	listUsableSubnetworksCallable() Retrieves an aggregated list of all usable subnetworks in the project.
com.google.api.gax.rpc.UnaryCallable<ListUsableSubnetworksHttpRequest,SubnetworkClient.ListUsableSubnetworksPagedResponse>	listUsableSubnetworksPagedCallable() Retrieves an aggregated list of all usable subnetworks in the project.
Operation	patchSubnetwork(PatchSubnetworkHttpRequest request) Patches the specified subnetwork with the data included in the request.
Operation	patchSubnetwork(ProjectRegionSubnetworkName subnetwork, Subnetwork subnetworkResource, List<String> fieldMask) Patches the specified subnetwork with the data included in the request.
Operation	patchSubnetwork(String subnetwork, Subnetwork subnetworkResource, List<String> fieldMask) Patches the specified subnetwork with the data included in the request.
com.google.api.gax.rpc.UnaryCallable<PatchSubnetworkHttpRequest,Operation>	patchSubnetworkCallable() Patches the specified subnetwork with the data included in the request.
Policy	setIamPolicySubnetwork(ProjectRegionSubnetworkResourceName resource, RegionSetPolicyRequest regionSetPolicyRequestResource) Sets the access control policy on the specified resource.
Policy	setIamPolicySubnetwork(SetIamPolicySubnetworkHttpRequest request) Sets the access control policy on the specified resource.
Policy	setIamPolicySubnetwork(String resource, RegionSetPolicyRequest regionSetPolicyRequestResource) Sets the access control policy on the specified resource.
com.google.api.gax.rpc.UnaryCallable<SetIamPolicySubnetworkHttpRequest,Policy>	setIamPolicySubnetworkCallable() Sets the access control policy on the specified resource.
Operation	setPrivateIpGoogleAccessSubnetwork(ProjectRegionSubnetworkName subnetwork, SubnetworksSetPrivateIpGoogleAccessRequest subnetworksSetPrivateIpGoogleAccessRequestResource) Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.
Operation	setPrivateIpGoogleAccessSubnetwork(SetPrivateIpGoogleAccessSubnetworkHttpRequest request) Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.
Operation	setPrivateIpGoogleAccessSubnetwork(String subnetwork, SubnetworksSetPrivateIpGoogleAccessRequest subnetworksSetPrivateIpGoogleAccessRequestResource) Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.
com.google.api.gax.rpc.UnaryCallable<SetPrivateIpGoogleAccessSubnetworkHttpRequest,Operation>	setPrivateIpGoogleAccessSubnetworkCallable() Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.
void	shutdown()
void	shutdownNow()
TestPermissionsResponse	testIamPermissionsSubnetwork(ProjectRegionSubnetworkResourceName resource, TestPermissionsRequest testPermissionsRequestResource) Returns permissions that a caller has on the specified resource.
TestPermissionsResponse	testIamPermissionsSubnetwork(String resource, TestPermissionsRequest testPermissionsRequestResource) Returns permissions that a caller has on the specified resource.
TestPermissionsResponse	testIamPermissionsSubnetwork(TestIamPermissionsSubnetworkHttpRequest request) Returns permissions that a caller has on the specified resource.
com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsSubnetworkHttpRequest,TestPermissionsResponse>	testIamPermissionsSubnetworkCallable() Returns permissions that a caller has on the specified resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubnetworkClient

protected SubnetworkClient(SubnetworkSettings settings)
                    throws IOException

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

SubnetworkClient

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

Method Detail

create

public static final SubnetworkClient create()
                                     throws IOException

Constructs an instance of SubnetworkClient with default settings.

Throws:

IOException

create

public static final SubnetworkClient create(SubnetworkSettings settings)
                                     throws IOException

Constructs an instance of SubnetworkClient, 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 SubnetworkClient create(SubnetworkStub stub)

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

getSettings

public final SubnetworkSettings getSettings()

getStub

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

aggregatedListSubnetworks

@BetaApi
public final SubnetworkClient.AggregatedListSubnetworksPagedResponse aggregatedListSubnetworks(ProjectName project)

Retrieves an aggregated list of subnetworks.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (SubnetworksScopedList element : subnetworkClient.aggregatedListSubnetworks(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

aggregatedListSubnetworks

@BetaApi
public final SubnetworkClient.AggregatedListSubnetworksPagedResponse aggregatedListSubnetworks(String project)

Retrieves an aggregated list of subnetworks.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (SubnetworksScopedList element : subnetworkClient.aggregatedListSubnetworks(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

aggregatedListSubnetworks

@BetaApi
public final SubnetworkClient.AggregatedListSubnetworksPagedResponse aggregatedListSubnetworks(AggregatedListSubnetworksHttpRequest request)

Retrieves an aggregated list of subnetworks.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListSubnetworksHttpRequest request = AggregatedListSubnetworksHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (SubnetworksScopedList element : subnetworkClient.aggregatedListSubnetworks(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

aggregatedListSubnetworksPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListSubnetworksHttpRequest,SubnetworkClient.AggregatedListSubnetworksPagedResponse> aggregatedListSubnetworksPagedCallable()

Retrieves an aggregated list of subnetworks.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListSubnetworksHttpRequest request = AggregatedListSubnetworksHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<AggregatedListSubnetworksPagedResponse> future = subnetworkClient.aggregatedListSubnetworksPagedCallable().futureCall(request);
   // Do something
   for (SubnetworksScopedList element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

aggregatedListSubnetworksCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListSubnetworksHttpRequest,SubnetworkAggregatedList> aggregatedListSubnetworksCallable()

Retrieves an aggregated list of subnetworks.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListSubnetworksHttpRequest request = AggregatedListSubnetworksHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     SubnetworkAggregatedList response = subnetworkClient.aggregatedListSubnetworksCallable().call(request);
     for (SubnetworksScopedList element : response.getItemsMap()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

deleteSubnetwork

@BetaApi
public final Operation deleteSubnetwork(ProjectRegionSubnetworkName subnetwork)

Deletes the specified subnetwork.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectRegionSubnetworkName subnetwork = ProjectRegionSubnetworkName.of("[PROJECT]", "[REGION]", "[SUBNETWORK]");
   Operation response = subnetworkClient.deleteSubnetwork(subnetwork);
 }
 

Parameters:

subnetwork - Name of the Subnetwork resource to delete.

Throws:

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

deleteSubnetwork

@BetaApi
public final Operation deleteSubnetwork(String subnetwork)

Deletes the specified subnetwork.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectRegionSubnetworkName subnetwork = ProjectRegionSubnetworkName.of("[PROJECT]", "[REGION]", "[SUBNETWORK]");
   Operation response = subnetworkClient.deleteSubnetwork(subnetwork.toString());
 }
 

Parameters:

subnetwork - Name of the Subnetwork resource to delete.

Throws:

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

deleteSubnetwork

@BetaApi
public final Operation deleteSubnetwork(DeleteSubnetworkHttpRequest request)

Deletes the specified subnetwork.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedSubnetwork = ProjectRegionSubnetworkName.format("[PROJECT]", "[REGION]", "[SUBNETWORK]");
   DeleteSubnetworkHttpRequest request = DeleteSubnetworkHttpRequest.newBuilder()
     .setSubnetwork(formattedSubnetwork)
     .build();
   Operation response = subnetworkClient.deleteSubnetwork(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

deleteSubnetworkCallable

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

Deletes the specified subnetwork.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedSubnetwork = ProjectRegionSubnetworkName.format("[PROJECT]", "[REGION]", "[SUBNETWORK]");
   DeleteSubnetworkHttpRequest request = DeleteSubnetworkHttpRequest.newBuilder()
     .setSubnetwork(formattedSubnetwork)
     .build();
   ApiFuture<Operation> future = subnetworkClient.deleteSubnetworkCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

expandIpCidrRangeSubnetwork

@BetaApi
public final Operation expandIpCidrRangeSubnetwork(ProjectRegionSubnetworkName subnetwork,
                                                            SubnetworksExpandIpCidrRangeRequest subnetworksExpandIpCidrRangeRequestResource)

Expands the IP CIDR range of the subnetwork to a specified value.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectRegionSubnetworkName subnetwork = ProjectRegionSubnetworkName.of("[PROJECT]", "[REGION]", "[SUBNETWORK]");
   SubnetworksExpandIpCidrRangeRequest subnetworksExpandIpCidrRangeRequestResource = SubnetworksExpandIpCidrRangeRequest.newBuilder().build();
   Operation response = subnetworkClient.expandIpCidrRangeSubnetwork(subnetwork, subnetworksExpandIpCidrRangeRequestResource);
 }
 

Parameters:

subnetwork - Name of the Subnetwork resource to update.

subnetworksExpandIpCidrRangeRequestResource -

Throws:

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

expandIpCidrRangeSubnetwork

@BetaApi
public final Operation expandIpCidrRangeSubnetwork(String subnetwork,
                                                            SubnetworksExpandIpCidrRangeRequest subnetworksExpandIpCidrRangeRequestResource)

Expands the IP CIDR range of the subnetwork to a specified value.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectRegionSubnetworkName subnetwork = ProjectRegionSubnetworkName.of("[PROJECT]", "[REGION]", "[SUBNETWORK]");
   SubnetworksExpandIpCidrRangeRequest subnetworksExpandIpCidrRangeRequestResource = SubnetworksExpandIpCidrRangeRequest.newBuilder().build();
   Operation response = subnetworkClient.expandIpCidrRangeSubnetwork(subnetwork.toString(), subnetworksExpandIpCidrRangeRequestResource);
 }
 

Parameters:

subnetwork - Name of the Subnetwork resource to update.

subnetworksExpandIpCidrRangeRequestResource -

Throws:

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

expandIpCidrRangeSubnetwork

@BetaApi
public final Operation expandIpCidrRangeSubnetwork(ExpandIpCidrRangeSubnetworkHttpRequest request)

Expands the IP CIDR range of the subnetwork to a specified value.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedSubnetwork = ProjectRegionSubnetworkName.format("[PROJECT]", "[REGION]", "[SUBNETWORK]");
   SubnetworksExpandIpCidrRangeRequest subnetworksExpandIpCidrRangeRequestResource = SubnetworksExpandIpCidrRangeRequest.newBuilder().build();
   ExpandIpCidrRangeSubnetworkHttpRequest request = ExpandIpCidrRangeSubnetworkHttpRequest.newBuilder()
     .setSubnetwork(formattedSubnetwork)
     .setSubnetworksExpandIpCidrRangeRequestResource(subnetworksExpandIpCidrRangeRequestResource)
     .build();
   Operation response = subnetworkClient.expandIpCidrRangeSubnetwork(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

expandIpCidrRangeSubnetworkCallable

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

Expands the IP CIDR range of the subnetwork to a specified value.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedSubnetwork = ProjectRegionSubnetworkName.format("[PROJECT]", "[REGION]", "[SUBNETWORK]");
   SubnetworksExpandIpCidrRangeRequest subnetworksExpandIpCidrRangeRequestResource = SubnetworksExpandIpCidrRangeRequest.newBuilder().build();
   ExpandIpCidrRangeSubnetworkHttpRequest request = ExpandIpCidrRangeSubnetworkHttpRequest.newBuilder()
     .setSubnetwork(formattedSubnetwork)
     .setSubnetworksExpandIpCidrRangeRequestResource(subnetworksExpandIpCidrRangeRequestResource)
     .build();
   ApiFuture<Operation> future = subnetworkClient.expandIpCidrRangeSubnetworkCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getSubnetwork

@BetaApi
public final Subnetwork getSubnetwork(ProjectRegionSubnetworkName subnetwork)

Returns the specified subnetwork. Gets a list of available subnetworks list() request.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectRegionSubnetworkName subnetwork = ProjectRegionSubnetworkName.of("[PROJECT]", "[REGION]", "[SUBNETWORK]");
   Subnetwork response = subnetworkClient.getSubnetwork(subnetwork);
 }
 

Parameters:

subnetwork - Name of the Subnetwork resource to return.

Throws:

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

getSubnetwork

@BetaApi
public final Subnetwork getSubnetwork(String subnetwork)

Returns the specified subnetwork. Gets a list of available subnetworks list() request.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectRegionSubnetworkName subnetwork = ProjectRegionSubnetworkName.of("[PROJECT]", "[REGION]", "[SUBNETWORK]");
   Subnetwork response = subnetworkClient.getSubnetwork(subnetwork.toString());
 }
 

Parameters:

subnetwork - Name of the Subnetwork resource to return.

Throws:

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

getSubnetwork

@BetaApi
public final Subnetwork getSubnetwork(GetSubnetworkHttpRequest request)

Returns the specified subnetwork. Gets a list of available subnetworks list() request.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedSubnetwork = ProjectRegionSubnetworkName.format("[PROJECT]", "[REGION]", "[SUBNETWORK]");
   GetSubnetworkHttpRequest request = GetSubnetworkHttpRequest.newBuilder()
     .setSubnetwork(formattedSubnetwork)
     .build();
   Subnetwork response = subnetworkClient.getSubnetwork(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

getSubnetworkCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetSubnetworkHttpRequest,Subnetwork> getSubnetworkCallable()

Returns the specified subnetwork. Gets a list of available subnetworks list() request.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedSubnetwork = ProjectRegionSubnetworkName.format("[PROJECT]", "[REGION]", "[SUBNETWORK]");
   GetSubnetworkHttpRequest request = GetSubnetworkHttpRequest.newBuilder()
     .setSubnetwork(formattedSubnetwork)
     .build();
   ApiFuture<Subnetwork> future = subnetworkClient.getSubnetworkCallable().futureCall(request);
   // Do something
   Subnetwork response = future.get();
 }
 

getIamPolicySubnetwork

@BetaApi
public final Policy getIamPolicySubnetwork(ProjectRegionSubnetworkResourceName resource)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectRegionSubnetworkResourceName resource = ProjectRegionSubnetworkResourceName.of("[PROJECT]", "[REGION]", "[RESOURCE]");
   Policy response = subnetworkClient.getIamPolicySubnetwork(resource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

Throws:

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

getIamPolicySubnetwork

@BetaApi
public final Policy getIamPolicySubnetwork(String resource)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectRegionSubnetworkResourceName resource = ProjectRegionSubnetworkResourceName.of("[PROJECT]", "[REGION]", "[RESOURCE]");
   Policy response = subnetworkClient.getIamPolicySubnetwork(resource.toString());
 }
 

Parameters:

resource - Name or id of the resource for this request.

Throws:

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

getIamPolicySubnetwork

@BetaApi
public final Policy getIamPolicySubnetwork(GetIamPolicySubnetworkHttpRequest request)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedResource = ProjectRegionSubnetworkResourceName.format("[PROJECT]", "[REGION]", "[RESOURCE]");
   GetIamPolicySubnetworkHttpRequest request = GetIamPolicySubnetworkHttpRequest.newBuilder()
     .setResource(formattedResource)
     .build();
   Policy response = subnetworkClient.getIamPolicySubnetwork(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

getIamPolicySubnetworkCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetIamPolicySubnetworkHttpRequest,Policy> getIamPolicySubnetworkCallable()

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedResource = ProjectRegionSubnetworkResourceName.format("[PROJECT]", "[REGION]", "[RESOURCE]");
   GetIamPolicySubnetworkHttpRequest request = GetIamPolicySubnetworkHttpRequest.newBuilder()
     .setResource(formattedResource)
     .build();
   ApiFuture<Policy> future = subnetworkClient.getIamPolicySubnetworkCallable().futureCall(request);
   // Do something
   Policy response = future.get();
 }
 

insertSubnetwork

@BetaApi
public final Operation insertSubnetwork(ProjectRegionName region,
                                                 Subnetwork subnetworkResource)

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

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   Subnetwork subnetworkResource = Subnetwork.newBuilder().build();
   Operation response = subnetworkClient.insertSubnetwork(region, subnetworkResource);
 }
 

Parameters:

region - Name of the region scoping this request.

subnetworkResource - Represents a Subnetwork resource.

A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==)

Throws:

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

insertSubnetwork

@BetaApi
public final Operation insertSubnetwork(String region,
                                                 Subnetwork subnetworkResource)

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

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   Subnetwork subnetworkResource = Subnetwork.newBuilder().build();
   Operation response = subnetworkClient.insertSubnetwork(region.toString(), subnetworkResource);
 }
 

Parameters:

region - Name of the region scoping this request.

subnetworkResource - Represents a Subnetwork resource.

A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==)

Throws:

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

insertSubnetwork

@BetaApi
public final Operation insertSubnetwork(InsertSubnetworkHttpRequest request)

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

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   Subnetwork subnetworkResource = Subnetwork.newBuilder().build();
   InsertSubnetworkHttpRequest request = InsertSubnetworkHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .setSubnetworkResource(subnetworkResource)
     .build();
   Operation response = subnetworkClient.insertSubnetwork(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

insertSubnetworkCallable

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

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

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   Subnetwork subnetworkResource = Subnetwork.newBuilder().build();
   InsertSubnetworkHttpRequest request = InsertSubnetworkHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .setSubnetworkResource(subnetworkResource)
     .build();
   ApiFuture<Operation> future = subnetworkClient.insertSubnetworkCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listSubnetworks

@BetaApi
public final SubnetworkClient.ListSubnetworksPagedResponse listSubnetworks(ProjectRegionName region)

Retrieves a list of subnetworks available to the specified project.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   for (Subnetwork element : subnetworkClient.listSubnetworks(region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

region - Name of the region scoping this request.

Throws:

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

listSubnetworks

@BetaApi
public final SubnetworkClient.ListSubnetworksPagedResponse listSubnetworks(String region)

Retrieves a list of subnetworks available to the specified project.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   for (Subnetwork element : subnetworkClient.listSubnetworks(region.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

region - Name of the region scoping this request.

Throws:

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

listSubnetworks

@BetaApi
public final SubnetworkClient.ListSubnetworksPagedResponse listSubnetworks(ListSubnetworksHttpRequest request)

Retrieves a list of subnetworks available to the specified project.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListSubnetworksHttpRequest request = ListSubnetworksHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   for (Subnetwork element : subnetworkClient.listSubnetworks(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

listSubnetworksPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListSubnetworksHttpRequest,SubnetworkClient.ListSubnetworksPagedResponse> listSubnetworksPagedCallable()

Retrieves a list of subnetworks available to the specified project.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListSubnetworksHttpRequest request = ListSubnetworksHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   ApiFuture<ListSubnetworksPagedResponse> future = subnetworkClient.listSubnetworksPagedCallable().futureCall(request);
   // Do something
   for (Subnetwork element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listSubnetworksCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListSubnetworksHttpRequest,SubnetworkList> listSubnetworksCallable()

Retrieves a list of subnetworks available to the specified project.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListSubnetworksHttpRequest request = ListSubnetworksHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   while (true) {
     SubnetworkList response = subnetworkClient.listSubnetworksCallable().call(request);
     for (Subnetwork element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

listUsableSubnetworks

@BetaApi
public final SubnetworkClient.ListUsableSubnetworksPagedResponse listUsableSubnetworks(ProjectName project)

Retrieves an aggregated list of all usable subnetworks in the project. The list contains all of the subnetworks in the project and the subnetworks that were shared by a Shared VPC host project.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (UsableSubnetwork element : subnetworkClient.listUsableSubnetworks(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

listUsableSubnetworks

@BetaApi
public final SubnetworkClient.ListUsableSubnetworksPagedResponse listUsableSubnetworks(String project)

Retrieves an aggregated list of all usable subnetworks in the project. The list contains all of the subnetworks in the project and the subnetworks that were shared by a Shared VPC host project.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (UsableSubnetwork element : subnetworkClient.listUsableSubnetworks(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

listUsableSubnetworks

@BetaApi
public final SubnetworkClient.ListUsableSubnetworksPagedResponse listUsableSubnetworks(ListUsableSubnetworksHttpRequest request)

Retrieves an aggregated list of all usable subnetworks in the project. The list contains all of the subnetworks in the project and the subnetworks that were shared by a Shared VPC host project.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListUsableSubnetworksHttpRequest request = ListUsableSubnetworksHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (UsableSubnetwork element : subnetworkClient.listUsableSubnetworks(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

listUsableSubnetworksPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListUsableSubnetworksHttpRequest,SubnetworkClient.ListUsableSubnetworksPagedResponse> listUsableSubnetworksPagedCallable()

Retrieves an aggregated list of all usable subnetworks in the project. The list contains all of the subnetworks in the project and the subnetworks that were shared by a Shared VPC host project.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListUsableSubnetworksHttpRequest request = ListUsableSubnetworksHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<ListUsableSubnetworksPagedResponse> future = subnetworkClient.listUsableSubnetworksPagedCallable().futureCall(request);
   // Do something
   for (UsableSubnetwork element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listUsableSubnetworksCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListUsableSubnetworksHttpRequest,UsableSubnetworksAggregatedList> listUsableSubnetworksCallable()

Retrieves an aggregated list of all usable subnetworks in the project. The list contains all of the subnetworks in the project and the subnetworks that were shared by a Shared VPC host project.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListUsableSubnetworksHttpRequest request = ListUsableSubnetworksHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     UsableSubnetworksAggregatedList response = subnetworkClient.listUsableSubnetworksCallable().call(request);
     for (UsableSubnetwork element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

patchSubnetwork

@BetaApi
public final Operation patchSubnetwork(ProjectRegionSubnetworkName subnetwork,
                                                Subnetwork subnetworkResource,
                                                List<String> fieldMask)

Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingeprint of the subnetwork resource being patched.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectRegionSubnetworkName subnetwork = ProjectRegionSubnetworkName.of("[PROJECT]", "[REGION]", "[SUBNETWORK]");
   Subnetwork subnetworkResource = Subnetwork.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = subnetworkClient.patchSubnetwork(subnetwork, subnetworkResource, fieldMask);
 }
 

Parameters:

subnetwork - Name of the Subnetwork resource to patch.

subnetworkResource - Represents a Subnetwork resource.

A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==)

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

patchSubnetwork

@BetaApi
public final Operation patchSubnetwork(String subnetwork,
                                                Subnetwork subnetworkResource,
                                                List<String> fieldMask)

Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingeprint of the subnetwork resource being patched.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectRegionSubnetworkName subnetwork = ProjectRegionSubnetworkName.of("[PROJECT]", "[REGION]", "[SUBNETWORK]");
   Subnetwork subnetworkResource = Subnetwork.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = subnetworkClient.patchSubnetwork(subnetwork.toString(), subnetworkResource, fieldMask);
 }
 

Parameters:

subnetwork - Name of the Subnetwork resource to patch.

subnetworkResource - Represents a Subnetwork resource.

A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==)

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

patchSubnetwork

@BetaApi
public final Operation patchSubnetwork(PatchSubnetworkHttpRequest request)

Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingeprint of the subnetwork resource being patched.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedSubnetwork = ProjectRegionSubnetworkName.format("[PROJECT]", "[REGION]", "[SUBNETWORK]");
   Subnetwork subnetworkResource = Subnetwork.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchSubnetworkHttpRequest request = PatchSubnetworkHttpRequest.newBuilder()
     .setSubnetwork(formattedSubnetwork)
     .setSubnetworkResource(subnetworkResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = subnetworkClient.patchSubnetwork(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

patchSubnetworkCallable

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

Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingeprint of the subnetwork resource being patched.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedSubnetwork = ProjectRegionSubnetworkName.format("[PROJECT]", "[REGION]", "[SUBNETWORK]");
   Subnetwork subnetworkResource = Subnetwork.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchSubnetworkHttpRequest request = PatchSubnetworkHttpRequest.newBuilder()
     .setSubnetwork(formattedSubnetwork)
     .setSubnetworkResource(subnetworkResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = subnetworkClient.patchSubnetworkCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

setIamPolicySubnetwork

@BetaApi
public final Policy setIamPolicySubnetwork(ProjectRegionSubnetworkResourceName resource,
                                                    RegionSetPolicyRequest regionSetPolicyRequestResource)

Sets the access control policy on the specified resource. Replaces any existing policy.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectRegionSubnetworkResourceName resource = ProjectRegionSubnetworkResourceName.of("[PROJECT]", "[REGION]", "[RESOURCE]");
   RegionSetPolicyRequest regionSetPolicyRequestResource = RegionSetPolicyRequest.newBuilder().build();
   Policy response = subnetworkClient.setIamPolicySubnetwork(resource, regionSetPolicyRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

regionSetPolicyRequestResource -

Throws:

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

setIamPolicySubnetwork

@BetaApi
public final Policy setIamPolicySubnetwork(String resource,
                                                    RegionSetPolicyRequest regionSetPolicyRequestResource)

Sets the access control policy on the specified resource. Replaces any existing policy.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectRegionSubnetworkResourceName resource = ProjectRegionSubnetworkResourceName.of("[PROJECT]", "[REGION]", "[RESOURCE]");
   RegionSetPolicyRequest regionSetPolicyRequestResource = RegionSetPolicyRequest.newBuilder().build();
   Policy response = subnetworkClient.setIamPolicySubnetwork(resource.toString(), regionSetPolicyRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

regionSetPolicyRequestResource -

Throws:

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

setIamPolicySubnetwork

@BetaApi
public final Policy setIamPolicySubnetwork(SetIamPolicySubnetworkHttpRequest request)

Sets the access control policy on the specified resource. Replaces any existing policy.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedResource = ProjectRegionSubnetworkResourceName.format("[PROJECT]", "[REGION]", "[RESOURCE]");
   RegionSetPolicyRequest regionSetPolicyRequestResource = RegionSetPolicyRequest.newBuilder().build();
   SetIamPolicySubnetworkHttpRequest request = SetIamPolicySubnetworkHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setRegionSetPolicyRequestResource(regionSetPolicyRequestResource)
     .build();
   Policy response = subnetworkClient.setIamPolicySubnetwork(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

setIamPolicySubnetworkCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<SetIamPolicySubnetworkHttpRequest,Policy> setIamPolicySubnetworkCallable()

Sets the access control policy on the specified resource. Replaces any existing policy.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedResource = ProjectRegionSubnetworkResourceName.format("[PROJECT]", "[REGION]", "[RESOURCE]");
   RegionSetPolicyRequest regionSetPolicyRequestResource = RegionSetPolicyRequest.newBuilder().build();
   SetIamPolicySubnetworkHttpRequest request = SetIamPolicySubnetworkHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setRegionSetPolicyRequestResource(regionSetPolicyRequestResource)
     .build();
   ApiFuture<Policy> future = subnetworkClient.setIamPolicySubnetworkCallable().futureCall(request);
   // Do something
   Policy response = future.get();
 }
 

setPrivateIpGoogleAccessSubnetwork

@BetaApi
public final Operation setPrivateIpGoogleAccessSubnetwork(ProjectRegionSubnetworkName subnetwork,
                                                                   SubnetworksSetPrivateIpGoogleAccessRequest subnetworksSetPrivateIpGoogleAccessRequestResource)

Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectRegionSubnetworkName subnetwork = ProjectRegionSubnetworkName.of("[PROJECT]", "[REGION]", "[SUBNETWORK]");
   SubnetworksSetPrivateIpGoogleAccessRequest subnetworksSetPrivateIpGoogleAccessRequestResource = SubnetworksSetPrivateIpGoogleAccessRequest.newBuilder().build();
   Operation response = subnetworkClient.setPrivateIpGoogleAccessSubnetwork(subnetwork, subnetworksSetPrivateIpGoogleAccessRequestResource);
 }
 

Parameters:

subnetwork - Name of the Subnetwork resource.

subnetworksSetPrivateIpGoogleAccessRequestResource -

Throws:

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

setPrivateIpGoogleAccessSubnetwork

@BetaApi
public final Operation setPrivateIpGoogleAccessSubnetwork(String subnetwork,
                                                                   SubnetworksSetPrivateIpGoogleAccessRequest subnetworksSetPrivateIpGoogleAccessRequestResource)

Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectRegionSubnetworkName subnetwork = ProjectRegionSubnetworkName.of("[PROJECT]", "[REGION]", "[SUBNETWORK]");
   SubnetworksSetPrivateIpGoogleAccessRequest subnetworksSetPrivateIpGoogleAccessRequestResource = SubnetworksSetPrivateIpGoogleAccessRequest.newBuilder().build();
   Operation response = subnetworkClient.setPrivateIpGoogleAccessSubnetwork(subnetwork.toString(), subnetworksSetPrivateIpGoogleAccessRequestResource);
 }
 

Parameters:

subnetwork - Name of the Subnetwork resource.

subnetworksSetPrivateIpGoogleAccessRequestResource -

Throws:

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

setPrivateIpGoogleAccessSubnetwork

@BetaApi
public final Operation setPrivateIpGoogleAccessSubnetwork(SetPrivateIpGoogleAccessSubnetworkHttpRequest request)

Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedSubnetwork = ProjectRegionSubnetworkName.format("[PROJECT]", "[REGION]", "[SUBNETWORK]");
   SubnetworksSetPrivateIpGoogleAccessRequest subnetworksSetPrivateIpGoogleAccessRequestResource = SubnetworksSetPrivateIpGoogleAccessRequest.newBuilder().build();
   SetPrivateIpGoogleAccessSubnetworkHttpRequest request = SetPrivateIpGoogleAccessSubnetworkHttpRequest.newBuilder()
     .setSubnetwork(formattedSubnetwork)
     .setSubnetworksSetPrivateIpGoogleAccessRequestResource(subnetworksSetPrivateIpGoogleAccessRequestResource)
     .build();
   Operation response = subnetworkClient.setPrivateIpGoogleAccessSubnetwork(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

setPrivateIpGoogleAccessSubnetworkCallable

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

Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedSubnetwork = ProjectRegionSubnetworkName.format("[PROJECT]", "[REGION]", "[SUBNETWORK]");
   SubnetworksSetPrivateIpGoogleAccessRequest subnetworksSetPrivateIpGoogleAccessRequestResource = SubnetworksSetPrivateIpGoogleAccessRequest.newBuilder().build();
   SetPrivateIpGoogleAccessSubnetworkHttpRequest request = SetPrivateIpGoogleAccessSubnetworkHttpRequest.newBuilder()
     .setSubnetwork(formattedSubnetwork)
     .setSubnetworksSetPrivateIpGoogleAccessRequestResource(subnetworksSetPrivateIpGoogleAccessRequestResource)
     .build();
   ApiFuture<Operation> future = subnetworkClient.setPrivateIpGoogleAccessSubnetworkCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

testIamPermissionsSubnetwork

@BetaApi
public final TestPermissionsResponse testIamPermissionsSubnetwork(ProjectRegionSubnetworkResourceName resource,
                                                                           TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectRegionSubnetworkResourceName resource = ProjectRegionSubnetworkResourceName.of("[PROJECT]", "[REGION]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response = subnetworkClient.testIamPermissionsSubnetwork(resource, testPermissionsRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

testPermissionsRequestResource -

Throws:

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

testIamPermissionsSubnetwork

@BetaApi
public final TestPermissionsResponse testIamPermissionsSubnetwork(String resource,
                                                                           TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   ProjectRegionSubnetworkResourceName resource = ProjectRegionSubnetworkResourceName.of("[PROJECT]", "[REGION]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response = subnetworkClient.testIamPermissionsSubnetwork(resource.toString(), testPermissionsRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

testPermissionsRequestResource -

Throws:

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

testIamPermissionsSubnetwork

@BetaApi
public final TestPermissionsResponse testIamPermissionsSubnetwork(TestIamPermissionsSubnetworkHttpRequest request)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedResource = ProjectRegionSubnetworkResourceName.format("[PROJECT]", "[REGION]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestIamPermissionsSubnetworkHttpRequest request = TestIamPermissionsSubnetworkHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setTestPermissionsRequestResource(testPermissionsRequestResource)
     .build();
   TestPermissionsResponse response = subnetworkClient.testIamPermissionsSubnetwork(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

testIamPermissionsSubnetworkCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsSubnetworkHttpRequest,TestPermissionsResponse> testIamPermissionsSubnetworkCallable()

Returns permissions that a caller has on the specified resource.

Sample code:

 try (SubnetworkClient subnetworkClient = SubnetworkClient.create()) {
   String formattedResource = ProjectRegionSubnetworkResourceName.format("[PROJECT]", "[REGION]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestIamPermissionsSubnetworkHttpRequest request = TestIamPermissionsSubnetworkHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setTestPermissionsRequestResource(testPermissionsRequestResource)
     .build();
   ApiFuture<TestPermissionsResponse> future = subnetworkClient.testIamPermissionsSubnetworkCallable().futureCall(request);
   // Do something
   TestPermissionsResponse 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