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

blob: 3260065f2d99a46458d76c13e95a41d98049a6c6 [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="healthcare_v1.html">Cloud Healthcare API</a> . <a href="healthcare_v1.projects.html">projects</a> . <a href="healthcare_v1.projects.locations.html">locations</a> . <a href="healthcare_v1.projects.locations.datasets.html">datasets</a> . <a href="healthcare_v1.projects.locations.datasets.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. The server</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. Clients can use this</p>
				83	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	84	<code><a href="#list">list(name, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	85	<p class="firstline">Lists operations that match the specified filter in the request. If the</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. The server
				93	makes a best effort to cancel the operation, but success is not
				94	guaranteed. If the server doesn't support this method, it returns
				95	`google.rpc.Code.UNIMPLEMENTED`. Clients can use
				96	Operations.GetOperation or
				97	other methods to check whether the cancellation succeeded or whether the
				98	operation completed despite cancellation. On successful cancellation,
				99	the operation is not deleted; instead, it becomes an operation with
				100	an Operation.error value with a google.rpc.Status.code of 1,
				101	corresponding to `Code.CANCELLED`.
				102
				103	Args:
				104	name: string, The name of the operation resource to be cancelled. (required)
				105	body: object, The request body.
				106	The object takes the form of:
				107
				108	{ # The request message for Operations.CancelOperation.
				109	}
				110
				111	x__xgafv: string, V1 error format.
				112	Allowed values
				113	1 - v1 error format
				114	2 - v2 error format
				115
				116	Returns:
				117	An object of the form:
				118
				119	{ # A generic empty message that you can re-use to avoid defining duplicated
				120	# empty messages in your APIs. A typical example is to use it as the request
				121	# or the response type of an API method. For instance:
				122	#
				123	# service Foo {
				124	# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
				125	# }
				126	#
				127	# The JSON representation for `Empty` is empty JSON object `{}`.
				128	}</pre>
				129	</div>
				130
				131	<div class="method">
				132	<code class="details" id="get">get(name, x__xgafv=None)</code>
				133	<pre>Gets the latest state of a long-running operation. Clients can use this
				134	method to poll the operation result at intervals as recommended by the API
				135	service.
				136
				137	Args:
				138	name: string, The name of the operation resource. (required)
				139	x__xgafv: string, V1 error format.
				140	Allowed values
				141	1 - v1 error format
				142	2 - v2 error format
				143
				144	Returns:
				145	An object of the form:
				146
				147	{ # This resource represents a long-running operation that is the result of a
				148	# network API call.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	149	"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.
				150	# different programming environments, including REST APIs and RPC APIs. It is
				151	# used by [gRPC](https://github.com/grpc). Each `Status` message contains
				152	# three pieces of data: error code, error message, and error details.
				153	#
				154	# You can find out more about this error model and how to work with it in the
				155	# [API Design Guide](https://cloud.google.com/apis/design/errors).
				156	"details": [ # A list of messages that carry the error details. There is a common set of
				157	# message types for APIs to use.
				158	{
				159	"a_key": "", # Properties of the object. Contains field @type with type URL.
				160	},
				161	],
				162	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				163	"message": "A String", # A developer-facing error message, which should be in English. Any
				164	# user-facing error message should be localized and sent in the
				165	# google.rpc.Status.details field, or localized by the client.
				166	},
				167	"name": "A String", # The server-assigned name, which is only unique within the same service that
				168	# originally returns it. If you use the default HTTP mapping, the
				169	# `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	170	"response": { # The normal response of the operation in case of success. If the original
				171	# method returns no data on success, such as `Delete`, the response is
				172	# `google.protobuf.Empty`. If the original method is standard
				173	# `Get`/`Create`/`Update`, the response should be the resource. For other
				174	# methods, the response should have the type `XxxResponse`, where `Xxx`
				175	# is the original method name. For example, if the original method name
				176	# is `TakeSnapshot()`, the inferred response type is
				177	# `TakeSnapshotResponse`.
				178	"a_key": "", # Properties of the object. Contains field @type with type URL.
				179	},
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	180	"done": True or False, # If the value is `false`, it means the operation is still in progress.
				181	# If `true`, the operation is completed, and either `error` or `response` is
				182	# available.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	183	"metadata": { # Service-specific metadata associated with the operation. It typically
				184	# contains progress information and common metadata such as create time.
				185	# Some services might not provide such metadata. Any method that returns a
				186	# long-running operation should document the metadata type, if any.
				187	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	188	},
				189	}</pre>
				190	</div>
				191
				192	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	193	<code class="details" id="list">list(name, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	194	<pre>Lists operations that match the specified filter in the request. If the
				195	server doesn't support this method, it returns `UNIMPLEMENTED`.
				196
				197	NOTE: the `name` binding allows API services to override the binding
				198	to use different resource name schemes, such as `users/*/operations`. To
				199	override the binding, API services can add a binding such as
				200	`"/v1/{name=users/*}/operations"` to their service configuration.
				201	For backwards compatibility, the default name includes the operations
				202	collection id, however overriding users must ensure the name binding
				203	is the parent resource, without the operations collection id.
				204
				205	Args:
				206	name: string, The name of the operation's parent resource. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	207	filter: string, The standard list filter.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	208	pageToken: string, The standard list page token.
				209	pageSize: integer, The standard list page size.
				210	x__xgafv: string, V1 error format.
				211	Allowed values
				212	1 - v1 error format
				213	2 - v2 error format
				214
				215	Returns:
				216	An object of the form:
				217
				218	{ # The response message for Operations.ListOperations.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	219	"operations": [ # A list of operations that matches the specified filter in the request.
				220	{ # This resource represents a long-running operation that is the result of a
				221	# network API call.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	222	"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.
				223	# different programming environments, including REST APIs and RPC APIs. It is
				224	# used by [gRPC](https://github.com/grpc). Each `Status` message contains
				225	# three pieces of data: error code, error message, and error details.
				226	#
				227	# You can find out more about this error model and how to work with it in the
				228	# [API Design Guide](https://cloud.google.com/apis/design/errors).
				229	"details": [ # A list of messages that carry the error details. There is a common set of
				230	# message types for APIs to use.
				231	{
				232	"a_key": "", # Properties of the object. Contains field @type with type URL.
				233	},
				234	],
				235	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				236	"message": "A String", # A developer-facing error message, which should be in English. Any
				237	# user-facing error message should be localized and sent in the
				238	# google.rpc.Status.details field, or localized by the client.
				239	},
				240	"name": "A String", # The server-assigned name, which is only unique within the same service that
				241	# originally returns it. If you use the default HTTP mapping, the
				242	# `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	243	"response": { # The normal response of the operation in case of success. If the original
				244	# method returns no data on success, such as `Delete`, the response is
				245	# `google.protobuf.Empty`. If the original method is standard
				246	# `Get`/`Create`/`Update`, the response should be the resource. For other
				247	# methods, the response should have the type `XxxResponse`, where `Xxx`
				248	# is the original method name. For example, if the original method name
				249	# is `TakeSnapshot()`, the inferred response type is
				250	# `TakeSnapshotResponse`.
				251	"a_key": "", # Properties of the object. Contains field @type with type URL.
				252	},
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	253	"done": True or False, # If the value is `false`, it means the operation is still in progress.
				254	# If `true`, the operation is completed, and either `error` or `response` is
				255	# available.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	256	"metadata": { # Service-specific metadata associated with the operation. It typically
				257	# contains progress information and common metadata such as create time.
				258	# Some services might not provide such metadata. Any method that returns a
				259	# long-running operation should document the metadata type, if any.
				260	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	261	},
				262	},
				263	],
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	264	"nextPageToken": "A String", # The standard List next-page token.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	265	}</pre>
				266	</div>
				267
				268	<div class="method">
				269	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				270	<pre>Retrieves the next page of results.
				271
				272	Args:
				273	previous_request: The request for the previous page. (required)
				274	previous_response: The response from the request for the previous page. (required)
				275
				276	Returns:
				277	A request object that you can call 'execute()' on to request the next
				278	page. Returns None if there are no more items in the collection.
				279	</pre>
				280	</div>
				281
				282	</body></html>