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

blob: a018b8748d69d238cb3afbff01af8fc6d1b6f2d9 [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
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	75	<h1><a href="deploymentmanager_v2.html">Cloud Deployment Manager V2 API</a> . <a href="deploymentmanager_v2.operations.html">operations</a></h1>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	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">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	81	<code><a href="#get">get(project, operation, x__xgafv=None)</a></code></p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	82	<p class="firstline">Gets information about a specific operation.</p>
				83	<p class="toc_element">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	84	<code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, x__xgafv=None)</a></code></p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	85	<p class="firstline">Lists all operations for a project.</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">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	96	<code class="details" id="get">get(project, operation, x__xgafv=None)</code>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	97	<pre>Gets information about a specific operation.
				98
				99	Args:
				100	project: string, The project ID for this request. (required)
				101	operation: string, The name of the operation for this request. (required)
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	102	x__xgafv: string, V1 error format.
				103	Allowed values
				104	1 - v1 error format
				105	2 - v2 error format
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	106
				107	Returns:
				108	An object of the form:
				109
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	110	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	111	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				112	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				113	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				114	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				115	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				116	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	117	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	118	"code": "A String", # [Output Only] The error type identifier for this error.
				119	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				120	"message": "A String", # [Output Only] An optional, human-readable error message.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	121	},
				122	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	123	},
				124	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				125	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
				126	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				127	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				128	"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				129	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	130	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	131	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				132	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				133	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				134	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				135	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				136	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				137	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				138	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				139	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				140	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				141	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				142	{
				143	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				144	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	145	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	146	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				147	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	148	},
				149	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	150	"message": "A String", # [Output Only] A human-readable description of the warning code.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	151	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	152	],
				153	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				154	}</pre>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	155	</div>
				156
				157	<div class="method">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	158	<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, x__xgafv=None)</code>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	159	<pre>Lists all operations for a project.
				160
				161	Args:
				162	project: string, The project ID for this request. (required)
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	163	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 `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. 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. 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) ```
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	164	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`)
				165	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				166	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	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	167	x__xgafv: string, V1 error format.
				168	Allowed values
				169	1 - v1 error format
				170	2 - v2 error format
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	171
				172	Returns:
				173	An object of the form:
				174
				175	{ # A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	176	"nextPageToken": "A String", # Output only. A token used to continue a truncated list request.
				177	"operations": [ # Output only. Operations contained in this list response.
				178	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
				179	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				180	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				181	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				182	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				183	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				184	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	185	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	186	"code": "A String", # [Output Only] The error type identifier for this error.
				187	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				188	"message": "A String", # [Output Only] An optional, human-readable error message.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	189	},
				190	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	191	},
				192	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				193	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
				194	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				195	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				196	"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				197	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	198	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	199	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				200	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				201	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				202	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				203	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				204	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				205	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				206	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				207	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				208	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				209	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				210	{
				211	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				212	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	213	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	214	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				215	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	216	},
				217	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	218	"message": "A String", # [Output Only] A human-readable description of the warning code.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	219	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	220	],
				221	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				222	},
				223	],
				224	}</pre>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	225	</div>
				226
				227	<div class="method">
				228	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				229	<pre>Retrieves the next page of results.
				230
				231	Args:
				232	previous_request: The request for the previous page. (required)
				233	previous_response: The response from the request for the previous page. (required)
				234
				235	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	236	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]	237	page. Returns None if there are no more items in the collection.
				238	</pre>
				239	</div>
				240
				241	</body></html>