Blame - docs/dyn/sasportal_v1alpha1.customers.deployments.html - platform/external/python/google-api-python-client

blob: 2e7d1d173e4a4d1a700a2c22a6879d451b3707b2 [file] [log] [blame]

Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -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="sasportal_v1alpha1.html">SAS Portal API</a> . <a href="sasportal_v1alpha1.customers.html">customers</a> . <a href="sasportal_v1alpha1.customers.deployments.html">deployments</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
				79	<p class="firstline">Creates a new deployment.</p>
				80	<p class="toc_element">
				81	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Deletes a deployment.</p>
				83	<p class="toc_element">
				84	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Returns a requested deployment.</p>
				86	<p class="toc_element">
				87	<code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
				88	<p class="firstline">Lists deployments.</p>
				89	<p class="toc_element">
				90	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				91	<p class="firstline">Retrieves the next page of results.</p>
				92	<p class="toc_element">
				93	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				94	<p class="firstline">Updates an existing deployment.</p>
				95	<h3>Method Details</h3>
				96	<div class="method">
				97	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
				98	<pre>Creates a new deployment.
				99
				100	Args:
				101	parent: string, Required. The parent resource name where the deployment is to be created. (required)
				102	body: object, The request body.
				103	The object takes the form of:
				104
				105	{ # The Deployment.
				106	"defaultBillingMode": "A String", # Default billing mode for the deployment and devices under it.
				107	"allowedBillingModes": [ # The allowed billing modes under this deployment.
				108	"A String",
				109	],
				110	"name": "A String", # Output only. Resource name.
				111	"displayName": "A String", # The deployment's display name.
				112	"sasUserIds": [ # User id used by the devices belonging to this deployment. Each deployment
				113	# should be associated with one unique user_id.
				114	"A String",
				115	],
				116	}
				117
				118	x__xgafv: string, V1 error format.
				119	Allowed values
				120	1 - v1 error format
				121	2 - v2 error format
				122
				123	Returns:
				124	An object of the form:
				125
				126	{ # The Deployment.
				127	"defaultBillingMode": "A String", # Default billing mode for the deployment and devices under it.
				128	"allowedBillingModes": [ # The allowed billing modes under this deployment.
				129	"A String",
				130	],
				131	"name": "A String", # Output only. Resource name.
				132	"displayName": "A String", # The deployment's display name.
				133	"sasUserIds": [ # User id used by the devices belonging to this deployment. Each deployment
				134	# should be associated with one unique user_id.
				135	"A String",
				136	],
				137	}</pre>
				138	</div>
				139
				140	<div class="method">
				141	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				142	<pre>Deletes a deployment.
				143
				144	Args:
				145	name: string, Required. The name of the deployment. (required)
				146	x__xgafv: string, V1 error format.
				147	Allowed values
				148	1 - v1 error format
				149	2 - v2 error format
				150
				151	Returns:
				152	An object of the form:
				153
				154	{ # A generic empty message that you can re-use to avoid defining duplicated
				155	# empty messages in your APIs. A typical example is to use it as the request
				156	# or the response type of an API method. For instance:
				157	#
				158	# service Foo {
				159	# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
				160	# }
				161	#
				162	# The JSON representation for `Empty` is empty JSON object `{}`.
				163	}</pre>
				164	</div>
				165
				166	<div class="method">
				167	<code class="details" id="get">get(name, x__xgafv=None)</code>
				168	<pre>Returns a requested deployment.
				169
				170	Args:
				171	name: string, Required. The name of the deployment. (required)
				172	x__xgafv: string, V1 error format.
				173	Allowed values
				174	1 - v1 error format
				175	2 - v2 error format
				176
				177	Returns:
				178	An object of the form:
				179
				180	{ # The Deployment.
				181	"defaultBillingMode": "A String", # Default billing mode for the deployment and devices under it.
				182	"allowedBillingModes": [ # The allowed billing modes under this deployment.
				183	"A String",
				184	],
				185	"name": "A String", # Output only. Resource name.
				186	"displayName": "A String", # The deployment's display name.
				187	"sasUserIds": [ # User id used by the devices belonging to this deployment. Each deployment
				188	# should be associated with one unique user_id.
				189	"A String",
				190	],
				191	}</pre>
				192	</div>
				193
				194	<div class="method">
				195	<code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
				196	<pre>Lists deployments.
				197
				198	Args:
				199	parent: string, Required. The parent resource name, for example, "nodes/1",
				200	customer/1/nodes/2. (required)
				201	pageToken: string, A pagination token returned from a previous call to ListDeployments
				202	method that
				203	indicates where this listing should continue from.
				204	pageSize: integer, The maximum number of deployments to return in the response.
				205	x__xgafv: string, V1 error format.
				206	Allowed values
				207	1 - v1 error format
				208	2 - v2 error format
				209
				210	Returns:
				211	An object of the form:
				212
				213	{ # Response for ListDeployments method.
				214	"deployments": [ # The deployments that match the
				215	# request.
				216	{ # The Deployment.
				217	"defaultBillingMode": "A String", # Default billing mode for the deployment and devices under it.
				218	"allowedBillingModes": [ # The allowed billing modes under this deployment.
				219	"A String",
				220	],
				221	"name": "A String", # Output only. Resource name.
				222	"displayName": "A String", # The deployment's display name.
				223	"sasUserIds": [ # User id used by the devices belonging to this deployment. Each deployment
				224	# should be associated with one unique user_id.
				225	"A String",
				226	],
				227	},
				228	],
				229	"nextPageToken": "A String", # A pagination token returned from a previous call to
				230	# ListDeployments method that indicates
				231	# from where listing should continue. If the field is missing or empty, it
				232	# means there is no more deployments.
				233	}</pre>
				234	</div>
				235
				236	<div class="method">
				237	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				238	<pre>Retrieves the next page of results.
				239
				240	Args:
				241	previous_request: The request for the previous page. (required)
				242	previous_response: The response from the request for the previous page. (required)
				243
				244	Returns:
				245	A request object that you can call 'execute()' on to request the next
				246	page. Returns None if there are no more items in the collection.
				247	</pre>
				248	</div>
				249
				250	<div class="method">
				251	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				252	<pre>Updates an existing deployment.
				253
				254	Args:
				255	name: string, Output only. Resource name. (required)
				256	body: object, The request body.
				257	The object takes the form of:
				258
				259	{ # The Deployment.
				260	"defaultBillingMode": "A String", # Default billing mode for the deployment and devices under it.
				261	"allowedBillingModes": [ # The allowed billing modes under this deployment.
				262	"A String",
				263	],
				264	"name": "A String", # Output only. Resource name.
				265	"displayName": "A String", # The deployment's display name.
				266	"sasUserIds": [ # User id used by the devices belonging to this deployment. Each deployment
				267	# should be associated with one unique user_id.
				268	"A String",
				269	],
				270	}
				271
				272	updateMask: string, Fields to be updated.
				273	x__xgafv: string, V1 error format.
				274	Allowed values
				275	1 - v1 error format
				276	2 - v2 error format
				277
				278	Returns:
				279	An object of the form:
				280
				281	{ # The Deployment.
				282	"defaultBillingMode": "A String", # Default billing mode for the deployment and devices under it.
				283	"allowedBillingModes": [ # The allowed billing modes under this deployment.
				284	"A String",
				285	],
				286	"name": "A String", # Output only. Resource name.
				287	"displayName": "A String", # The deployment's display name.
				288	"sasUserIds": [ # User id used by the devices belonging to this deployment. Each deployment
				289	# should be associated with one unique user_id.
				290	"A String",
				291	],
				292	}</pre>
				293	</div>
				294
				295	</body></html>