Show / Hide Table of Contents

Class RoutersResource

The "routers" collection of methods.

Inheritance
object
RoutersResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Compute.alpha
Assembly: Google.Apis.Compute.alpha.dll
Syntax
public class RoutersResource

Constructors

RoutersResource(IClientService)

Constructs a new resource.

Declaration
public RoutersResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

AggregatedList(string)

Retrieves an aggregated list of routers. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Declaration
public virtual RoutersResource.AggregatedListRequest AggregatedList(string project)
Parameters
Type Name Description
string project

Project ID for this request.

Returns
Type Description
RoutersResource.AggregatedListRequest

Delete(string, string, string)

Deletes the specified Router resource.

Declaration
public virtual RoutersResource.DeleteRequest Delete(string project, string region, string router)
Parameters
Type Name Description
string project

Project ID for this request.

string region

Name of the region for this request.

string router

Name of the Router resource to delete.

Returns
Type Description
RoutersResource.DeleteRequest

DeleteNamedSet(string, string, string)

Deletes Named Set

Declaration
public virtual RoutersResource.DeleteNamedSetRequest DeleteNamedSet(string project, string region, string router)
Parameters
Type Name Description
string project

Project ID for this request.

string region

Name of the region for this request.

string router

Name of the Router resource where Named Set is defined.

Returns
Type Description
RoutersResource.DeleteNamedSetRequest

DeleteRoutePolicy(string, string, string)

Deletes Route Policy

Declaration
public virtual RoutersResource.DeleteRoutePolicyRequest DeleteRoutePolicy(string project, string region, string router)
Parameters
Type Name Description
string project

Project ID for this request.

string region

Name of the region for this request.

string router

Name of the Router resource where Route Policy is defined.

Returns
Type Description
RoutersResource.DeleteRoutePolicyRequest

Get(string, string, string)

Returns the specified Router resource.

Declaration
public virtual RoutersResource.GetRequest Get(string project, string region, string router)
Parameters
Type Name Description
string project

Project ID for this request.

string region

Name of the region for this request.

string router

Name of the Router resource to return.

Returns
Type Description
RoutersResource.GetRequest

GetNamedSet(string, string, string)

Returns specified Named Set

Declaration
public virtual RoutersResource.GetNamedSetRequest GetNamedSet(string project, string region, string router)
Parameters
Type Name Description
string project

Project ID for this request.

string region

Name of the region for this request.

string router

Name of the Router resource to query for the named set. The name should conform to RFC1035.

Returns
Type Description
RoutersResource.GetNamedSetRequest

GetNatIpInfo(string, string, string)

Retrieves runtime NAT IP information.

Declaration
public virtual RoutersResource.GetNatIpInfoRequest GetNatIpInfo(string project, string region, string router)
Parameters
Type Name Description
string project

Project ID for this request.

string region

Name of the region for this request.

string router

Name of the Router resource to query for Nat IP information. The name should conform to RFC1035.

Returns
Type Description
RoutersResource.GetNatIpInfoRequest

GetNatMappingInfo(string, string, string)

Retrieves runtime Nat mapping information of VM endpoints.

Declaration
public virtual RoutersResource.GetNatMappingInfoRequest GetNatMappingInfo(string project, string region, string router)
Parameters
Type Name Description
string project

Project ID for this request.

string region

Name of the region for this request.

string router

Name of the Router resource to query for Nat Mapping information of VM endpoints.

Returns
Type Description
RoutersResource.GetNatMappingInfoRequest

GetRoutePolicy(string, string, string)

Returns specified Route Policy

Declaration
public virtual RoutersResource.GetRoutePolicyRequest GetRoutePolicy(string project, string region, string router)
Parameters
Type Name Description
string project

Project ID for this request.

string region

Name of the region for this request.

string router

Name of the Router resource to query for the route policy. The name should conform to RFC1035.

Returns
Type Description
RoutersResource.GetRoutePolicyRequest

GetRouterStatus(string, string, string)

Retrieves runtime information of the specified router.

Declaration
public virtual RoutersResource.GetRouterStatusRequest GetRouterStatus(string project, string region, string router)
Parameters
Type Name Description
string project

Project ID for this request.

string region

Name of the region for this request.

string router

Name of the Router resource to query.

Returns
Type Description
RoutersResource.GetRouterStatusRequest

Insert(Router, string, string)

Creates a Router resource in the specified project and region using the data included in the request.

Declaration
public virtual RoutersResource.InsertRequest Insert(Router body, string project, string region)
Parameters
Type Name Description
Router body

The body of the request.

string project

Project ID for this request.

string region

Name of the region for this request.

Returns
Type Description
RoutersResource.InsertRequest

List(string, string)

Retrieves a list of Router resources available to the specified project.

Declaration
public virtual RoutersResource.ListRequest List(string project, string region)
Parameters
Type Name Description
string project

Project ID for this request.

string region

Name of the region for this request.

Returns
Type Description
RoutersResource.ListRequest

ListBgpRoutes(string, string, string)

Retrieves a list of router bgp routes available to the specified project.

Declaration
public virtual RoutersResource.ListBgpRoutesRequest ListBgpRoutes(string project, string region, string router)
Parameters
Type Name Description
string project

Project ID for this request.

string region

Name of the region for this request.

string router

Name or id of the resource for this request. Name should conform to RFC1035.

Returns
Type Description
RoutersResource.ListBgpRoutesRequest

ListNamedSets(string, string, string)

Retrieves a list of router named set subresources available to the specified project.

Declaration
public virtual RoutersResource.ListNamedSetsRequest ListNamedSets(string project, string region, string router)
Parameters
Type Name Description
string project

Project ID for this request.

string region

Name of the region for this request.

string router

Name or id of the resource for this request. Name should conform to RFC1035.

Returns
Type Description
RoutersResource.ListNamedSetsRequest

ListRoutePolicies(string, string, string)

Retrieves a list of router route policy subresources available to the specified project.

Declaration
public virtual RoutersResource.ListRoutePoliciesRequest ListRoutePolicies(string project, string region, string router)
Parameters
Type Name Description
string project

Project ID for this request.

string region

Name of the region for this request.

string router

Name or id of the resource for this request. Name should conform to RFC1035.

Returns
Type Description
RoutersResource.ListRoutePoliciesRequest

Patch(Router, string, string, string)

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Declaration
public virtual RoutersResource.PatchRequest Patch(Router body, string project, string region, string router)
Parameters
Type Name Description
Router body

The body of the request.

string project

Project ID for this request.

string region

Name of the region for this request.

string router

Name of the Router resource to patch.

Returns
Type Description
RoutersResource.PatchRequest

PatchNamedSet(NamedSet, string, string, string)

Patches Named Set

Declaration
public virtual RoutersResource.PatchNamedSetRequest PatchNamedSet(NamedSet body, string project, string region, string router)
Parameters
Type Name Description
NamedSet body

The body of the request.

string project

Project ID for this request.

string region

Name of the region for this request.

string router

Name of the Router resource where Named Set is defined.

Returns
Type Description
RoutersResource.PatchNamedSetRequest

PatchRoutePolicy(RoutePolicy, string, string, string)

Patches Route Policy

Declaration
public virtual RoutersResource.PatchRoutePolicyRequest PatchRoutePolicy(RoutePolicy body, string project, string region, string router)
Parameters
Type Name Description
RoutePolicy body

The body of the request.

string project

Project ID for this request.

string region

Name of the region for this request.

string router

Name of the Router resource where Route Policy is defined.

Returns
Type Description
RoutersResource.PatchRoutePolicyRequest

Preview(Router, string, string, string)

Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

Declaration
public virtual RoutersResource.PreviewRequest Preview(Router body, string project, string region, string router)
Parameters
Type Name Description
Router body

The body of the request.

string project

Project ID for this request.

string region

Name of the region for this request.

string router

Name of the Router resource to query.

Returns
Type Description
RoutersResource.PreviewRequest

TestIamPermissions(TestPermissionsRequest, string, string, string)

Returns permissions that a caller has on the specified resource.

Declaration
public virtual RoutersResource.TestIamPermissionsRequest TestIamPermissions(TestPermissionsRequest body, string project, string region, string resource)
Parameters
Type Name Description
TestPermissionsRequest body

The body of the request.

string project

Project ID for this request.

string region

The name of the region for this request.

string resource

Name or id of the resource for this request.

Returns
Type Description
RoutersResource.TestIamPermissionsRequest

Update(Router, string, string, string)

Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.

Declaration
public virtual RoutersResource.UpdateRequest Update(Router body, string project, string region, string router)
Parameters
Type Name Description
Router body

The body of the request.

string project

Project ID for this request.

string region

Name of the region for this request.

string router

Name of the Router resource to update.

Returns
Type Description
RoutersResource.UpdateRequest

UpdateNamedSet(NamedSet, string, string, string)

Updates or creates new Named Set

Declaration
public virtual RoutersResource.UpdateNamedSetRequest UpdateNamedSet(NamedSet body, string project, string region, string router)
Parameters
Type Name Description
NamedSet body

The body of the request.

string project

Project ID for this request.

string region

Name of the region for this request.

string router

Name of the Router resource where Named Set is defined.

Returns
Type Description
RoutersResource.UpdateNamedSetRequest

UpdateRoutePolicy(RoutePolicy, string, string, string)

Updates or creates new Route Policy

Declaration
public virtual RoutersResource.UpdateRoutePolicyRequest UpdateRoutePolicy(RoutePolicy body, string project, string region, string router)
Parameters
Type Name Description
RoutePolicy body

The body of the request.

string project

Project ID for this request.

string region

Name of the region for this request.

string router

Name of the Router resource where Route Policy is defined.

Returns
Type Description
RoutersResource.UpdateRoutePolicyRequest
In this article
Back to top Generated by DocFX