Blame - docs/dyn/deploymentmanager_v2.manifests.html - platform/external/python/google-api-python-client

blob: f90b18b1fee65f1baec025df902e6945f79256ec [file] [log] [blame]

Takashi Matsuo	0669410	2015-09-11 13:55:40 -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="deploymentmanager_v2.html">Google Cloud Deployment Manager API</a> . <a href="deploymentmanager_v2.manifests.html">manifests</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	81	<code><a href="#get">get(project, deployment, manifest)</a></code></p>
				82	<p class="firstline">Gets information about a specific manifest.</p>
				83	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	84	<code><a href="#list">list(project, deployment, filter=None, maxResults=None, pageToken=None, orderBy=None)</a></code></p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	85	<p class="firstline">Lists all manifests for a given deployment.</p>
				86	<p class="toc_element">
				87	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				88	<p class="firstline">Retrieves the next page of results.</p>
				89	<h3>Method Details</h3>
				90	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	91	<code class="details" id="close">close()</code>
				92	<pre>Close httplib2 connections.</pre>
				93	</div>
				94
				95	<div class="method">
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	96	<code class="details" id="get">get(project, deployment, manifest)</code>
				97	<pre>Gets information about a specific manifest.
				98
				99	Args:
				100	project: string, The project ID for this request. (required)
				101	deployment: string, The name of the deployment for this request. (required)
				102	manifest: string, The name of the manifest for this request. (required)
				103
				104	Returns:
				105	An object of the form:
				106
				107	{
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	108	"expandedConfig": "A String", # Output only. The fully-expanded configuration file, including any templates and references.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	109	"config": { # Output only. The YAML configuration for this manifest.
				110	"content": "A String", # The contents of the file.
				111	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	112	"id": "A String",
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	113	"layout": "A String", # Output only. The YAML layout for this manifest.
				114	"name": "A String", # Output only.
				115	#
				116	# The name of the manifest.
				117	"selfLink": "A String", # Output only. Self link for the manifest.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	118	"insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
				119	"imports": [ # Output only. The imported files for this manifest.
				120	{
				121	"name": "A String", # The name of the file.
				122	"content": "A String", # The contents of the file.
				123	},
				124	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	125	}</pre>
				126	</div>
				127
				128	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	129	<code class="details" id="list">list(project, deployment, filter=None, maxResults=None, pageToken=None, orderBy=None)</code>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	130	<pre>Lists all manifests for a given deployment.
				131
				132	Args:
				133	project: string, The project ID for this request. (required)
				134	deployment: string, The name of the deployment for this request. (required)
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	135	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	136
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	137	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	138
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	139	You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	140
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	141	To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
				142	maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	143	pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	144	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				145
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	146	You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	147
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	148	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	149
				150	Returns:
				151	An object of the form:
				152
				153	{ # A response containing a partial list of manifests and a page token used to build the next request if the request has been truncated.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	154	"manifests": [ # Output only. Manifests contained in this list response.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	155	{
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	156	"expandedConfig": "A String", # Output only. The fully-expanded configuration file, including any templates and references.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	157	"config": { # Output only. The YAML configuration for this manifest.
				158	"content": "A String", # The contents of the file.
				159	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	160	"id": "A String",
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	161	"layout": "A String", # Output only. The YAML layout for this manifest.
				162	"name": "A String", # Output only.
				163	#
				164	# The name of the manifest.
				165	"selfLink": "A String", # Output only. Self link for the manifest.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	166	"insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
				167	"imports": [ # Output only. The imported files for this manifest.
				168	{
				169	"name": "A String", # The name of the file.
				170	"content": "A String", # The contents of the file.
				171	},
				172	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	173	},
				174	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	175	"nextPageToken": "A String", # Output only. A token used to continue a truncated list request.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	176	}</pre>
				177	</div>
				178
				179	<div class="method">
				180	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				181	<pre>Retrieves the next page of results.
				182
				183	Args:
				184	previous_request: The request for the previous page. (required)
				185	previous_response: The response from the request for the previous page. (required)
				186
				187	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	188	A request object that you can call 'execute()' on to request the next
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	189	page. Returns None if there are no more items in the collection.
				190	</pre>
				191	</div>
				192
				193	</body></html>