public sealed class NodeGroupsClientImpl : NodeGroupsClientReference documentation and code samples for the Compute Engine v1 API class NodeGroupsClientImpl.
NodeGroups client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Compute.V1Assembly
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 | NodeGroupsNodeGroupsClientThe underlying gRPC client. |
settings | NodeGroupsSettingsThe base NodeGroupsSettings used within this client. |
logger | ILoggerOptional 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 | |
DeleteNodesOperationsClient
public override OperationsClient DeleteNodesOperationsClient { get; }The long-running operations client for DeleteNodes.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DeleteOperationsClient
public override OperationsClient DeleteOperationsClient { get; }The long-running operations client for Delete.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override NodeGroups.NodeGroupsClient GrpcClient { get; }The underlying gRPC NodeGroups client
| Property Value | |
|---|---|
| Type | Description |
NodeGroupsNodeGroupsClient | |
InsertOperationsClient
public override OperationsClient InsertOperationsClient { get; }The long-running operations client for Insert.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
PatchOperationsClient
public override OperationsClient PatchOperationsClient { get; }The long-running operations client for Patch.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SetNodeTemplateOperationsClient
public override OperationsClient SetNodeTemplateOperationsClient { get; }The long-running operations client for SetNodeTemplate.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SimulateMaintenanceEventOperationsClient
public override OperationsClient SimulateMaintenanceEventOperationsClient { get; }The long-running operations client for SimulateMaintenanceEvent.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
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 | AddNodesNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
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 | AddNodesNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
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.
| Parameters | |
|---|---|
| Name | Description |
request | AggregatedListNodeGroupsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableNodeGroupAggregatedListKeyValuePairstringNodeGroupsScopedList | A pageable sequence of KeyValuePair<TKey, TValue> resources. |
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.
| Parameters | |
|---|---|
| Name | Description |
request | AggregatedListNodeGroupsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableNodeGroupAggregatedListKeyValuePairstringNodeGroupsScopedList | A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources. |
Delete(DeleteNodeGroupRequest, CallSettings)
public override Operation<Operation, Operation> Delete(DeleteNodeGroupRequest request, CallSettings callSettings = null)Deletes the specified NodeGroup resource.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
DeleteAsync(DeleteNodeGroupRequest, CallSettings)
public override Task<Operation<Operation, Operation>> DeleteAsync(DeleteNodeGroupRequest request, CallSettings callSettings = null)Deletes the specified NodeGroup resource.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
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 | DeleteNodesNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
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 | DeleteNodesNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
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 | GetNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
NodeGroup | The RPC response. |
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 | GetNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskNodeGroup | A Task containing the RPC response. |
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 | GetIamPolicyNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Policy | The RPC response. |
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 | GetIamPolicyNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy | A Task containing the RPC response. |
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 | InsertNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
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 | InsertNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
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 | ListNodeGroupsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableNodeGroupListNodeGroup | A pageable sequence of NodeGroup resources. |
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 | ListNodeGroupsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableNodeGroupListNodeGroup | A pageable asynchronous sequence of NodeGroup resources. |
ListNodes(ListNodesNodeGroupsRequest, CallSettings)
public override PagedEnumerable<NodeGroupsListNodes, NodeGroupNode> ListNodes(ListNodesNodeGroupsRequest request, CallSettings callSettings = null)Lists nodes in the node group.
| Parameters | |
|---|---|
| Name | Description |
request | ListNodesNodeGroupsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableNodeGroupsListNodesNodeGroupNode | A pageable sequence of NodeGroupNode resources. |
ListNodesAsync(ListNodesNodeGroupsRequest, CallSettings)
public override PagedAsyncEnumerable<NodeGroupsListNodes, NodeGroupNode> ListNodesAsync(ListNodesNodeGroupsRequest request, CallSettings callSettings = null)Lists nodes in the node group.
| Parameters | |
|---|---|
| Name | Description |
request | ListNodesNodeGroupsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableNodeGroupsListNodesNodeGroupNode | A pageable asynchronous sequence of NodeGroupNode resources. |
Patch(PatchNodeGroupRequest, CallSettings)
public override Operation<Operation, Operation> Patch(PatchNodeGroupRequest request, CallSettings callSettings = null)Updates the specified node group.
| Parameters | |
|---|---|
| Name | Description |
request | PatchNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
PatchAsync(PatchNodeGroupRequest, CallSettings)
public override Task<Operation<Operation, Operation>> PatchAsync(PatchNodeGroupRequest request, CallSettings callSettings = null)Updates the specified node group.
| Parameters | |
|---|---|
| Name | Description |
request | PatchNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
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 | SetIamPolicyNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Policy | The RPC response. |
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 | SetIamPolicyNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy | A Task containing the RPC response. |
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 | SetNodeTemplateNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
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 | SetNodeTemplateNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
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 | SimulateMaintenanceEventNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
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 | SimulateMaintenanceEventNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
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 | TestIamPermissionsNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TestPermissionsResponse | The RPC response. |
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 | TestIamPermissionsNodeGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTestPermissionsResponse | A Task containing the RPC response. |