Compute Engine v1 API - Class Routers.RoutersBase (3.18.0)

[BindServiceMethod(typeof(Routers), "BindService")]
public abstract class Routers.RoutersBase

Reference documentation and code samples for the Compute Engine v1 API class Routers.RoutersBase.

Base class for server-side implementations of Routers

Inheritance

object > Routers.RoutersBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Methods

AggregatedList(AggregatedListRoutersRequest, ServerCallContext)

public virtual Task<RouterAggregatedList> AggregatedList(AggregatedListRoutersRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`AggregatedListRoutersRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskRouterAggregatedList`	The response to send back to the client (wrapped by a task).

Delete(DeleteRouterRequest, ServerCallContext)

public virtual Task<Operation> Delete(DeleteRouterRequest request, ServerCallContext context)

Deletes the specified Router resource.

Parameters
Name	Description
`request`	`DeleteRouterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteRoutePolicy(DeleteRoutePolicyRouterRequest, ServerCallContext)

public virtual Task<Operation> DeleteRoutePolicy(DeleteRoutePolicyRouterRequest request, ServerCallContext context)

Deletes Route Policy

Parameters
Name	Description
`request`	`DeleteRoutePolicyRouterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

Get(GetRouterRequest, ServerCallContext)

public virtual Task<Router> Get(GetRouterRequest request, ServerCallContext context)

Returns the specified Router resource.

Parameters
Name	Description
`request`	`GetRouterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskRouter`	The response to send back to the client (wrapped by a task).

GetNatIpInfo(GetNatIpInfoRouterRequest, ServerCallContext)

public virtual Task<NatIpInfoResponse> GetNatIpInfo(GetNatIpInfoRouterRequest request, ServerCallContext context)

Retrieves runtime NAT IP information.

Parameters
Name	Description
`request`	`GetNatIpInfoRouterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskNatIpInfoResponse`	The response to send back to the client (wrapped by a task).

GetNatMappingInfo(GetNatMappingInfoRoutersRequest, ServerCallContext)

public virtual Task<VmEndpointNatMappingsList> GetNatMappingInfo(GetNatMappingInfoRoutersRequest request, ServerCallContext context)

Retrieves runtime Nat mapping information of VM endpoints.

Parameters
Name	Description
`request`	`GetNatMappingInfoRoutersRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskVmEndpointNatMappingsList`	The response to send back to the client (wrapped by a task).

GetRoutePolicy(GetRoutePolicyRouterRequest, ServerCallContext)

public virtual Task<RoutersGetRoutePolicyResponse> GetRoutePolicy(GetRoutePolicyRouterRequest request, ServerCallContext context)

Returns specified Route Policy

Parameters
Name	Description
`request`	`GetRoutePolicyRouterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskRoutersGetRoutePolicyResponse`	The response to send back to the client (wrapped by a task).

GetRouterStatus(GetRouterStatusRouterRequest, ServerCallContext)

public virtual Task<RouterStatusResponse> GetRouterStatus(GetRouterStatusRouterRequest request, ServerCallContext context)

Retrieves runtime information of the specified router.

Parameters
Name	Description
`request`	`GetRouterStatusRouterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskRouterStatusResponse`	The response to send back to the client (wrapped by a task).

Insert(InsertRouterRequest, ServerCallContext)

public virtual Task<Operation> Insert(InsertRouterRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`InsertRouterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

List(ListRoutersRequest, ServerCallContext)

public virtual Task<RouterList> List(ListRoutersRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`ListRoutersRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskRouterList`	The response to send back to the client (wrapped by a task).

ListBgpRoutes(ListBgpRoutesRoutersRequest, ServerCallContext)

public virtual Task<RoutersListBgpRoutes> ListBgpRoutes(ListBgpRoutesRoutersRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`ListBgpRoutesRoutersRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskRoutersListBgpRoutes`	The response to send back to the client (wrapped by a task).

ListRoutePolicies(ListRoutePoliciesRoutersRequest, ServerCallContext)

public virtual Task<RoutersListRoutePolicies> ListRoutePolicies(ListRoutePoliciesRoutersRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`ListRoutePoliciesRoutersRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskRoutersListRoutePolicies`	The response to send back to the client (wrapped by a task).

Patch(PatchRouterRequest, ServerCallContext)

public virtual Task<Operation> Patch(PatchRouterRequest request, ServerCallContext context)

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.

Parameters
Name	Description
`request`	`PatchRouterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

PatchRoutePolicy(PatchRoutePolicyRouterRequest, ServerCallContext)

public virtual Task<Operation> PatchRoutePolicy(PatchRoutePolicyRouterRequest request, ServerCallContext context)

Patches Route Policy

Parameters
Name	Description
`request`	`PatchRoutePolicyRouterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

Preview(PreviewRouterRequest, ServerCallContext)

public virtual Task<RoutersPreviewResponse> Preview(PreviewRouterRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`PreviewRouterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskRoutersPreviewResponse`	The response to send back to the client (wrapped by a task).

Update(UpdateRouterRequest, ServerCallContext)

public virtual Task<Operation> Update(UpdateRouterRequest request, ServerCallContext context)

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.

Parameters
Name	Description
`request`	`UpdateRouterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

UpdateRoutePolicy(UpdateRoutePolicyRouterRequest, ServerCallContext)

public virtual Task<Operation> UpdateRoutePolicy(UpdateRoutePolicyRouterRequest request, ServerCallContext context)

Updates or creates new Route Policy

Parameters
Name	Description
`request`	`UpdateRoutePolicyRouterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).