target.apidocs.com.google.api.services.compute.Compute.VpnTunnels.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-compute Show documentation

There is a newer version: v1-rev20240903-2.0.0

Show newest version







Compute.VpnTunnels (Compute Engine API v1-rev20240919-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute
Class Compute.VpnTunnels



java.lang.Object


com.google.api.services.compute.Compute.VpnTunnels







Enclosing class:
Compute




public class Compute.VpnTunnels
extends Object
The "vpnTunnels" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Compute.VpnTunnels.AggregatedList 


class 
Compute.VpnTunnels.Delete 


class 
Compute.VpnTunnels.Get 


class 
Compute.VpnTunnels.Insert 


class 
Compute.VpnTunnels.List 


class 
Compute.VpnTunnels.SetLabels 









Constructor Summary

Constructors 

Constructor and Description


VpnTunnels() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Compute.VpnTunnels.AggregatedList
aggregatedList(String project)
Retrieves an aggregated list of VPN tunnels.



Compute.VpnTunnels.Delete
delete(String project,
      String region,
      String vpnTunnel)
Deletes the specified VpnTunnel resource.



Compute.VpnTunnels.Get
get(String project,
   String region,
   String vpnTunnel)
Returns the specified VpnTunnel resource.



Compute.VpnTunnels.Insert
insert(String project,
      String region,
      VpnTunnel content)
Creates a VpnTunnel resource in the specified project and region using the data included in the
 request.



Compute.VpnTunnels.List
list(String project,
    String region)
Retrieves a list of VpnTunnel resources contained in the specified project and region.



Compute.VpnTunnels.SetLabels
setLabels(String project,
         String region,
         String resource,
         RegionSetLabelsRequest content)
Sets the labels on a VpnTunnel.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





VpnTunnels
public VpnTunnels()









Method Detail





aggregatedList
public Compute.VpnTunnels.AggregatedList aggregatedList(String project)
                                                 throws IOException
Retrieves an aggregated list of VPN tunnels. To prevent failure, Google recommends that you set
 the `returnPartialSuccess` parameter to `true`.

 Create a request for the method "vpnTunnels.aggregatedList".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
Returns:
the request
Throws:
IOException








delete
public Compute.VpnTunnels.Delete delete(String project,
                                        String region,
                                        String vpnTunnel)
                                 throws IOException
Deletes the specified VpnTunnel resource.

 Create a request for the method "vpnTunnels.delete".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
region - Name of the region for this request.
vpnTunnel - Name of the VpnTunnel resource to delete.
Returns:
the request
Throws:
IOException








get
public Compute.VpnTunnels.Get get(String project,
                                  String region,
                                  String vpnTunnel)
                           throws IOException
Returns the specified VpnTunnel resource.

 Create a request for the method "vpnTunnels.get".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
region - Name of the region for this request.
vpnTunnel - Name of the VpnTunnel resource to return.
Returns:
the request
Throws:
IOException








insert
public Compute.VpnTunnels.Insert insert(String project,
                                        String region,
                                        VpnTunnel content)
                                 throws IOException
Creates a VpnTunnel resource in the specified project and region using the data included in the
 request.

 Create a request for the method "vpnTunnels.insert".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
region - Name of the region for this request.
content - the VpnTunnel
Returns:
the request
Throws:
IOException








list
public Compute.VpnTunnels.List list(String project,
                                    String region)
                             throws IOException
Retrieves a list of VpnTunnel resources contained in the specified project and region.

 Create a request for the method "vpnTunnels.list".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
region - Name of the region for this request.
Returns:
the request
Throws:
IOException








setLabels
public Compute.VpnTunnels.SetLabels setLabels(String project,
                                              String region,
                                              String resource,
                                              RegionSetLabelsRequest content)
                                       throws IOException
Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources
 documentation.

 Create a request for the method "vpnTunnels.setLabels".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
region - The region for this request.
resource - Name or id of the resource for this request.
content - the RegionSetLabelsRequest
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`Compute.VpnTunnels.AggregatedList`
`class`	`Compute.VpnTunnels.Delete`
`class`	`Compute.VpnTunnels.Get`
`class`	`Compute.VpnTunnels.Insert`
`class`	`Compute.VpnTunnels.List`
`class`	`Compute.VpnTunnels.SetLabels`

Modifier and Type	Method and Description
`Compute.VpnTunnels.AggregatedList`	`aggregatedList(String project)` Retrieves an aggregated list of VPN tunnels.
`Compute.VpnTunnels.Delete`	`delete(String project, String region, String vpnTunnel)` Deletes the specified VpnTunnel resource.
`Compute.VpnTunnels.Get`	`get(String project, String region, String vpnTunnel)` Returns the specified VpnTunnel resource.
`Compute.VpnTunnels.Insert`	`insert(String project, String region, VpnTunnel content)` Creates a VpnTunnel resource in the specified project and region using the data included in the request.
`Compute.VpnTunnels.List`	`list(String project, String region)` Retrieves a list of VpnTunnel resources contained in the specified project and region.
`Compute.VpnTunnels.SetLabels`	`setLabels(String project, String region, String resource, RegionSetLabelsRequest content)` Sets the labels on a VpnTunnel.