REST Resource: nodes
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Node
| JSON representation |
{
"name": string,
"displayName": string,
"sasUserIds": [
string
]
} |
| Fields |
name |
string
Output only. Resource name.
|
displayName |
string
The node's display name.
|
sasUserIds[] |
string
User ids used by the devices belonging to this node.
|
Methods |
|
|
Returns a requested node. |
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\u003eThe Node resource represents a node within the Spectrum Access System, identified by its name and display name.\u003c/p\u003e\n"],["\u003cp\u003eEach node can have multiple SAS user IDs associated with its devices.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve details about a specific node using the \u003ccode\u003eget\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eThe Node resource is represented in JSON format with fields for name, display name, and SAS user IDs.\u003c/p\u003e\n"]]],["The `Node` resource has a JSON representation with fields for `name` (resource name), `displayName` (node's display name), and `sasUserIds` (user IDs of devices in the node). The resource supports the `get` method, which retrieves a specific node. The core actions involve defining a node's properties through these fields and using the `get` method to retrieve a specific node's information.\n"],null,["- [Resource: Node](#Node)\n - [JSON representation](#Node.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Node The 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| [get](/spectrum-access-system/reference/rest/v1alpha1/nodes/get) | Returns a requested [node](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node). |"]]