REST Resource: nodes.nodes
Stay organized with collections
Save and categorize content based on your preferences.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-12-05 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-12-05 UTC."],[[["\u003cp\u003eA Node resource represents a device or a group of devices and is identified by its name, display name, and user IDs.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage Nodes using various methods such as creating, deleting, retrieving, listing, moving, and updating them.\u003c/p\u003e\n"],["\u003cp\u003eThe JSON representation of a Node includes its name, display name, and an array of SAS user IDs.\u003c/p\u003e\n"],["\u003cp\u003eNode resources have properties like 'name' for unique identification, 'displayName' for user-friendly representation, and 'sasUserIds' for associated users.\u003c/p\u003e\n"]]],["Nodes are resources represented in JSON with fields including `name`, `displayName`, and `sasUserIds`. Available methods allow for node management: `create`, `delete`, `get`, `list`, `move`, and `patch`. The `create` method creates a new node. `delete` removes a node. `get` retrieves a node, and `list` enumerates nodes. `move` repositions a node under another node or customer, while `patch` updates an existing node.\n"],null,["# REST Resource: nodes.nodes\n\n- [Resource: Node](#Node)\n - [JSON representation](#Node.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Node\n--------------\n\nThe Node.\n\n| JSON representation |\n|-----------------------------------------------------------------------------|\n| ``` { \"name\": string, \"displayName\": string, \"sasUserIds\": [ string ] } ``` |\n\n| Fields ||\n|----------------|---------------------------------------------------------------|\n| `name` | `string` Output only. Resource name. |\n| `displayName` | `string` The node's display name. |\n| `sasUserIds[]` | `string` User ids used by the devices belonging to this node. |\n\n| Methods ------- ||\n|----------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### [create](/spectrum-access-system/reference/rest/v1alpha1/nodes.nodes/create) | Creates a new [node](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node). |\n| ### [delete](/spectrum-access-system/reference/rest/v1alpha1/nodes.nodes/delete) | Deletes a [node](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node). |\n| ### [get](/spectrum-access-system/reference/rest/v1alpha1/nodes.nodes/get) | Returns a requested [node](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node). |\n| ### [list](/spectrum-access-system/reference/rest/v1alpha1/nodes.nodes/list) | Lists [nodes](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node). |\n| ### [move](/spectrum-access-system/reference/rest/v1alpha1/nodes.nodes/move) | Moves a [node](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node) under another [node](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node) or [customer](/spectrum-access-system/reference/rest/v1alpha1/customers#Customer). |\n| ### [patch](/spectrum-access-system/reference/rest/v1alpha1/nodes.nodes/patch) | Updates an existing [node](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node). |"]]