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

blob: 1c8691fd260cbf28e1cf5b8beee1d1e3bfce50d5 [file] [log] [blame]

Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -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	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	75	<h1><a href="servicemanagement_v1.html">Service Management API</a> . <a href="servicemanagement_v1.operations.html">operations</a></h1>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				79	<p class="firstline">Gets the latest state of a long-running operation. Clients can use this</p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	80	<p class="toc_element">
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	81	<code><a href="#list">list(pageSize=None, name=None, pageToken=None, filter=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	e833b79	2017-03-24 15:06:46 -0700	[diff] [blame]	82	<p class="firstline">Lists service operations that match the specified filter in the request.</p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	83	<p class="toc_element">
				84	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				85	<p class="firstline">Retrieves the next page of results.</p>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	86	<h3>Method Details</h3>
				87	<div class="method">
				88	<code class="details" id="get">get(name, x__xgafv=None)</code>
				89	<pre>Gets the latest state of a long-running operation. Clients can use this
				90	method to poll the operation result at intervals as recommended by the API
				91	service.
				92
				93	Args:
				94	name: string, The name of the operation resource. (required)
				95	x__xgafv: string, V1 error format.
				96	Allowed values
				97	1 - v1 error format
				98	2 - v2 error format
				99
				100	Returns:
				101	An object of the form:
				102
				103	{ # This resource represents a long-running operation that is the result of a
				104	# network API call.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	105	"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
				106	# different programming environments, including REST APIs and RPC APIs. It is
				107	# used by [gRPC](https://github.com/grpc). Each `Status` message contains
				108	# three pieces of data: error code, error message, and error details.
				109	#
				110	# You can find out more about this error model and how to work with it in the
				111	# [API Design Guide](https://cloud.google.com/apis/design/errors).
				112	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				113	"message": "A String", # A developer-facing error message, which should be in English. Any
				114	# user-facing error message should be localized and sent in the
				115	# google.rpc.Status.details field, or localized by the client.
				116	"details": [ # A list of messages that carry the error details. There is a common set of
				117	# message types for APIs to use.
				118	{
				119	"a_key": "", # Properties of the object. Contains field @type with type URL.
				120	},
				121	],
				122	},
				123	"name": "A String", # The server-assigned name, which is only unique within the same service that
				124	# originally returns it. If you use the default HTTP mapping, the
				125	# `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	126	"metadata": { # Service-specific metadata associated with the operation. It typically
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	127	# contains progress information and common metadata such as create time.
				128	# Some services might not provide such metadata. Any method that returns a
				129	# long-running operation should document the metadata type, if any.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	130	"a_key": "", # Properties of the object. Contains field @type with type URL.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	131	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	132	"done": True or False, # If the value is `false`, it means the operation is still in progress.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	133	# If `true`, the operation is completed, and either `error` or `response` is
				134	# available.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	135	"response": { # The normal response of the operation in case of success. If the original
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	136	# method returns no data on success, such as `Delete`, the response is
				137	# `google.protobuf.Empty`. If the original method is standard
				138	# `Get`/`Create`/`Update`, the response should be the resource. For other
				139	# methods, the response should have the type `XxxResponse`, where `Xxx`
				140	# is the original method name. For example, if the original method name
				141	# is `TakeSnapshot()`, the inferred response type is
				142	# `TakeSnapshotResponse`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	143	"a_key": "", # Properties of the object. Contains field @type with type URL.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	144	},
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	145	}</pre>
				146	</div>
				147
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	148	<div class="method">
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	149	<code class="details" id="list">list(pageSize=None, name=None, pageToken=None, filter=None, x__xgafv=None)</code>
Sai Cheemalapati	e833b79	2017-03-24 15:06:46 -0700	[diff] [blame]	150	<pre>Lists service operations that match the specified filter in the request.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	151
				152	Args:
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	153	pageSize: integer, The maximum number of operations to return. If unspecified, defaults to
				154	50. The maximum value is 100.
				155	name: string, Not used.
				156	pageToken: string, The standard list page token.
Sai Cheemalapati	e833b79	2017-03-24 15:06:46 -0700	[diff] [blame]	157	filter: string, A string for filtering Operations.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	158	The following filter fields are supported&#58;
Sai Cheemalapati	e833b79	2017-03-24 15:06:46 -0700	[diff] [blame]	159
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	160	* serviceName&#58; Required. Only `=` operator is allowed.
				161	* startTime&#58; The time this job was started, in ISO 8601 format.
				162	Allowed operators are `>=`, `>`, `<=`, and `<`.
				163	* status&#58; Can be `done`, `in_progress`, or `failed`. Allowed
Sai Cheemalapati	e833b79	2017-03-24 15:06:46 -0700	[diff] [blame]	164	operators are `=`, and `!=`.
				165
				166	Filter expression supports conjunction (AND) and disjunction (OR)
				167	logical operators. However, the serviceName restriction must be at the
				168	top-level and can only be combined with other restrictions via the AND
				169	logical operator.
				170
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	171	Examples&#58;
Sai Cheemalapati	e833b79	2017-03-24 15:06:46 -0700	[diff] [blame]	172
				173	* `serviceName={some-service}.googleapis.com`
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	174	* `serviceName={some-service}.googleapis.com AND startTime>="2017-02-01"`
Sai Cheemalapati	e833b79	2017-03-24 15:06:46 -0700	[diff] [blame]	175	* `serviceName={some-service}.googleapis.com AND status=done`
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	176	* `serviceName={some-service}.googleapis.com AND (status=done OR startTime>="2017-02-01")`
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	177	x__xgafv: string, V1 error format.
				178	Allowed values
				179	1 - v1 error format
				180	2 - v2 error format
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	181
				182	Returns:
				183	An object of the form:
				184
				185	{ # The response message for Operations.ListOperations.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	186	"operations": [ # A list of operations that matches the specified filter in the request.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	187	{ # This resource represents a long-running operation that is the result of a
				188	# network API call.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	189	"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
				190	# different programming environments, including REST APIs and RPC APIs. It is
				191	# used by [gRPC](https://github.com/grpc). Each `Status` message contains
				192	# three pieces of data: error code, error message, and error details.
				193	#
				194	# You can find out more about this error model and how to work with it in the
				195	# [API Design Guide](https://cloud.google.com/apis/design/errors).
				196	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				197	"message": "A String", # A developer-facing error message, which should be in English. Any
				198	# user-facing error message should be localized and sent in the
				199	# google.rpc.Status.details field, or localized by the client.
				200	"details": [ # A list of messages that carry the error details. There is a common set of
				201	# message types for APIs to use.
				202	{
				203	"a_key": "", # Properties of the object. Contains field @type with type URL.
				204	},
				205	],
				206	},
				207	"name": "A String", # The server-assigned name, which is only unique within the same service that
				208	# originally returns it. If you use the default HTTP mapping, the
				209	# `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	210	"metadata": { # Service-specific metadata associated with the operation. It typically
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	211	# contains progress information and common metadata such as create time.
				212	# Some services might not provide such metadata. Any method that returns a
				213	# long-running operation should document the metadata type, if any.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	214	"a_key": "", # Properties of the object. Contains field @type with type URL.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	215	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	216	"done": True or False, # If the value is `false`, it means the operation is still in progress.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	217	# If `true`, the operation is completed, and either `error` or `response` is
				218	# available.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	219	"response": { # The normal response of the operation in case of success. If the original
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	220	# method returns no data on success, such as `Delete`, the response is
				221	# `google.protobuf.Empty`. If the original method is standard
				222	# `Get`/`Create`/`Update`, the response should be the resource. For other
				223	# methods, the response should have the type `XxxResponse`, where `Xxx`
				224	# is the original method name. For example, if the original method name
				225	# is `TakeSnapshot()`, the inferred response type is
				226	# `TakeSnapshotResponse`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	227	"a_key": "", # Properties of the object. Contains field @type with type URL.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	228	},
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	229	},
				230	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	231	"nextPageToken": "A String", # The standard List next-page token.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	232	}</pre>
				233	</div>
				234
				235	<div class="method">
				236	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				237	<pre>Retrieves the next page of results.
				238
				239	Args:
				240	previous_request: The request for the previous page. (required)
				241	previous_response: The response from the request for the previous page. (required)
				242
				243	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	244	A request object that you can call 'execute()' on to request the next
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	245	page. Returns None if there are no more items in the collection.
				246	</pre>
				247	</div>
				248
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	249	</body></html>