Blame - docs/dyn/dialogflow_v3beta1.projects.locations.agents.html - platform/external/python/google-api-python-client

blob: a05cb95ed708612f3e5de5822debeb0884847343 [file] [log] [blame]

Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -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_v3beta1.html">Dialogflow API</a> . <a href="dialogflow_v3beta1.projects.html">projects</a> . <a href="dialogflow_v3beta1.projects.locations.html">locations</a> . <a href="dialogflow_v3beta1.projects.locations.agents.html">agents</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="dialogflow_v3beta1.projects.locations.agents.entityTypes.html">entityTypes()</a></code>
				79	</p>
				80	<p class="firstline">Returns the entityTypes Resource.</p>
				81
				82	<p class="toc_element">
				83	<code><a href="dialogflow_v3beta1.projects.locations.agents.environments.html">environments()</a></code>
				84	</p>
				85	<p class="firstline">Returns the environments Resource.</p>
				86
				87	<p class="toc_element">
				88	<code><a href="dialogflow_v3beta1.projects.locations.agents.flows.html">flows()</a></code>
				89	</p>
				90	<p class="firstline">Returns the flows Resource.</p>
				91
				92	<p class="toc_element">
				93	<code><a href="dialogflow_v3beta1.projects.locations.agents.intents.html">intents()</a></code>
				94	</p>
				95	<p class="firstline">Returns the intents Resource.</p>
				96
				97	<p class="toc_element">
				98	<code><a href="dialogflow_v3beta1.projects.locations.agents.sessions.html">sessions()</a></code>
				99	</p>
				100	<p class="firstline">Returns the sessions Resource.</p>
				101
				102	<p class="toc_element">
				103	<code><a href="dialogflow_v3beta1.projects.locations.agents.webhooks.html">webhooks()</a></code>
				104	</p>
				105	<p class="firstline">Returns the webhooks Resource.</p>
				106
				107	<p class="toc_element">
				108	<code><a href="#close">close()</a></code></p>
				109	<p class="firstline">Close httplib2 connections.</p>
				110	<p class="toc_element">
				111	<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
				112	<p class="firstline">Creates an agent in the specified location.</p>
				113	<p class="toc_element">
				114	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				115	<p class="firstline">Deletes the specified agent.</p>
				116	<p class="toc_element">
				117	<code><a href="#export">export(name, body=None, x__xgafv=None)</a></code></p>
				118	<p class="firstline">Exports the specified agent to a ZIP file.</p>
				119	<p class="toc_element">
				120	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				121	<p class="firstline">Retrieves the specified agent.</p>
				122	<p class="toc_element">
				123	<code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
				124	<p class="firstline">Returns the list of all agents in the specified location.</p>
				125	<p class="toc_element">
				126	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				127	<p class="firstline">Retrieves the next page of results.</p>
				128	<p class="toc_element">
				129	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				130	<p class="firstline">Updates the specified agent.</p>
				131	<p class="toc_element">
				132	<code><a href="#restore">restore(name, body=None, x__xgafv=None)</a></code></p>
				133	<p class="firstline">Restores the specified agent from a ZIP file. Note that all existing intents, intent routes, entity types, pages and webhooks in the agent will be deleted.</p>
				134	<h3>Method Details</h3>
				135	<div class="method">
				136	<code class="details" id="close">close()</code>
				137	<pre>Close httplib2 connections.</pre>
				138	</div>
				139
				140	<div class="method">
				141	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
				142	<pre>Creates an agent in the specified location.
				143
				144	Args:
				145	parent: string, Required. The location to create a agent for. Format: `projects//locations/`. (required)
				146	body: object, The request body.
				147	The object takes the form of:
				148
				149	{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows..
				150	"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent.
				151	"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
				152	"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
				153	},
				154	"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
				155	"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				156	"avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
				157	"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
				158	"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
				159	"startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.
				160	"defaultLanguageCode": "A String", # Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
				161	"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
				162	}
				163
				164	x__xgafv: string, V1 error format.
				165	Allowed values
				166	1 - v1 error format
				167	2 - v2 error format
				168
				169	Returns:
				170	An object of the form:
				171
				172	{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows..
				173	"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent.
				174	"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
				175	"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
				176	},
				177	"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
				178	"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				179	"avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
				180	"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
				181	"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
				182	"startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.
				183	"defaultLanguageCode": "A String", # Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
				184	"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
				185	}</pre>
				186	</div>
				187
				188	<div class="method">
				189	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				190	<pre>Deletes the specified agent.
				191
				192	Args:
				193	name: string, Required. The name of the agent to delete. Format: `projects//locations//agents/`. (required)
				194	x__xgafv: string, V1 error format.
				195	Allowed values
				196	1 - v1 error format
				197	2 - v2 error format
				198
				199	Returns:
				200	An object of the form:
				201
				202	{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
				203	}</pre>
				204	</div>
				205
				206	<div class="method">
				207	<code class="details" id="export">export(name, body=None, x__xgafv=None)</code>
				208	<pre>Exports the specified agent to a ZIP file.
				209
				210	Args:
				211	name: string, Required. The name of the agent to export. Format: `projects//locations//agents/`. (required)
				212	body: object, The request body.
				213	The object takes the form of:
				214
				215	{ # The request message for Agents.ExportAgent.
				216	"agentUri": "A String", # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the agent to. The format of this URI must be `gs:///`. If left unspecified, the serialized agent is returned inline.
				217	}
				218
				219	x__xgafv: string, V1 error format.
				220	Allowed values
				221	1 - v1 error format
				222	2 - v2 error format
				223
				224	Returns:
				225	An object of the form:
				226
				227	{ # This resource represents a long-running operation that is the result of a network API call.
				228	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
				229	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
				230	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				231	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
				232	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				233	{
				234	"a_key": "", # Properties of the object. Contains field @type with type URL.
				235	},
				236	],
				237	},
				238	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				239	"a_key": "", # Properties of the object. Contains field @type with type URL.
				240	},
				241	"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
				242	"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
				243	"a_key": "", # Properties of the object. Contains field @type with type URL.
				244	},
				245	}</pre>
				246	</div>
				247
				248	<div class="method">
				249	<code class="details" id="get">get(name, x__xgafv=None)</code>
				250	<pre>Retrieves the specified agent.
				251
				252	Args:
				253	name: string, Required. The name of the agent. Format: `projects//locations//agents/`. (required)
				254	x__xgafv: string, V1 error format.
				255	Allowed values
				256	1 - v1 error format
				257	2 - v2 error format
				258
				259	Returns:
				260	An object of the form:
				261
				262	{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows..
				263	"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent.
				264	"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
				265	"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
				266	},
				267	"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
				268	"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				269	"avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
				270	"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
				271	"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
				272	"startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.
				273	"defaultLanguageCode": "A String", # Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
				274	"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
				275	}</pre>
				276	</div>
				277
				278	<div class="method">
				279	<code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
				280	<pre>Returns the list of all agents in the specified location.
				281
				282	Args:
				283	parent: string, Required. The location to list all agents for. Format: `projects//locations/`. (required)
				284	pageToken: string, The next_page_token value returned from a previous list request.
				285	pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000.
				286	x__xgafv: string, V1 error format.
				287	Allowed values
				288	1 - v1 error format
				289	2 - v2 error format
				290
				291	Returns:
				292	An object of the form:
				293
				294	{ # The response message for Agents.ListAgents.
				295	"agents": [ # The list of agents. There will be a maximum number of items returned based on the page_size field in the request.
				296	{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows..
				297	"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent.
				298	"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
				299	"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
				300	},
				301	"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
				302	"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				303	"avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
				304	"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
				305	"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
				306	"startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.
				307	"defaultLanguageCode": "A String", # Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
				308	"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
				309	},
				310	],
				311	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
				312	}</pre>
				313	</div>
				314
				315	<div class="method">
				316	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				317	<pre>Retrieves the next page of results.
				318
				319	Args:
				320	previous_request: The request for the previous page. (required)
				321	previous_response: The response from the request for the previous page. (required)
				322
				323	Returns:
				324	A request object that you can call 'execute()' on to request the next
				325	page. Returns None if there are no more items in the collection.
				326	</pre>
				327	</div>
				328
				329	<div class="method">
				330	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				331	<pre>Updates the specified agent.
				332
				333	Args:
				334	name: string, The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`. (required)
				335	body: object, The request body.
				336	The object takes the form of:
				337
				338	{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows..
				339	"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent.
				340	"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
				341	"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
				342	},
				343	"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
				344	"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				345	"avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
				346	"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
				347	"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
				348	"startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.
				349	"defaultLanguageCode": "A String", # Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
				350	"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
				351	}
				352
				353	updateMask: string, The mask to control which fields get updated. If the mask is not present, all fields will be updated.
				354	x__xgafv: string, V1 error format.
				355	Allowed values
				356	1 - v1 error format
				357	2 - v2 error format
				358
				359	Returns:
				360	An object of the form:
				361
				362	{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows..
				363	"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent.
				364	"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
				365	"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
				366	},
				367	"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
				368	"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
				369	"avatarUri": "A String", # The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
				370	"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
				371	"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
				372	"startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.
				373	"defaultLanguageCode": "A String", # Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
				374	"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
				375	}</pre>
				376	</div>
				377
				378	<div class="method">
				379	<code class="details" id="restore">restore(name, body=None, x__xgafv=None)</code>
				380	<pre>Restores the specified agent from a ZIP file. Note that all existing intents, intent routes, entity types, pages and webhooks in the agent will be deleted.
				381
				382	Args:
				383	name: string, Required. The name of the agent to restore into. Format: `projects//locations//agents/`. (required)
				384	body: object, The request body.
				385	The object takes the form of:
				386
				387	{ # The request message for Agents.RestoreAgent.
				388	"agentUri": "A String", # The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to restore agent from. The format of this URI must be `gs:///`.
				389	"agentContent": "A String", # Uncompressed raw byte content for agent.
				390	}
				391
				392	x__xgafv: string, V1 error format.
				393	Allowed values
				394	1 - v1 error format
				395	2 - v2 error format
				396
				397	Returns:
				398	An object of the form:
				399
				400	{ # This resource represents a long-running operation that is the result of a network API call.
				401	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
				402	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
				403	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				404	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
				405	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				406	{
				407	"a_key": "", # Properties of the object. Contains field @type with type URL.
				408	},
				409	],
				410	},
				411	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				412	"a_key": "", # Properties of the object. Contains field @type with type URL.
				413	},
				414	"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
				415	"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
				416	"a_key": "", # Properties of the object. Contains field @type with type URL.
				417	},
				418	}</pre>
				419	</div>
				420
				421	</body></html>