Blame - docs/dyn/file_v1beta1.projects.locations.instances.html - platform/external/python/google-api-python-client

blob: 5c061e1051267ac623e1254cb252313d054a388c [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="file_v1beta1.html">Cloud Filestore API</a> . <a href="file_v1beta1.projects.html">projects</a> . <a href="file_v1beta1.projects.locations.html">locations</a> . <a href="file_v1beta1.projects.locations.instances.html">instances</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	81	<code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	82	<p class="firstline">Creates an instance. When creating from a backup, the capacity of the new instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	83	<p class="toc_element">
				84	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Deletes an instance.</p>
				86	<p class="toc_element">
				87	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				88	<p class="firstline">Gets the details of a specific instance.</p>
				89	<p class="toc_element">
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	90	<code><a href="#list">list(parent, filter=None, pageToken=None, orderBy=None, pageSize=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	91	<p class="firstline">Lists all instances in a project for either a specified location or for all locations.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	96	<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]	97	<p class="firstline">Updates the settings of a specific instance.</p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	98	<p class="toc_element">
				99	<code><a href="#restore">restore(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	100	<p class="firstline">Restores an existing instance's file share from a backup. The instance's file share capacity will be set to the backup's capacity or the minimum capacity of the tier, whichever is larger.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	101	<h3>Method Details</h3>
				102	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	103	<code class="details" id="close">close()</code>
				104	<pre>Close httplib2 connections.</pre>
				105	</div>
				106
				107	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	108	<code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	109	<pre>Creates an instance. When creating from a backup, the capacity of the new instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	110
				111	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	112	parent: string, Required. The instance's project and location, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example us-west1-b. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	113	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	114	The object takes the form of:
				115
				116	{ # A Cloud Filestore instance.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	117	"createTime": "A String", # Output only. The time when the instance was created.
				118	"tier": "A String", # The service tier of the instance.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	119	"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	120	"description": "A String", # The description of the instance (2048 characters or less).
				121	"state": "A String", # Output only. The instance state.
				122	"name": "A String", # Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	123	"networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
				124	{ # Network configuration for the instance.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	125	"network": "A String", # The name of the Google Compute Engine [VPC network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	126	"ipAddresses": [ # Output only. IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 7}:{block 8}.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	127	"A String",
				128	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	129	"modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	130	"A String",
				131	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	132	"reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	133	},
				134	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	135	"labels": { # Resource labels to represent user provided metadata.
				136	"a_key": "A String",
				137	},
				138	"statusMessage": "A String", # Output only. Additional information about the instance state, if available.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	139	"fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.
				140	{ # File share configuration for the instance.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	141	"nfsExportOptions": [ # Nfs Export Options. There is a limit of 10 export options per file share.
				142	{ # NFS export options specifications.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	143	"anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	144	"ipRanges": [ # List of either an IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format {octet 1}.{octet 2}.{octet 3}.{octet 4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
				145	"A String",
				146	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	147	"accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	148	"anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	149	"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	150	},
				151	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	152	"name": "A String", # The name of the file share (must be 16 characters or less).
				153	"sourceBackup": "A String", # The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.
				154	"capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	155	},
				156	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	157	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	158
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	159	instanceId: string, Required. The ID of the instance to create. The ID must be unique within the specified project and location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	160	x__xgafv: string, V1 error format.
				161	Allowed values
				162	1 - v1 error format
				163	2 - v2 error format
				164
				165	Returns:
				166	An object of the form:
				167
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	168	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	169	"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}`.
				170	"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.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	171	"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`.
				172	"a_key": "", # Properties of the object. Contains field @type with type URL.
				173	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	174	"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.
				175	"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	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	176	{
				177	"a_key": "", # Properties of the object. Contains field @type with type URL.
				178	},
				179	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	180	"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.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	181	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	182	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	183	"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.
				184	"a_key": "", # Properties of the object. Contains field @type with type URL.
				185	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	186	}</pre>
				187	</div>
				188
				189	<div class="method">
				190	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				191	<pre>Deletes an instance.
				192
				193	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	194	name: string, Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id} (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	195	x__xgafv: string, V1 error format.
				196	Allowed values
				197	1 - v1 error format
				198	2 - v2 error format
				199
				200	Returns:
				201	An object of the form:
				202
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	203	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	204	"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}`.
				205	"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.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	206	"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`.
				207	"a_key": "", # Properties of the object. Contains field @type with type URL.
				208	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	209	"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.
				210	"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	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	211	{
				212	"a_key": "", # Properties of the object. Contains field @type with type URL.
				213	},
				214	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	215	"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.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	216	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	217	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	218	"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.
				219	"a_key": "", # Properties of the object. Contains field @type with type URL.
				220	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	221	}</pre>
				222	</div>
				223
				224	<div class="method">
				225	<code class="details" id="get">get(name, x__xgafv=None)</code>
				226	<pre>Gets the details of a specific instance.
				227
				228	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	229	name: string, Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	230	x__xgafv: string, V1 error format.
				231	Allowed values
				232	1 - v1 error format
				233	2 - v2 error format
				234
				235	Returns:
				236	An object of the form:
				237
				238	{ # A Cloud Filestore instance.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	239	"createTime": "A String", # Output only. The time when the instance was created.
				240	"tier": "A String", # The service tier of the instance.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	241	"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	242	"description": "A String", # The description of the instance (2048 characters or less).
				243	"state": "A String", # Output only. The instance state.
				244	"name": "A String", # Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	245	"networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
				246	{ # Network configuration for the instance.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	247	"network": "A String", # The name of the Google Compute Engine [VPC network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	248	"ipAddresses": [ # Output only. IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 7}:{block 8}.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	249	"A String",
				250	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	251	"modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	252	"A String",
				253	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	254	"reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	255	},
				256	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	257	"labels": { # Resource labels to represent user provided metadata.
				258	"a_key": "A String",
				259	},
				260	"statusMessage": "A String", # Output only. Additional information about the instance state, if available.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	261	"fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.
				262	{ # File share configuration for the instance.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	263	"nfsExportOptions": [ # Nfs Export Options. There is a limit of 10 export options per file share.
				264	{ # NFS export options specifications.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	265	"anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	266	"ipRanges": [ # List of either an IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format {octet 1}.{octet 2}.{octet 3}.{octet 4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
				267	"A String",
				268	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	269	"accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	270	"anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	271	"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	272	},
				273	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	274	"name": "A String", # The name of the file share (must be 16 characters or less).
				275	"sourceBackup": "A String", # The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.
				276	"capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	277	},
				278	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	279	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	280	</div>
				281
				282	<div class="method">
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	283	<code class="details" id="list">list(parent, filter=None, pageToken=None, orderBy=None, pageSize=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	284	<pre>Lists all instances in a project for either a specified location or for all locations.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	285
				286	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	287	parent: string, Required. The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example us-west1-b. To retrieve instance information for all locations, use "-" for the {location} value. (required)
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	288	filter: string, List filter.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	289	pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request.
				290	orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
				291	pageSize: integer, The maximum number of items to return.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	292	x__xgafv: string, V1 error format.
				293	Allowed values
				294	1 - v1 error format
				295	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	296
				297	Returns:
				298	An object of the form:
				299
				300	{ # ListInstancesResponse is the result of ListInstancesRequest.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	301	"instances": [ # A list of instances in the project for the specified location. If the {location} value in the request is "-", the response contains a list of instances from all locations. If any location is unreachable, the response will only return instances in reachable locations and the "unreachable" field will be populated with a list of unreachable locations.
				302	{ # A Cloud Filestore instance.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	303	"createTime": "A String", # Output only. The time when the instance was created.
				304	"tier": "A String", # The service tier of the instance.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	305	"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	306	"description": "A String", # The description of the instance (2048 characters or less).
				307	"state": "A String", # Output only. The instance state.
				308	"name": "A String", # Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	309	"networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
				310	{ # Network configuration for the instance.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	311	"network": "A String", # The name of the Google Compute Engine [VPC network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	312	"ipAddresses": [ # Output only. IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 7}:{block 8}.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	313	"A String",
				314	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	315	"modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	316	"A String",
				317	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	318	"reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	319	},
				320	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	321	"labels": { # Resource labels to represent user provided metadata.
				322	"a_key": "A String",
				323	},
				324	"statusMessage": "A String", # Output only. Additional information about the instance state, if available.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	325	"fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.
				326	{ # File share configuration for the instance.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	327	"nfsExportOptions": [ # Nfs Export Options. There is a limit of 10 export options per file share.
				328	{ # NFS export options specifications.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	329	"anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	330	"ipRanges": [ # List of either an IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format {octet 1}.{octet 2}.{octet 3}.{octet 4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
				331	"A String",
				332	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	333	"accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	334	"anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	335	"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	336	},
				337	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	338	"name": "A String", # The name of the file share (must be 16 characters or less).
				339	"sourceBackup": "A String", # The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.
				340	"capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	341	},
				342	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	343	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	344	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	345	"nextPageToken": "A String", # The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	346	"unreachable": [ # Locations that could not be reached.
				347	"A String",
				348	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	349	}</pre>
				350	</div>
				351
				352	<div class="method">
				353	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				354	<pre>Retrieves the next page of results.
				355
				356	Args:
				357	previous_request: The request for the previous page. (required)
				358	previous_response: The response from the request for the previous page. (required)
				359
				360	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	361	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	362	page. Returns None if there are no more items in the collection.
				363	</pre>
				364	</div>
				365
				366	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	367	<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]	368	<pre>Updates the settings of a specific instance.
				369
				370	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	371	name: string, Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	372	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	373	The object takes the form of:
				374
				375	{ # A Cloud Filestore instance.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	376	"createTime": "A String", # Output only. The time when the instance was created.
				377	"tier": "A String", # The service tier of the instance.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	378	"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	379	"description": "A String", # The description of the instance (2048 characters or less).
				380	"state": "A String", # Output only. The instance state.
				381	"name": "A String", # Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	382	"networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
				383	{ # Network configuration for the instance.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	384	"network": "A String", # The name of the Google Compute Engine [VPC network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	385	"ipAddresses": [ # Output only. IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 7}:{block 8}.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	386	"A String",
				387	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	388	"modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	389	"A String",
				390	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	391	"reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	392	},
				393	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	394	"labels": { # Resource labels to represent user provided metadata.
				395	"a_key": "A String",
				396	},
				397	"statusMessage": "A String", # Output only. Additional information about the instance state, if available.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	398	"fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.
				399	{ # File share configuration for the instance.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	400	"nfsExportOptions": [ # Nfs Export Options. There is a limit of 10 export options per file share.
				401	{ # NFS export options specifications.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	402	"anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	403	"ipRanges": [ # List of either an IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format {octet 1}.{octet 2}.{octet 3}.{octet 4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
				404	"A String",
				405	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	406	"accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	407	"anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	408	"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	409	},
				410	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	411	"name": "A String", # The name of the file share (must be 16 characters or less).
				412	"sourceBackup": "A String", # The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.
				413	"capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	414	},
				415	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	416	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	417
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	418	updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * "description" * "file_shares" * "labels"
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	419	x__xgafv: string, V1 error format.
				420	Allowed values
				421	1 - v1 error format
				422	2 - v2 error format
				423
				424	Returns:
				425	An object of the form:
				426
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	427	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	428	"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}`.
				429	"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.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	430	"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`.
				431	"a_key": "", # Properties of the object. Contains field @type with type URL.
				432	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	433	"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.
				434	"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	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	435	{
				436	"a_key": "", # Properties of the object. Contains field @type with type URL.
				437	},
				438	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	439	"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.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	440	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	441	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	442	"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.
				443	"a_key": "", # Properties of the object. Contains field @type with type URL.
				444	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	445	}</pre>
				446	</div>
				447
				448	<div class="method">
				449	<code class="details" id="restore">restore(name, body=None, x__xgafv=None)</code>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	450	<pre>Restores an existing instance's file share from a backup. The instance's file share capacity will be set to the backup's capacity or the minimum capacity of the tier, whichever is larger.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	451
				452	Args:
				453	name: string, Required. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}. (required)
				454	body: object, The request body.
				455	The object takes the form of:
				456
				457	{ # RestoreInstanceRequest restores an existing instances's file share from a snapshot or backup.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	458	"sourceBackup": "A String", # The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	459	"fileShare": "A String", # Required. Name of the file share in the Cloud Filestore instance that the snapshot is being restored to.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	460	"sourceSnapshot": "A String", # The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/snapshots/{snapshot_id}.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	461	}
				462
				463	x__xgafv: string, V1 error format.
				464	Allowed values
				465	1 - v1 error format
				466	2 - v2 error format
				467
				468	Returns:
				469	An object of the form:
				470
				471	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	472	"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}`.
				473	"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.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	474	"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`.
				475	"a_key": "", # Properties of the object. Contains field @type with type URL.
				476	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	477	"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.
				478	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				479	{
				480	"a_key": "", # Properties of the object. Contains field @type with type URL.
				481	},
				482	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	483	"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.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	484	"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]	485	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	486	"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.
				487	"a_key": "", # Properties of the object. Contains field @type with type URL.
				488	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	489	}</pre>
				490	</div>
				491
				492	</body></html>