Blame - docs/dyn/cloudshell_v1alpha1.users.environments.html - platform/external/python/google-api-python-client

blob: 669f8f5d15b3af22e1e36fb1b4e6c5c2e07496e0 [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="cloudshell_v1alpha1.html">Cloud Shell API</a> . <a href="cloudshell_v1alpha1.users.html">users</a> . <a href="cloudshell_v1alpha1.users.environments.html">environments</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="cloudshell_v1alpha1.users.environments.publicKeys.html">publicKeys()</a></code>
				79	</p>
				80	<p class="firstline">Returns the publicKeys Resource.</p>
				81
				82	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	83	<code><a href="#authorize">authorize(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	84	<p class="firstline">Sends OAuth credentials to a running environment on behalf of a user. When this completes, the environment will be authorized to run various Google Cloud command line tools without requiring the user to manually authenticate.</p>
				85	<p class="toc_element">
				86	<code><a href="#close">close()</a></code></p>
				87	<p class="firstline">Close httplib2 connections.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	88	<p class="toc_element">
				89	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				90	<p class="firstline">Gets an environment. Returns NOT_FOUND if the environment does not exist.</p>
				91	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	92	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	93	<p class="firstline">Updates an existing environment.</p>
				94	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	95	<code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	96	<p class="firstline">Starts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the environment to start by polling this operation via GetOperation. Once the environment has finished starting and is ready to accept connections, the operation will contain a StartEnvironmentResponse in its response field.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	97	<h3>Method Details</h3>
				98	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	99	<code class="details" id="authorize">authorize(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	100	<pre>Sends OAuth credentials to a running environment on behalf of a user. When this completes, the environment will be authorized to run various Google Cloud command line tools without requiring the user to manually authenticate.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	101
				102	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	103	name: string, Name of the resource that should receive the credentials, for example `users/me/environments/default` or `users/someone@example.com/environments/default`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	104	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	105	The object takes the form of:
				106
				107	{ # Request message for AuthorizeEnvironment.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	108	"accessToken": "A String", # The OAuth access token that should be sent to the environment.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	109	"expireTime": "A String", # The time when the credentials expire. If not set, defaults to one hour from when the server received the request.
				110	"idToken": "A String", # The OAuth ID token that should be sent to the environment.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	111	}
				112
				113	x__xgafv: string, V1 error format.
				114	Allowed values
				115	1 - v1 error format
				116	2 - v2 error format
				117
				118	Returns:
				119	An object of the form:
				120
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	121	{ # 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 `{}`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	122	}</pre>
				123	</div>
				124
				125	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	126	<code class="details" id="close">close()</code>
				127	<pre>Close httplib2 connections.</pre>
				128	</div>
				129
				130	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	131	<code class="details" id="get">get(name, x__xgafv=None)</code>
				132	<pre>Gets an environment. Returns NOT_FOUND if the environment does not exist.
				133
				134	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	135	name: string, Name of the requested resource, for example `users/me/environments/default` or `users/someone@example.com/environments/default`. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	136	x__xgafv: string, V1 error format.
				137	Allowed values
				138	1 - v1 error format
				139	2 - v2 error format
				140
				141	Returns:
				142	An object of the form:
				143
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	144	{ # A Cloud Shell environment, which is defined as the combination of a Docker image specifying what is installed on the environment and a home directory containing the user's data that will remain across sessions. Each user has a single environment with the ID "default".
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	145	"vmSizeExpireTime": "A String", # Output only. The time when the Environment will expire back to the default VM size.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	146	"sshPort": 42, # Output only. Port to which clients can connect to initiate SSH sessions with the environment.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	147	"publicKeys": [ # Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the CreatePublicKey and DeletePublicKey methods.
				148	{ # A public SSH key, corresponding to a private SSH key held by the client.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	149	"key": "A String", # Required. Content of this key.
				150	"name": "A String", # Output only. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`. `{owner_email}` is the email address of the user to whom the key belongs. `{environment_id}` is the identifier of the environment to which the key grants access. `{key_id}` is the unique identifier of the key. For example, `users/someone@example.com/environments/default/publicKeys/myKey`.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	151	"format": "A String", # Required. Format of this key's content.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	152	},
				153	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	154	"sshUsername": "A String", # Output only. Username that clients should use when initiating SSH sessions with the environment.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	155	"id": "A String", # Output only. The environment's identifier, unique among the user's environments.
				156	"size": "A String", # Indicates the size of the backing VM running the environment. If set to something other than DEFAULT, it will be reverted to the default VM size after vm_size_expire_time.
				157	"sshHost": "A String", # Output only. Host to which clients can connect to initiate SSH sessions with the environment.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	158	"webPorts": [ # Output only. Ports to which clients can connect to initiate HTTPS or WSS connections with the environment.
				159	42,
				160	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	161	"dockerImage": "A String", # Required. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest".
				162	"state": "A String", # Output only. Current execution state of this environment.
				163	"name": "A String", # Output only. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the email address of the user to whom this environment belongs, and `{environment_id}` is the identifier of this environment. For example, `users/someone@example.com/environments/default`.
				164	"webHost": "A String", # Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	165	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	166	</div>
				167
				168	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	169	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	170	<pre>Updates an existing environment.
				171
				172	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	173	name: string, Name of the resource to be updated, for example `users/me/environments/default` or `users/someone@example.com/environments/default`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	174	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	175	The object takes the form of:
				176
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	177	{ # A Cloud Shell environment, which is defined as the combination of a Docker image specifying what is installed on the environment and a home directory containing the user's data that will remain across sessions. Each user has a single environment with the ID "default".
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	178	"vmSizeExpireTime": "A String", # Output only. The time when the Environment will expire back to the default VM size.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	179	"sshPort": 42, # Output only. Port to which clients can connect to initiate SSH sessions with the environment.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	180	"publicKeys": [ # Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the CreatePublicKey and DeletePublicKey methods.
				181	{ # A public SSH key, corresponding to a private SSH key held by the client.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	182	"key": "A String", # Required. Content of this key.
				183	"name": "A String", # Output only. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`. `{owner_email}` is the email address of the user to whom the key belongs. `{environment_id}` is the identifier of the environment to which the key grants access. `{key_id}` is the unique identifier of the key. For example, `users/someone@example.com/environments/default/publicKeys/myKey`.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	184	"format": "A String", # Required. Format of this key's content.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	185	},
				186	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	187	"sshUsername": "A String", # Output only. Username that clients should use when initiating SSH sessions with the environment.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	188	"id": "A String", # Output only. The environment's identifier, unique among the user's environments.
				189	"size": "A String", # Indicates the size of the backing VM running the environment. If set to something other than DEFAULT, it will be reverted to the default VM size after vm_size_expire_time.
				190	"sshHost": "A String", # Output only. Host to which clients can connect to initiate SSH sessions with the environment.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	191	"webPorts": [ # Output only. Ports to which clients can connect to initiate HTTPS or WSS connections with the environment.
				192	42,
				193	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	194	"dockerImage": "A String", # Required. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest".
				195	"state": "A String", # Output only. Current execution state of this environment.
				196	"name": "A String", # Output only. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the email address of the user to whom this environment belongs, and `{environment_id}` is the identifier of this environment. For example, `users/someone@example.com/environments/default`.
				197	"webHost": "A String", # Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	198	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	199
				200	updateMask: string, Mask specifying which fields in the environment should be updated.
				201	x__xgafv: string, V1 error format.
				202	Allowed values
				203	1 - v1 error format
				204	2 - v2 error format
				205
				206	Returns:
				207	An object of the form:
				208
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	209	{ # A Cloud Shell environment, which is defined as the combination of a Docker image specifying what is installed on the environment and a home directory containing the user's data that will remain across sessions. Each user has a single environment with the ID "default".
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	210	"vmSizeExpireTime": "A String", # Output only. The time when the Environment will expire back to the default VM size.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	211	"sshPort": 42, # Output only. Port to which clients can connect to initiate SSH sessions with the environment.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	212	"publicKeys": [ # Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the CreatePublicKey and DeletePublicKey methods.
				213	{ # A public SSH key, corresponding to a private SSH key held by the client.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	214	"key": "A String", # Required. Content of this key.
				215	"name": "A String", # Output only. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`. `{owner_email}` is the email address of the user to whom the key belongs. `{environment_id}` is the identifier of the environment to which the key grants access. `{key_id}` is the unique identifier of the key. For example, `users/someone@example.com/environments/default/publicKeys/myKey`.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	216	"format": "A String", # Required. Format of this key's content.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	217	},
				218	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	219	"sshUsername": "A String", # Output only. Username that clients should use when initiating SSH sessions with the environment.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	220	"id": "A String", # Output only. The environment's identifier, unique among the user's environments.
				221	"size": "A String", # Indicates the size of the backing VM running the environment. If set to something other than DEFAULT, it will be reverted to the default VM size after vm_size_expire_time.
				222	"sshHost": "A String", # Output only. Host to which clients can connect to initiate SSH sessions with the environment.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	223	"webPorts": [ # Output only. Ports to which clients can connect to initiate HTTPS or WSS connections with the environment.
				224	42,
				225	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	226	"dockerImage": "A String", # Required. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest".
				227	"state": "A String", # Output only. Current execution state of this environment.
				228	"name": "A String", # Output only. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the email address of the user to whom this environment belongs, and `{environment_id}` is the identifier of this environment. For example, `users/someone@example.com/environments/default`.
				229	"webHost": "A String", # Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	230	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	231	</div>
				232
				233	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	234	<code class="details" id="start">start(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	235	<pre>Starts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the environment to start by polling this operation via GetOperation. Once the environment has finished starting and is ready to accept connections, the operation will contain a StartEnvironmentResponse in its response field.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	236
				237	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	238	name: string, Name of the resource that should be started, for example `users/me/environments/default` or `users/someone@example.com/environments/default`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	239	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	240	The object takes the form of:
				241
				242	{ # Request message for StartEnvironment.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	243	"publicKeys": [ # Public keys that should be added to the environment before it is started.
				244	{ # A public SSH key, corresponding to a private SSH key held by the client.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	245	"key": "A String", # Required. Content of this key.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	246	"name": "A String", # Output only. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`. `{owner_email}` is the email address of the user to whom the key belongs. `{environment_id}` is the identifier of the environment to which the key grants access. `{key_id}` is the unique identifier of the key. For example, `users/someone@example.com/environments/default/publicKeys/myKey`.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	247	"format": "A String", # Required. Format of this key's content.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	248	},
				249	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	250	"accessToken": "A String", # The initial access token passed to the environment. If this is present and valid, the environment will be pre-authenticated with gcloud so that the user can run gcloud commands in Cloud Shell without having to log in. This code can be updated later by calling AuthorizeEnvironment.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	251	}
				252
				253	x__xgafv: string, V1 error format.
				254	Allowed values
				255	1 - v1 error format
				256	2 - v2 error format
				257
				258	Returns:
				259	An object of the form:
				260
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	261	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	262	"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`.
				263	"a_key": "", # Properties of the object. Contains field @type with type URL.
				264	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	265	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	266	"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.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	267	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	268	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	269	{
				270	"a_key": "", # Properties of the object. Contains field @type with type URL.
				271	},
				272	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	273	"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.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	274	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	275	"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.
				276	"a_key": "", # Properties of the object. Contains field @type with type URL.
				277	},
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	278	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	279	}</pre>
				280	</div>
				281
				282	</body></html>