node_groups_nodes

Creates, updates, deletes, gets or lists a node_groups_nodes resource.

Overview

Name	node_groups_nodes
Type	Resource
Id	google.compute.node_groups_nodes

Fields

The following fields are returned by SELECT queries:

list_nodes

Successful response

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
items	array	A list of Node resources.
kind	string	[Output Only] The resource type, which is always compute.nodeGroupsListNodes for the list of nodes in the specified node group. (default: compute#nodeGroupsListNodes)
nextPageToken	string	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLink	string	[Output Only] Server-defined URL for this resource.
warning	object	[Output Only] Informational warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_nodes	select	project, zone, nodeGroup	filter, maxResults, orderBy, pageToken, returnPartialSuccess	Lists nodes in the node group.
add_nodes	insert	project, zone, nodeGroup	requestId	Adds specified number of nodes to the node group.
delete_nodes	delete	project, zone, nodeGroup	requestId	Deletes specified nodes from the node group.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
nodeGroup	string
project	string
zone	string
filter	string
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean

SELECT examples

list_nodes

Lists nodes in the node group.

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.node_groups_nodes
WHERE project = '{{ project }}' -- required
AND zone = '{{ zone }}' -- required
AND nodeGroup = '{{ nodeGroup }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';

INSERT examples

add_nodes

Adds specified number of nodes to the node group.

INSERT INTO google.compute.node_groups_nodes (
data__additionalNodeCount,
project,
zone,
nodeGroup,
requestId
)
SELECT 
{{ additionalNodeCount }},
'{{ project }}',
'{{ zone }}',
'{{ nodeGroup }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

Manifest

# Description fields are for documentation purposes
- name: node_groups_nodes
  props:
    - name: project
      value: string
      description: Required parameter for the node_groups_nodes resource.
    - name: zone
      value: string
      description: Required parameter for the node_groups_nodes resource.
    - name: nodeGroup
      value: string
      description: Required parameter for the node_groups_nodes resource.
    - name: additionalNodeCount
      value: integer
      description: >
        Count of additional nodes to be added to the node group.
        
    - name: requestId
      value: string

DELETE examples

delete_nodes

Deletes specified nodes from the node group.

DELETE FROM google.compute.node_groups_nodes
WHERE project = '{{ project }}' --required
AND zone = '{{ zone }}' --required
AND nodeGroup = '{{ nodeGroup }}' --required
AND requestId = '{{ requestId }}';