Blame - docs/dyn/lifesciences_v2beta.projects.locations.operations.html - platform/external/python/google-api-python-client

blob: 56641c08ac7eb2e0db2717c40b114c63d7eeec83 [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="lifesciences_v2beta.html">Cloud Life Sciences API</a> . <a href="lifesciences_v2beta.projects.html">projects</a> . <a href="lifesciences_v2beta.projects.locations.html">locations</a> . <a href="lifesciences_v2beta.projects.locations.operations.html">operations</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
				79	<p class="firstline">Starts asynchronous cancellation on a long-running operation.</p>
				80	<p class="toc_element">
				81	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Gets the latest state of a long-running operation.</p>
				83	<p class="toc_element">
				84	<code><a href="#list">list(name, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Lists operations that match the specified filter in the request.</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">
				91	<code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
				92	<pre>Starts asynchronous cancellation on a long-running operation.
				93	The server makes a best effort to cancel the operation, but success is not
				94	guaranteed. Clients may use Operations.GetOperation
				95	or Operations.ListOperations
				96	to check whether the cancellation succeeded or the operation completed
				97	despite cancellation.
				98	Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission&#58;
				99
				100	* `lifesciences.operations.cancel`
				101
				102	Args:
				103	name: string, The name of the operation resource to be cancelled. (required)
				104	body: object, The request body.
				105	The object takes the form of:
				106
				107	{ # The request message for Operations.CancelOperation.
				108	}
				109
				110	x__xgafv: string, V1 error format.
				111	Allowed values
				112	1 - v1 error format
				113	2 - v2 error format
				114
				115	Returns:
				116	An object of the form:
				117
				118	{ # A generic empty message that you can re-use to avoid defining duplicated
				119	# empty messages in your APIs. A typical example is to use it as the request
				120	# or the response type of an API method. For instance:
				121	#
				122	# service Foo {
				123	# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
				124	# }
				125	#
				126	# The JSON representation for `Empty` is empty JSON object `{}`.
				127	}</pre>
				128	</div>
				129
				130	<div class="method">
				131	<code class="details" id="get">get(name, x__xgafv=None)</code>
				132	<pre>Gets the latest state of a long-running operation.
				133	Clients can use this method to poll the operation result at intervals as
				134	recommended by the API service.
				135	Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission&#58;
				136
				137	* `lifesciences.operations.get`
				138
				139	Args:
				140	name: string, The name of the operation resource. (required)
				141	x__xgafv: string, V1 error format.
				142	Allowed values
				143	1 - v1 error format
				144	2 - v2 error format
				145
				146	Returns:
				147	An object of the form:
				148
				149	{ # This resource represents a long-running operation that is the result of a
				150	# network API call.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	151	"done": True or False, # If the value is `false`, it means the operation is still in progress.
				152	# If `true`, the operation is completed, and either `error` or `response` is
				153	# available.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	154	"response": { # An Empty object.
				155	"a_key": "", # Properties of the object. Contains field @type with type URL.
				156	},
				157	"name": "A String", # The server-assigned name for the operation. This may be passed to the other operation methods to retrieve information about the operation's status.
				158	"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.
				159	# different programming environments, including REST APIs and RPC APIs. It is
				160	# used by [gRPC](https://github.com/grpc). Each `Status` message contains
				161	# three pieces of data: error code, error message, and error details.
				162	#
				163	# You can find out more about this error model and how to work with it in the
				164	# [API Design Guide](https://cloud.google.com/apis/design/errors).
				165	"message": "A String", # A developer-facing error message, which should be in English. Any
				166	# user-facing error message should be localized and sent in the
				167	# google.rpc.Status.details field, or localized by the client.
				168	"details": [ # A list of messages that carry the error details. There is a common set of
				169	# message types for APIs to use.
				170	{
				171	"a_key": "", # Properties of the object. Contains field @type with type URL.
				172	},
				173	],
				174	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				175	},
				176	"metadata": { # An Metadata object. This will always be returned with the Operation.
				177	"a_key": "", # Properties of the object. Contains field @type with type URL.
				178	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	179	}</pre>
				180	</div>
				181
				182	<div class="method">
				183	<code class="details" id="list">list(name, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code>
				184	<pre>Lists operations that match the specified filter in the request.
				185	Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission&#58;
				186
				187	* `lifesciences.operations.list`
				188
				189	Args:
				190	name: string, The name of the operation's parent resource. (required)
				191	pageToken: string, The standard list page token.
				192	pageSize: integer, The maximum number of results to return. The maximum value is 256.
				193	filter: string, A string for filtering Operations.
				194	The following filter fields are supported&#58;
				195
				196	* createTime&#58; The time this job was created
				197	* events&#58; The set of event (names) that have occurred while running
				198	the pipeline. The &#58; operator can be used to determine if a
				199	particular event has occurred.
				200	* error&#58; If the pipeline is running, this value is NULL. Once the
				201	pipeline finishes, the value is the standard Google error code.
				202	* labels.key or labels."key with space" where key is a label key.
				203	* done&#58; If the pipeline is running, this value is false. Once the
				204	pipeline finishes, the value is true.
				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	{ # The response message for Operations.ListOperations.
				214	"nextPageToken": "A String", # The standard List next-page token.
				215	"operations": [ # A list of operations that matches the specified filter in the request.
				216	{ # This resource represents a long-running operation that is the result of a
				217	# network API call.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	218	"done": True or False, # If the value is `false`, it means the operation is still in progress.
				219	# If `true`, the operation is completed, and either `error` or `response` is
				220	# available.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	221	"response": { # An Empty object.
				222	"a_key": "", # Properties of the object. Contains field @type with type URL.
				223	},
				224	"name": "A String", # The server-assigned name for the operation. This may be passed to the other operation methods to retrieve information about the operation's status.
				225	"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.
				226	# different programming environments, including REST APIs and RPC APIs. It is
				227	# used by [gRPC](https://github.com/grpc). Each `Status` message contains
				228	# three pieces of data: error code, error message, and error details.
				229	#
				230	# You can find out more about this error model and how to work with it in the
				231	# [API Design Guide](https://cloud.google.com/apis/design/errors).
				232	"message": "A String", # A developer-facing error message, which should be in English. Any
				233	# user-facing error message should be localized and sent in the
				234	# google.rpc.Status.details field, or localized by the client.
				235	"details": [ # A list of messages that carry the error details. There is a common set of
				236	# message types for APIs to use.
				237	{
				238	"a_key": "", # Properties of the object. Contains field @type with type URL.
				239	},
				240	],
				241	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				242	},
				243	"metadata": { # An Metadata object. This will always be returned with the Operation.
				244	"a_key": "", # Properties of the object. Contains field @type with type URL.
				245	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	246	},
				247	],
				248	}</pre>
				249	</div>
				250
				251	<div class="method">
				252	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				253	<pre>Retrieves the next page of results.
				254
				255	Args:
				256	previous_request: The request for the previous page. (required)
				257	previous_response: The response from the request for the previous page. (required)
				258
				259	Returns:
				260	A request object that you can call 'execute()' on to request the next
				261	page. Returns None if there are no more items in the collection.
				262	</pre>
				263	</div>
				264
				265	</body></html>