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

blob: d5d632adff2694e792393fff914ceb95d55fdebf [file] [log] [blame]

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