Blame - docs/dyn/prod_tt_sasportal_v1alpha1.customers.nodes.html - platform/external/python/google-api-python-client

blob: 83e9abdbdb4ef711dced70c00bb63206dd104f48 [file] [log] [blame]

Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="prod_tt_sasportal_v1alpha1.html">SAS Portal API (Testing)</a> . <a href="prod_tt_sasportal_v1alpha1.customers.html">customers</a> . <a href="prod_tt_sasportal_v1alpha1.customers.nodes.html">nodes</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	78	<code><a href="prod_tt_sasportal_v1alpha1.customers.nodes.deployments.html">deployments()</a></code>
				79	</p>
				80	<p class="firstline">Returns the deployments Resource.</p>
				81
				82	<p class="toc_element">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	83	<code><a href="prod_tt_sasportal_v1alpha1.customers.nodes.devices.html">devices()</a></code>
				84	</p>
				85	<p class="firstline">Returns the devices Resource.</p>
				86
				87	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	88	<code><a href="prod_tt_sasportal_v1alpha1.customers.nodes.nodes.html">nodes()</a></code>
				89	</p>
				90	<p class="firstline">Returns the nodes Resource.</p>
				91
				92	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	93	<code><a href="#close">close()</a></code></p>
				94	<p class="firstline">Close httplib2 connections.</p>
				95	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	96	<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
				97	<p class="firstline">Creates a new node.</p>
				98	<p class="toc_element">
				99	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				100	<p class="firstline">Deletes a node.</p>
				101	<p class="toc_element">
				102	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				103	<p class="firstline">Returns a requested node.</p>
				104	<p class="toc_element">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	105	<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	106	<p class="firstline">Lists nodes.</p>
				107	<p class="toc_element">
				108	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				109	<p class="firstline">Retrieves the next page of results.</p>
				110	<p class="toc_element">
				111	<code><a href="#move">move(name, body=None, x__xgafv=None)</a></code></p>
				112	<p class="firstline">Moves a node under another node or customer.</p>
				113	<p class="toc_element">
				114	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				115	<p class="firstline">Updates an existing node.</p>
				116	<h3>Method Details</h3>
				117	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	118	<code class="details" id="close">close()</code>
				119	<pre>Close httplib2 connections.</pre>
				120	</div>
				121
				122	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	123	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
				124	<pre>Creates a new node.
				125
				126	Args:
				127	parent: string, Required. The parent resource name where the node is to be created. (required)
				128	body: object, The request body.
				129	The object takes the form of:
				130
				131	{ # The Node.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	132	"displayName": "A String", # The node's display name.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	133	"name": "A String", # Output only. Resource name.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	134	"sasUserIds": [ # User ids used by the devices belonging to this node.
				135	"A String",
				136	],
				137	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	138
				139	x__xgafv: string, V1 error format.
				140	Allowed values
				141	1 - v1 error format
				142	2 - v2 error format
				143
				144	Returns:
				145	An object of the form:
				146
				147	{ # The Node.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	148	"displayName": "A String", # The node's display name.
				149	"name": "A String", # Output only. Resource name.
				150	"sasUserIds": [ # User ids used by the devices belonging to this node.
				151	"A String",
				152	],
				153	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	154	</div>
				155
				156	<div class="method">
				157	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				158	<pre>Deletes a node.
				159
				160	Args:
				161	name: string, Required. The name of the node. (required)
				162	x__xgafv: string, V1 error format.
				163	Allowed values
				164	1 - v1 error format
				165	2 - v2 error format
				166
				167	Returns:
				168	An object of the form:
				169
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	170	{ # 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); } The JSON representation for `Empty` is empty JSON object `{}`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	171	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	172	</div>
				173
				174	<div class="method">
				175	<code class="details" id="get">get(name, x__xgafv=None)</code>
				176	<pre>Returns a requested node.
				177
				178	Args:
				179	name: string, Required. The name of the node. (required)
				180	x__xgafv: string, V1 error format.
				181	Allowed values
				182	1 - v1 error format
				183	2 - v2 error format
				184
				185	Returns:
				186	An object of the form:
				187
				188	{ # The Node.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	189	"displayName": "A String", # The node's display name.
				190	"name": "A String", # Output only. Resource name.
				191	"sasUserIds": [ # User ids used by the devices belonging to this node.
				192	"A String",
				193	],
				194	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	195	</div>
				196
				197	<div class="method">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	198	<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	199	<pre>Lists nodes.
				200
				201	Args:
				202	parent: string, Required. The parent resource name, for example, "nodes/1". (required)
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	203	filter: string, The filter expression. The filter should have the following format: "DIRECT_CHILDREN" or format: "direct_children". The filter is case insensitive. If empty, then no nodes are filtered.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	204	pageSize: integer, The maximum number of nodes to return in the response.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	205	pageToken: string, A pagination token returned from a previous call to ListNodes that indicates where this listing should continue from.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	206	x__xgafv: string, V1 error format.
				207	Allowed values
				208	1 - v1 error format
				209	2 - v2 error format
				210
				211	Returns:
				212	An object of the form:
				213
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	214	{ # Response for ListNodes.
				215	"nextPageToken": "A String", # 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.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	216	"nodes": [ # The nodes that match the request.
				217	{ # The Node.
				218	"displayName": "A String", # The node's display name.
				219	"name": "A String", # Output only. Resource name.
				220	"sasUserIds": [ # User ids used by the devices belonging to this node.
				221	"A String",
				222	],
				223	},
				224	],
				225	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	226	</div>
				227
				228	<div class="method">
				229	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				230	<pre>Retrieves the next page of results.
				231
				232	Args:
				233	previous_request: The request for the previous page. (required)
				234	previous_response: The response from the request for the previous page. (required)
				235
				236	Returns:
				237	A request object that you can call 'execute()' on to request the next
				238	page. Returns None if there are no more items in the collection.
				239	</pre>
				240	</div>
				241
				242	<div class="method">
				243	<code class="details" id="move">move(name, body=None, x__xgafv=None)</code>
				244	<pre>Moves a node under another node or customer.
				245
				246	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	247	name: string, Required. The name of the node to move. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	248	body: object, The request body.
				249	The object takes the form of:
				250
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	251	{ # Request for MoveNode.
				252	"destination": "A String", # Required. The name of the new parent resource node or customer to reparent the node under.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	253	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	254
				255	x__xgafv: string, V1 error format.
				256	Allowed values
				257	1 - v1 error format
				258	2 - v2 error format
				259
				260	Returns:
				261	An object of the form:
				262
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	263	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	264	"done": 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.
				265	"error": { # 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.
				266	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				267	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				268	{
				269	"a_key": "", # Properties of the object. Contains field @type with type URL.
				270	},
				271	],
				272	"message": "A String", # 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.
				273	},
				274	"metadata": { # 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.
				275	"a_key": "", # Properties of the object. Contains field @type with type URL.
				276	},
				277	"name": "A String", # 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}`.
				278	"response": { # 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`.
				279	"a_key": "", # Properties of the object. Contains field @type with type URL.
				280	},
				281	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	282	</div>
				283
				284	<div class="method">
				285	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				286	<pre>Updates an existing node.
				287
				288	Args:
				289	name: string, Output only. Resource name. (required)
				290	body: object, The request body.
				291	The object takes the form of:
				292
				293	{ # The Node.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	294	"displayName": "A String", # The node's display name.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	295	"name": "A String", # Output only. Resource name.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	296	"sasUserIds": [ # User ids used by the devices belonging to this node.
				297	"A String",
				298	],
				299	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	300
				301	updateMask: string, Fields to be updated.
				302	x__xgafv: string, V1 error format.
				303	Allowed values
				304	1 - v1 error format
				305	2 - v2 error format
				306
				307	Returns:
				308	An object of the form:
				309
				310	{ # The Node.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	311	"displayName": "A String", # The node's display name.
				312	"name": "A String", # Output only. Resource name.
				313	"sasUserIds": [ # User ids used by the devices belonging to this node.
				314	"A String",
				315	],
				316	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	317	</div>
				318
				319	</body></html>