nodes

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

Overview

Name	nodes
Type	Resource
Id	google.sasportal.nodes

Fields

The following fields are returned by SELECT queries:

nodes_nodes_nodes_list

Name	Datatype	Description
name	string	Output only. Resource name.
displayName	string	The node's display name.
sasUserIds	array	User ids used by the devices belonging to this node.

nodes_nodes_list

Name	Datatype	Description
name	string	Output only. Resource name.
displayName	string	The node's display name.
sasUserIds	array	User ids used by the devices belonging to this node.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
nodes_nodes_nodes_list	select	nodesId, nodesId1	pageSize, pageToken, filter	Lists nodes.
nodes_nodes_list	select	nodesId	pageSize, pageToken, filter	Lists nodes.
nodes_nodes_nodes_create	insert	nodesId, nodesId1		Creates a new node.
nodes_nodes_create	insert	nodesId		Creates a new node.
customers_nodes_patch	update	customersId, nodesId	updateMask	Updates an existing node.
nodes_nodes_patch	update	nodesId, nodesId1	updateMask	Updates an existing node.
nodes_nodes_delete	delete	nodesId, nodesId1		Deletes a node.
customers_nodes_move	exec	customersId, nodesId		Moves a node under another node or customer.
nodes_nodes_move	exec	nodesId, nodesId1		Moves a node under another node or customer.

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
customersId	string
nodesId	string
nodesId1	string
filter	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

nodes_nodes_nodes_list

Lists nodes.

SELECT
name,
displayName,
sasUserIds
FROM google.sasportal.nodes
WHERE nodesId = '{{ nodesId }}' -- required
AND nodesId1 = '{{ nodesId1 }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
;

nodes_nodes_list

Lists nodes.

SELECT
name,
displayName,
sasUserIds
FROM google.sasportal.nodes
WHERE nodesId = '{{ nodesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
;

INSERT examples

nodes_nodes_nodes_create

Creates a new node.

INSERT INTO google.sasportal.nodes (
data__name,
data__displayName,
data__sasUserIds,
nodesId,
nodesId1
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ sasUserIds }}',
'{{ nodesId }}',
'{{ nodesId1 }}'
RETURNING
name,
displayName,
sasUserIds
;

nodes_nodes_create

Creates a new node.

INSERT INTO google.sasportal.nodes (
data__name,
data__displayName,
data__sasUserIds,
nodesId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ sasUserIds }}',
'{{ nodesId }}'
RETURNING
name,
displayName,
sasUserIds
;

Manifest

# Description fields are for documentation purposes
- name: nodes
  props:
    - name: nodesId
      value: string
      description: Required parameter for the nodes resource.
    - name: nodesId1
      value: string
      description: Required parameter for the nodes resource.
    - name: name
      value: string
      description: >
        Output only. Resource name.
        
    - name: displayName
      value: string
      description: >
        The node's display name.
        
    - name: sasUserIds
      value: array
      description: >
        User ids used by the devices belonging to this node.
        

UPDATE examples

customers_nodes_patch

Updates an existing node.

UPDATE google.sasportal.nodes
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__sasUserIds = '{{ sasUserIds }}'
WHERE 
customersId = '{{ customersId }}' --required
AND nodesId = '{{ nodesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
displayName,
sasUserIds;

nodes_nodes_patch

Updates an existing node.

UPDATE google.sasportal.nodes
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__sasUserIds = '{{ sasUserIds }}'
WHERE 
nodesId = '{{ nodesId }}' --required
AND nodesId1 = '{{ nodesId1 }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
displayName,
sasUserIds;

DELETE examples

nodes_nodes_delete

Deletes a node.

DELETE FROM google.sasportal.nodes
WHERE nodesId = '{{ nodesId }}' --required
AND nodesId1 = '{{ nodesId1 }}' --required
;

Lifecycle Methods

customers_nodes_move

Moves a node under another node or customer.

EXEC google.sasportal.nodes.customers_nodes_move 
@customersId='{{ customersId }}' --required, 
@nodesId='{{ nodesId }}' --required 
@@json=
'{
"destination": "{{ destination }}"
}'
;

nodes_nodes_move

Moves a node under another node or customer.

EXEC google.sasportal.nodes.nodes_nodes_move 
@nodesId='{{ nodesId }}' --required, 
@nodesId1='{{ nodesId1 }}' --required 
@@json=
'{
"destination": "{{ destination }}"
}'
;