docs/dyn/sasportal_v1alpha1.nodes.nodes.html

<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="sasportal_v1alpha1.html">SAS Portal API</a> . <a href="sasportal_v1alpha1.nodes.html">nodes</a> . <a href="sasportal_v1alpha1.nodes.nodes.html">nodes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="sasportal_v1alpha1.nodes.nodes.deployments.html">deployments()</a></code>
</p>
<p class="firstline">Returns the deployments Resource.</p>

<p class="toc_element">
  <code><a href="sasportal_v1alpha1.nodes.nodes.devices.html">devices()</a></code>
</p>
<p class="firstline">Returns the devices Resource.</p>

<p class="toc_element">
  <code><a href="sasportal_v1alpha1.nodes.nodes.nodes.html">nodes()</a></code>
</p>
<p class="firstline">Returns the nodes Resource.</p>

<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new node.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a node.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a requested node.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists nodes.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#move">move(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Moves a node under another node or customer.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing node.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Creates a new node.

Args:
  parent: string, Required. The parent resource name where the node is to be created. (required)
  body: object, The request body.
    The object takes the form of:

{ # The Node.
  &quot;displayName&quot;: &quot;A String&quot;, # The node&#x27;s display name.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name.
  &quot;sasUserIds&quot;: [ # User ids used by the devices belonging to this node.
    &quot;A String&quot;,
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The Node.
  &quot;displayName&quot;: &quot;A String&quot;, # The node&#x27;s display name.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name.
  &quot;sasUserIds&quot;: [ # User ids used by the devices belonging to this node.
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes a node.

Args:
  name: string, Required. The name of the node. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Returns a requested node.

Args:
  name: string, Required. The name of the node. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The Node.
  &quot;displayName&quot;: &quot;A String&quot;, # The node&#x27;s display name.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name.
  &quot;sasUserIds&quot;: [ # User ids used by the devices belonging to this node.
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists nodes.

Args:
  parent: string, Required. The parent resource name, for example, &quot;nodes/1&quot;. (required)
  filter: string, The filter expression. The filter should have the following format: &quot;DIRECT_CHILDREN&quot; or format: &quot;direct_children&quot;. The filter is case insensitive. If empty, then no nodes are filtered.
  pageSize: integer, The maximum number of nodes to return in the response.
  pageToken: string, A pagination token returned from a previous call to ListNodes that indicates where this listing should continue from.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListNodes.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A pagination token returned from a previous call to ListNodes that indicates from where listing should continue. If the field is missing or empty, it means there is no more nodes.
  &quot;nodes&quot;: [ # The nodes that match the request.
    { # The Node.
      &quot;displayName&quot;: &quot;A String&quot;, # The node&#x27;s display name.
      &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name.
      &quot;sasUserIds&quot;: [ # User ids used by the devices belonging to this node.
        &quot;A String&quot;,
      ],
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="move">move(name, body=None, x__xgafv=None)</code>
  <pre>Moves a node under another node or customer.

Args:
  name: string, Required. The name of the node to move. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for MoveNode.
  &quot;destination&quot;: &quot;A String&quot;, # Required. The name of the new parent resource node or customer to reparent the node under.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates an existing node.

Args:
  name: string, Output only. Resource name. (required)
  body: object, The request body.
    The object takes the form of:

{ # The Node.
  &quot;displayName&quot;: &quot;A String&quot;, # The node&#x27;s display name.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name.
  &quot;sasUserIds&quot;: [ # User ids used by the devices belonging to this node.
    &quot;A String&quot;,
  ],
}

  updateMask: string, Fields to be updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The Node.
  &quot;displayName&quot;: &quot;A String&quot;, # The node&#x27;s display name.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name.
  &quot;sasUserIds&quot;: [ # User ids used by the devices belonging to this node.
    &quot;A String&quot;,
  ],
}</pre>
</div>

</body></html>