Compute Engine v1 API - Class NodeGroupsClientImpl (2.16.0)

public sealed class NodeGroupsClientImpl : NodeGroupsClient

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

NodeGroups client wrapper implementation, for convenient use.

Inheritance

object > NodeGroupsClient > NodeGroupsClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The NodeGroups API.

Constructors

NodeGroupsClientImpl(NodeGroupsClient, NodeGroupsSettings, ILogger)

public NodeGroupsClientImpl(NodeGroups.NodeGroupsClient grpcClient, NodeGroupsSettings settings, ILogger logger)

Constructs a client wrapper for the NodeGroups service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient NodeGroupsNodeGroupsClient

The underlying gRPC client.

settings NodeGroupsSettings

The base NodeGroupsSettings used within this client.

logger ILogger

Optional ILogger to use within this client.

Properties

AddNodesOperationsClient

public override OperationsClient AddNodesOperationsClient { get; }

The long-running operations client for AddNodes.

Property Value
Type Description
OperationsClient
Overrides

DeleteNodesOperationsClient

public override OperationsClient DeleteNodesOperationsClient { get; }

The long-running operations client for DeleteNodes.

Property Value
Type Description
OperationsClient
Overrides

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override NodeGroups.NodeGroupsClient GrpcClient { get; }

The underlying gRPC NodeGroups client

Property Value
Type Description
NodeGroupsNodeGroupsClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type Description
OperationsClient
Overrides

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type Description
OperationsClient
Overrides

PerformMaintenanceOperationsClient

public override OperationsClient PerformMaintenanceOperationsClient { get; }

The long-running operations client for PerformMaintenance.

Property Value
Type Description
OperationsClient
Overrides

SetNodeTemplateOperationsClient

public override OperationsClient SetNodeTemplateOperationsClient { get; }

The long-running operations client for SetNodeTemplate.

Property Value
Type Description
OperationsClient
Overrides

SimulateMaintenanceEventOperationsClient

public override OperationsClient SimulateMaintenanceEventOperationsClient { get; }

The long-running operations client for SimulateMaintenanceEvent.

Property Value
Type Description
OperationsClient
Overrides

Methods

AddNodes(AddNodesNodeGroupRequest, CallSettings)

public override Operation<Operation, Operation> AddNodes(AddNodesNodeGroupRequest request, CallSettings callSettings = null)

Adds specified number of nodes to the node group.

Parameters
Name Description
request AddNodesNodeGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

AddNodesAsync(AddNodesNodeGroupRequest, CallSettings)

public override Task<Operation<Operation, Operation>> AddNodesAsync(AddNodesNodeGroupRequest request, CallSettings callSettings = null)

Adds specified number of nodes to the node group.

Parameters
Name Description
request AddNodesNodeGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

AggregatedList(AggregatedListNodeGroupsRequest, CallSettings)

public override PagedEnumerable<NodeGroupAggregatedList, KeyValuePair<string, NodeGroupsScopedList>> AggregatedList(AggregatedListNodeGroupsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableNodeGroupAggregatedListKeyValuePairstringNodeGroupsScopedList

A pageable sequence of KeyValuePair<TKey, TValue> resources.

Overrides

AggregatedListAsync(AggregatedListNodeGroupsRequest, CallSettings)

public override PagedAsyncEnumerable<NodeGroupAggregatedList, KeyValuePair<string, NodeGroupsScopedList>> AggregatedListAsync(AggregatedListNodeGroupsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableNodeGroupAggregatedListKeyValuePairstringNodeGroupsScopedList

A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.

Overrides

Delete(DeleteNodeGroupRequest, CallSettings)

public override Operation<Operation, Operation> Delete(DeleteNodeGroupRequest request, CallSettings callSettings = null)

Deletes the specified NodeGroup resource.

Parameters
Name Description
request DeleteNodeGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

DeleteAsync(DeleteNodeGroupRequest, CallSettings)

public override Task<Operation<Operation, Operation>> DeleteAsync(DeleteNodeGroupRequest request, CallSettings callSettings = null)

Deletes the specified NodeGroup resource.

Parameters
Name Description
request DeleteNodeGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

DeleteNodes(DeleteNodesNodeGroupRequest, CallSettings)

public override Operation<Operation, Operation> DeleteNodes(DeleteNodesNodeGroupRequest request, CallSettings callSettings = null)

Deletes specified nodes from the node group.

Parameters
Name Description
request DeleteNodesNodeGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

DeleteNodesAsync(DeleteNodesNodeGroupRequest, CallSettings)

public override Task<Operation<Operation, Operation>> DeleteNodesAsync(DeleteNodesNodeGroupRequest request, CallSettings callSettings = null)

Deletes specified nodes from the node group.

Parameters
Name Description
request DeleteNodesNodeGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

Get(GetNodeGroupRequest, CallSettings)

public override NodeGroup Get(GetNodeGroupRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
NodeGroup

The RPC response.

Overrides

GetAsync(GetNodeGroupRequest, CallSettings)

public override Task<NodeGroup> GetAsync(GetNodeGroupRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskNodeGroup

A Task containing the RPC response.

Overrides

GetIamPolicy(GetIamPolicyNodeGroupRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyNodeGroupRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Policy

The RPC response.

Overrides

GetIamPolicyAsync(GetIamPolicyNodeGroupRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyNodeGroupRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Overrides

Insert(InsertNodeGroupRequest, CallSettings)

public override Operation<Operation, Operation> Insert(InsertNodeGroupRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request InsertNodeGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

InsertAsync(InsertNodeGroupRequest, CallSettings)

public override Task<Operation<Operation, Operation>> InsertAsync(InsertNodeGroupRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request InsertNodeGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

List(ListNodeGroupsRequest, CallSettings)

public override PagedEnumerable<NodeGroupList, NodeGroup> List(ListNodeGroupsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableNodeGroupListNodeGroup

A pageable sequence of NodeGroup resources.

Overrides

ListAsync(ListNodeGroupsRequest, CallSettings)

public override PagedAsyncEnumerable<NodeGroupList, NodeGroup> ListAsync(ListNodeGroupsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableNodeGroupListNodeGroup

A pageable asynchronous sequence of NodeGroup resources.

Overrides

ListNodes(ListNodesNodeGroupsRequest, CallSettings)

public override PagedEnumerable<NodeGroupsListNodes, NodeGroupNode> ListNodes(ListNodesNodeGroupsRequest request, CallSettings callSettings = null)

Lists nodes in the node group.

Parameters
Name Description
request ListNodesNodeGroupsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableNodeGroupsListNodesNodeGroupNode

A pageable sequence of NodeGroupNode resources.

Overrides

ListNodesAsync(ListNodesNodeGroupsRequest, CallSettings)

public override PagedAsyncEnumerable<NodeGroupsListNodes, NodeGroupNode> ListNodesAsync(ListNodesNodeGroupsRequest request, CallSettings callSettings = null)

Lists nodes in the node group.

Parameters
Name Description
request ListNodesNodeGroupsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableNodeGroupsListNodesNodeGroupNode

A pageable asynchronous sequence of NodeGroupNode resources.

Overrides

Patch(PatchNodeGroupRequest, CallSettings)

public override Operation<Operation, Operation> Patch(PatchNodeGroupRequest request, CallSettings callSettings = null)

Updates the specified node group.

Parameters
Name Description
request PatchNodeGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

PatchAsync(PatchNodeGroupRequest, CallSettings)

public override Task<Operation<Operation, Operation>> PatchAsync(PatchNodeGroupRequest request, CallSettings callSettings = null)

Updates the specified node group.

Parameters
Name Description
request PatchNodeGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

PerformMaintenance(PerformMaintenanceNodeGroupRequest, CallSettings)

public override Operation<Operation, Operation> PerformMaintenance(PerformMaintenanceNodeGroupRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request PerformMaintenanceNodeGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

PerformMaintenanceAsync(PerformMaintenanceNodeGroupRequest, CallSettings)

public override Task<Operation<Operation, Operation>> PerformMaintenanceAsync(PerformMaintenanceNodeGroupRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request PerformMaintenanceNodeGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

SetIamPolicy(SetIamPolicyNodeGroupRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyNodeGroupRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request SetIamPolicyNodeGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Policy

The RPC response.

Overrides

SetIamPolicyAsync(SetIamPolicyNodeGroupRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyNodeGroupRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request SetIamPolicyNodeGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Overrides

SetNodeTemplate(SetNodeTemplateNodeGroupRequest, CallSettings)

public override Operation<Operation, Operation> SetNodeTemplate(SetNodeTemplateNodeGroupRequest request, CallSettings callSettings = null)

Updates the node template of the node group.

Parameters
Name Description
request SetNodeTemplateNodeGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

SetNodeTemplateAsync(SetNodeTemplateNodeGroupRequest, CallSettings)

public override Task<Operation<Operation, Operation>> SetNodeTemplateAsync(SetNodeTemplateNodeGroupRequest request, CallSettings callSettings = null)

Updates the node template of the node group.

Parameters
Name Description
request SetNodeTemplateNodeGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

SimulateMaintenanceEvent(SimulateMaintenanceEventNodeGroupRequest, CallSettings)

public override Operation<Operation, Operation> SimulateMaintenanceEvent(SimulateMaintenanceEventNodeGroupRequest request, CallSettings callSettings = null)

Simulates maintenance event on specified nodes from the node group.

Parameters
Name Description
request SimulateMaintenanceEventNodeGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

SimulateMaintenanceEventAsync(SimulateMaintenanceEventNodeGroupRequest, CallSettings)

public override Task<Operation<Operation, Operation>> SimulateMaintenanceEventAsync(SimulateMaintenanceEventNodeGroupRequest request, CallSettings callSettings = null)

Simulates maintenance event on specified nodes from the node group.

Parameters
Name Description
request SimulateMaintenanceEventNodeGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

TestIamPermissions(TestIamPermissionsNodeGroupRequest, CallSettings)

public override TestPermissionsResponse TestIamPermissions(TestIamPermissionsNodeGroupRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsNodeGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TestPermissionsResponse

The RPC response.

Overrides

TestIamPermissionsAsync(TestIamPermissionsNodeGroupRequest, CallSettings)

public override Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsNodeGroupRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsNodeGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskTestPermissionsResponse

A Task containing the RPC response.

Overrides