Compute Engine v1 API - Class NodeGroups.NodeGroupsBase (3.1.0)

Version latest

• 3.1.0 (latest)
• 3.0.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

[BindServiceMethod(typeof(NodeGroups), "BindService")]
public abstract class NodeGroups.NodeGroupsBase

Reference documentation and code samples for the Compute Engine v1 API class NodeGroups.NodeGroupsBase.

Base class for server-side implementations of NodeGroups

Inheritance

object > NodeGroups.NodeGroupsBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Methods

AddNodes(AddNodesNodeGroupRequest, ServerCallContext)

public virtual Task<Operation> AddNodes(AddNodesNodeGroupRequest request, ServerCallContext context)

Adds specified number of nodes to the node group.

Parameters
Name	Description
request	AddNodesNodeGroupRequest 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).

AggregatedList(AggregatedListNodeGroupsRequest, ServerCallContext)

public virtual Task<NodeGroupAggregatedList> AggregatedList(AggregatedListNodeGroupsRequest request, ServerCallContext context)

Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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

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

Delete(DeleteNodeGroupRequest, ServerCallContext)

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

Deletes the specified NodeGroup resource.

Parameters
Name	Description
request	DeleteNodeGroupRequest 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).

DeleteNodes(DeleteNodesNodeGroupRequest, ServerCallContext)

public virtual Task<Operation> DeleteNodes(DeleteNodesNodeGroupRequest request, ServerCallContext context)

Deletes specified nodes from the node group.

Parameters
Name	Description
request	DeleteNodesNodeGroupRequest 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(GetNodeGroupRequest, ServerCallContext)

public virtual Task<NodeGroup> Get(GetNodeGroupRequest request, ServerCallContext context)

Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead.

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

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

GetIamPolicy(GetIamPolicyNodeGroupRequest, ServerCallContext)

public virtual Task<Policy> GetIamPolicy(GetIamPolicyNodeGroupRequest request, ServerCallContext context)

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

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

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

Insert(InsertNodeGroupRequest, ServerCallContext)

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

Creates a NodeGroup resource in the specified project using the data included in the request.

Parameters
Name	Description
request	InsertNodeGroupRequest 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(ListNodeGroupsRequest, ServerCallContext)

public virtual Task<NodeGroupList> List(ListNodeGroupsRequest request, ServerCallContext context)

Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.

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

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

ListNodes(ListNodesNodeGroupsRequest, ServerCallContext)

public virtual Task<NodeGroupsListNodes> ListNodes(ListNodesNodeGroupsRequest request, ServerCallContext context)

Lists nodes in the node group.

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

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

Patch(PatchNodeGroupRequest, ServerCallContext)

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

Updates the specified node group.

Parameters
Name	Description
request	PatchNodeGroupRequest 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).

PerformMaintenance(PerformMaintenanceNodeGroupRequest, ServerCallContext)

public virtual Task<Operation> PerformMaintenance(PerformMaintenanceNodeGroupRequest request, ServerCallContext context)

Perform maintenance on a subset of nodes in the node group.

Parameters
Name	Description
request	PerformMaintenanceNodeGroupRequest 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).

SetIamPolicy(SetIamPolicyNodeGroupRequest, ServerCallContext)

public virtual Task<Policy> SetIamPolicy(SetIamPolicyNodeGroupRequest request, ServerCallContext context)

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

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

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

SetNodeTemplate(SetNodeTemplateNodeGroupRequest, ServerCallContext)

public virtual Task<Operation> SetNodeTemplate(SetNodeTemplateNodeGroupRequest request, ServerCallContext context)

Updates the node template of the node group.

Parameters
Name	Description
request	SetNodeTemplateNodeGroupRequest 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).

SimulateMaintenanceEvent(SimulateMaintenanceEventNodeGroupRequest, ServerCallContext)

public virtual Task<Operation> SimulateMaintenanceEvent(SimulateMaintenanceEventNodeGroupRequest request, ServerCallContext context)

Simulates maintenance event on specified nodes from the node group.

Parameters
Name	Description
request	SimulateMaintenanceEventNodeGroupRequest 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).

TestIamPermissions(TestIamPermissionsNodeGroupRequest, ServerCallContext)

public virtual Task<TestPermissionsResponse> TestIamPermissions(TestIamPermissionsNodeGroupRequest request, ServerCallContext context)

Returns permissions that a caller has on the specified resource.

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

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