SubnetworkClient (Google Cloud 0.90.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.SubnetworkClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class SubnetworkClient
extends Object
implements 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

All Methods Static Methods Instance Methods Concrete Methods
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.
`UnaryCallable<AggregatedListSubnetworksHttpRequest,SubnetworkAggregatedList>`	`aggregatedListSubnetworksCallable()` Retrieves an aggregated list of subnetworks.
`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.
`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.
`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.
`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.
`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.
`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.
`UnaryCallable<ListSubnetworksHttpRequest,SubnetworkList>`	`listSubnetworksCallable()` Retrieves a list of subnetworks available to the specified project.
`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 usable subnetworks.
`SubnetworkClient.ListUsableSubnetworksPagedResponse`	`listUsableSubnetworks(ProjectName project)` Retrieves an aggregated list of usable subnetworks.
`SubnetworkClient.ListUsableSubnetworksPagedResponse`	`listUsableSubnetworks(String project)` Retrieves an aggregated list of usable subnetworks.
`UnaryCallable<ListUsableSubnetworksHttpRequest,UsableSubnetworksAggregatedList>`	`listUsableSubnetworksCallable()` Retrieves an aggregated list of usable subnetworks.
`UnaryCallable<ListUsableSubnetworksHttpRequest,SubnetworkClient.ListUsableSubnetworksPagedResponse>`	`listUsableSubnetworksPagedCallable()` Retrieves an aggregated list of usable subnetworks.
`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.
`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.
`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.
`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.
`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()