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

blob: 61e77b220f8c2e0cd20333ddb0ba0018f651f751 [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	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	90	<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=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>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	100	<p class="firstline">Restores an existing instance's file share from a backup. The capacity of the 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]	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	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	117	"createTime": "A String", # Output only. The time when the instance was created.
				118	"description": "A String", # The description of the instance (2048 characters or less).
				119	"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	120	"fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.
				121	{ # File share configuration for the instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	122	"capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	123	"name": "A String", # The name of the file share (must be 16 characters or less).
				124	"nfsExportOptions": [ # Nfs Export Options. There is a limit of 10 export options per file share.
				125	{ # NFS export options specifications.
				126	"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.
				127	"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.
				128	"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.
				129	"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.
				130	"A String",
				131	],
				132	"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.
				133	},
				134	],
				135	"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.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	136	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	137	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	138	"labels": { # Resource labels to represent user provided metadata.
				139	"a_key": "A String",
				140	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	141	"name": "A String", # Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.
				142	"networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
				143	{ # Network configuration for the instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	144	"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}.
				145	"A String",
				146	],
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	147	"modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
				148	"A String",
				149	],
				150	"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	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	151	"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.
				152	},
				153	],
yoshi-code-bot	cec4393	2021-04-24 08:36:03 -0700	[diff] [blame^]	154	"satisfiesPzs": True or False, # Output only. Reserved for future use.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	155	"state": "A String", # Output only. The instance state.
				156	"statusMessage": "A String", # Output only. Additional information about the instance state, if available.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	157	"tier": "A String", # The service tier of the instance.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	158	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	159
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	160	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]	161	x__xgafv: string, V1 error format.
				162	Allowed values
				163	1 - v1 error format
				164	2 - v2 error format
				165
				166	Returns:
				167	An object of the form:
				168
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	169	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	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.
				171	"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.
				172	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				173	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				174	{
				175	"a_key": "", # Properties of the object. Contains field @type with type URL.
				176	},
				177	],
				178	"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.
				179	},
				180	"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.
				181	"a_key": "", # Properties of the object. Contains field @type with type URL.
				182	},
				183	"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}`.
				184	"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`.
				185	"a_key": "", # Properties of the object. Contains field @type with type URL.
				186	},
				187	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	188	</div>
				189
				190	<div class="method">
				191	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				192	<pre>Deletes an instance.
				193
				194	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	195	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]	196	x__xgafv: string, V1 error format.
				197	Allowed values
				198	1 - v1 error format
				199	2 - v2 error format
				200
				201	Returns:
				202	An object of the form:
				203
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	204	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	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.
				206	"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.
				207	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				208	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				209	{
				210	"a_key": "", # Properties of the object. Contains field @type with type URL.
				211	},
				212	],
				213	"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.
				214	},
				215	"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.
				216	"a_key": "", # Properties of the object. Contains field @type with type URL.
				217	},
				218	"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}`.
				219	"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`.
				220	"a_key": "", # Properties of the object. Contains field @type with type URL.
				221	},
				222	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	223	</div>
				224
				225	<div class="method">
				226	<code class="details" id="get">get(name, x__xgafv=None)</code>
				227	<pre>Gets the details of a specific instance.
				228
				229	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	230	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]	231	x__xgafv: string, V1 error format.
				232	Allowed values
				233	1 - v1 error format
				234	2 - v2 error format
				235
				236	Returns:
				237	An object of the form:
				238
				239	{ # A Cloud Filestore instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	240	"createTime": "A String", # Output only. The time when the instance was created.
				241	"description": "A String", # The description of the instance (2048 characters or less).
				242	"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
				243	"fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.
				244	{ # File share configuration for the instance.
				245	"capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
				246	"name": "A String", # The name of the file share (must be 16 characters or less).
				247	"nfsExportOptions": [ # Nfs Export Options. There is a limit of 10 export options per file share.
				248	{ # NFS export options specifications.
				249	"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.
				250	"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.
				251	"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.
				252	"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.
				253	"A String",
				254	],
				255	"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.
				256	},
				257	],
				258	"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.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	259	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	260	],
				261	"labels": { # Resource labels to represent user provided metadata.
				262	"a_key": "A String",
				263	},
				264	"name": "A String", # Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.
				265	"networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
				266	{ # Network configuration for the instance.
				267	"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}.
				268	"A String",
				269	],
				270	"modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
				271	"A String",
				272	],
				273	"network": "A String", # The name of the Google Compute Engine [VPC network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected.
				274	"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.
				275	},
				276	],
yoshi-code-bot	cec4393	2021-04-24 08:36:03 -0700	[diff] [blame^]	277	"satisfiesPzs": True or False, # Output only. Reserved for future use.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	278	"state": "A String", # Output only. The instance state.
				279	"statusMessage": "A String", # Output only. Additional information about the instance state, if available.
				280	"tier": "A String", # The service tier of the instance.
				281	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	282	</div>
				283
				284	<div class="method">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	285	<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	286	<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]	287
				288	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	289	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]	290	filter: string, List filter.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	291	orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
				292	pageSize: integer, The maximum number of items to return.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	293	pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	294	x__xgafv: string, V1 error format.
				295	Allowed values
				296	1 - v1 error format
				297	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	298
				299	Returns:
				300	An object of the form:
				301
				302	{ # ListInstancesResponse is the result of ListInstancesRequest.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	303	"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.
				304	{ # A Cloud Filestore instance.
				305	"createTime": "A String", # Output only. The time when the instance was created.
				306	"description": "A String", # The description of the instance (2048 characters or less).
				307	"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
				308	"fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.
				309	{ # File share configuration for the instance.
				310	"capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
				311	"name": "A String", # The name of the file share (must be 16 characters or less).
				312	"nfsExportOptions": [ # Nfs Export Options. There is a limit of 10 export options per file share.
				313	{ # NFS export options specifications.
				314	"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.
				315	"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.
				316	"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.
				317	"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.
				318	"A String",
				319	],
				320	"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.
				321	},
				322	],
				323	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	324	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	325	],
				326	"labels": { # Resource labels to represent user provided metadata.
				327	"a_key": "A String",
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	328	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	329	"name": "A String", # Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.
				330	"networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
				331	{ # Network configuration for the instance.
				332	"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}.
				333	"A String",
				334	],
				335	"modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
				336	"A String",
				337	],
				338	"network": "A String", # The name of the Google Compute Engine [VPC network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected.
				339	"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.
				340	},
				341	],
yoshi-code-bot	cec4393	2021-04-24 08:36:03 -0700	[diff] [blame^]	342	"satisfiesPzs": True or False, # Output only. Reserved for future use.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	343	"state": "A String", # Output only. The instance state.
				344	"statusMessage": "A String", # Output only. Additional information about the instance state, if available.
				345	"tier": "A String", # The service tier of the instance.
				346	},
				347	],
				348	"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.
				349	"unreachable": [ # Locations that could not be reached.
				350	"A String",
				351	],
				352	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	353	</div>
				354
				355	<div class="method">
				356	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				357	<pre>Retrieves the next page of results.
				358
				359	Args:
				360	previous_request: The request for the previous page. (required)
				361	previous_response: The response from the request for the previous page. (required)
				362
				363	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	364	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]	365	page. Returns None if there are no more items in the collection.
				366	</pre>
				367	</div>
				368
				369	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	370	<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]	371	<pre>Updates the settings of a specific instance.
				372
				373	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	374	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]	375	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	376	The object takes the form of:
				377
				378	{ # A Cloud Filestore instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	379	"createTime": "A String", # Output only. The time when the instance was created.
				380	"description": "A String", # The description of the instance (2048 characters or less).
				381	"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	382	"fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.
				383	{ # File share configuration for the instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	384	"capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	385	"name": "A String", # The name of the file share (must be 16 characters or less).
				386	"nfsExportOptions": [ # Nfs Export Options. There is a limit of 10 export options per file share.
				387	{ # NFS export options specifications.
				388	"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.
				389	"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.
				390	"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.
				391	"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.
				392	"A String",
				393	],
				394	"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.
				395	},
				396	],
				397	"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.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	398	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	399	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	400	"labels": { # Resource labels to represent user provided metadata.
				401	"a_key": "A String",
				402	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	403	"name": "A String", # Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.
				404	"networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
				405	{ # Network configuration for the instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	406	"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}.
				407	"A String",
				408	],
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	409	"modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
				410	"A String",
				411	],
				412	"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	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	413	"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.
				414	},
				415	],
yoshi-code-bot	cec4393	2021-04-24 08:36:03 -0700	[diff] [blame^]	416	"satisfiesPzs": True or False, # Output only. Reserved for future use.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	417	"state": "A String", # Output only. The instance state.
				418	"statusMessage": "A String", # Output only. Additional information about the instance state, if available.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	419	"tier": "A String", # The service tier of the instance.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	420	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	421
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	422	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]	423	x__xgafv: string, V1 error format.
				424	Allowed values
				425	1 - v1 error format
				426	2 - v2 error format
				427
				428	Returns:
				429	An object of the form:
				430
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	431	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	432	"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.
				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	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				435	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				436	{
				437	"a_key": "", # Properties of the object. Contains field @type with type URL.
				438	},
				439	],
				440	"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.
				441	},
				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	},
				445	"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}`.
				446	"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`.
				447	"a_key": "", # Properties of the object. Contains field @type with type URL.
				448	},
				449	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	450	</div>
				451
				452	<div class="method">
				453	<code class="details" id="restore">restore(name, body=None, x__xgafv=None)</code>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	454	<pre>Restores an existing instance's file share from a backup. The capacity of the 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).
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	455
				456	Args:
				457	name: string, Required. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}. (required)
				458	body: object, The request body.
				459	The object takes the form of:
				460
				461	{ # RestoreInstanceRequest restores an existing instances's file share from a snapshot or backup.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	462	"fileShare": "A String", # Required. Name of the file share in the Cloud Filestore instance that the snapshot is being restored to.
				463	"sourceBackup": "A String", # The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
				464	"sourceSnapshot": "A String", # The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/snapshots/{snapshot_id}.
				465	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	466
				467	x__xgafv: string, V1 error format.
				468	Allowed values
				469	1 - v1 error format
				470	2 - v2 error format
				471
				472	Returns:
				473	An object of the form:
				474
				475	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	476	"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.
				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	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				479	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				480	{
				481	"a_key": "", # Properties of the object. Contains field @type with type URL.
				482	},
				483	],
				484	"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.
				485	},
				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	},
				489	"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}`.
				490	"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`.
				491	"a_key": "", # Properties of the object. Contains field @type with type URL.
				492	},
				493	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	494	</div>
				495
				496	</body></html>