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

blob: 50ec25b8a84451e5a12c316b78e4f6e0446913d2 [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_v1.html">Cloud Filestore API</a> . <a href="file_v1.projects.html">projects</a> . <a href="file_v1.projects.locations.html">locations</a> . <a href="file_v1.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, pageToken=None, filter=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>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	98	<p class="toc_element">
				99	<code><a href="#restore">restore(name, body=None, x__xgafv=None)</a></code></p>
				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	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	117	"networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
				118	{ # Network configuration for the instance.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	119	"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	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	120	"reservedIpRange": "A String", # A /29 CIDR block 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/29. 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	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	121	"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}.
				122	"A String",
				123	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	124	"modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
				125	"A String",
				126	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	127	},
				128	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	129	"description": "A String", # The description of the instance (2048 characters or less).
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	130	"statusMessage": "A String", # Output only. Additional information about the instance state, if available.
				131	"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
				132	"fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.
				133	{ # File share configuration for the instance.
				134	"sourceBackup": "A String", # The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.
				135	"capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
				136	"name": "A String", # The name of the file share (must be 16 characters or less).
				137	},
				138	],
				139	"labels": { # Resource labels to represent user provided metadata.
				140	"a_key": "A String",
				141	},
				142	"tier": "A String", # The service tier of the instance.
				143	"name": "A String", # Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.
				144	"createTime": "A String", # Output only. The time when the instance was created.
				145	"state": "A String", # Output only. The instance state.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	146	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	147
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	148	instanceId: string, Required. The name of the instance to create. The name must be unique for the specified project and location.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	149	x__xgafv: string, V1 error format.
				150	Allowed values
				151	1 - v1 error format
				152	2 - v2 error format
				153
				154	Returns:
				155	An object of the form:
				156
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	157	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	158	"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}`.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	159	"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.
				160	"a_key": "", # Properties of the object. Contains field @type with type URL.
				161	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	162	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	163	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	164	"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]	165	{
				166	"a_key": "", # Properties of the object. Contains field @type with type URL.
				167	},
				168	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	169	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	170	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	171	"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]	172	"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`.
				173	"a_key": "", # Properties of the object. Contains field @type with type URL.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	174	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	175	}</pre>
				176	</div>
				177
				178	<div class="method">
				179	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				180	<pre>Deletes an instance.
				181
				182	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	183	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]	184	x__xgafv: string, V1 error format.
				185	Allowed values
				186	1 - v1 error format
				187	2 - v2 error format
				188
				189	Returns:
				190	An object of the form:
				191
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	192	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	193	"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}`.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	194	"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.
				195	"a_key": "", # Properties of the object. Contains field @type with type URL.
				196	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	197	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	198	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	199	"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]	200	{
				201	"a_key": "", # Properties of the object. Contains field @type with type URL.
				202	},
				203	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	204	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	205	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	206	"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]	207	"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`.
				208	"a_key": "", # Properties of the object. Contains field @type with type URL.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	209	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	210	}</pre>
				211	</div>
				212
				213	<div class="method">
				214	<code class="details" id="get">get(name, x__xgafv=None)</code>
				215	<pre>Gets the details of a specific instance.
				216
				217	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	218	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]	219	x__xgafv: string, V1 error format.
				220	Allowed values
				221	1 - v1 error format
				222	2 - v2 error format
				223
				224	Returns:
				225	An object of the form:
				226
				227	{ # A Cloud Filestore instance.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	228	"networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
				229	{ # Network configuration for the instance.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	230	"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	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	231	"reservedIpRange": "A String", # A /29 CIDR block 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/29. 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	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	232	"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}.
				233	"A String",
				234	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	235	"modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
				236	"A String",
				237	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	238	},
				239	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	240	"description": "A String", # The description of the instance (2048 characters or less).
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	241	"statusMessage": "A String", # Output only. Additional information about the instance state, if available.
				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	"sourceBackup": "A String", # The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.
				246	"capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
				247	"name": "A String", # The name of the file share (must be 16 characters or less).
				248	},
				249	],
				250	"labels": { # Resource labels to represent user provided metadata.
				251	"a_key": "A String",
				252	},
				253	"tier": "A String", # The service tier of the instance.
				254	"name": "A String", # Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.
				255	"createTime": "A String", # Output only. The time when the instance was created.
				256	"state": "A String", # Output only. The instance state.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	257	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	258	</div>
				259
				260	<div class="method">
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	261	<code class="details" id="list">list(parent, pageToken=None, filter=None, orderBy=None, pageSize=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	262	<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]	263
				264	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	265	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)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	266	pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	267	filter: string, List filter.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	268	orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
				269	pageSize: integer, The maximum number of items to return.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	270	x__xgafv: string, V1 error format.
				271	Allowed values
				272	1 - v1 error format
				273	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	274
				275	Returns:
				276	An object of the form:
				277
				278	{ # ListInstancesResponse is the result of ListInstancesRequest.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	279	"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.
				280	{ # A Cloud Filestore instance.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	281	"networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
				282	{ # Network configuration for the instance.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	283	"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	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	284	"reservedIpRange": "A String", # A /29 CIDR block 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/29. 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	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	285	"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}.
				286	"A String",
				287	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	288	"modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
				289	"A String",
				290	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	291	},
				292	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	293	"description": "A String", # The description of the instance (2048 characters or less).
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	294	"statusMessage": "A String", # Output only. Additional information about the instance state, if available.
				295	"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
				296	"fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.
				297	{ # File share configuration for the instance.
				298	"sourceBackup": "A String", # The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.
				299	"capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
				300	"name": "A String", # The name of the file share (must be 16 characters or less).
				301	},
				302	],
				303	"labels": { # Resource labels to represent user provided metadata.
				304	"a_key": "A String",
				305	},
				306	"tier": "A String", # The service tier of the instance.
				307	"name": "A String", # Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.
				308	"createTime": "A String", # Output only. The time when the instance was created.
				309	"state": "A String", # Output only. The instance state.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	310	},
				311	],
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	312	"unreachable": [ # Locations that could not be reached.
				313	"A String",
				314	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	315	"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	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	316	}</pre>
				317	</div>
				318
				319	<div class="method">
				320	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				321	<pre>Retrieves the next page of results.
				322
				323	Args:
				324	previous_request: The request for the previous page. (required)
				325	previous_response: The response from the request for the previous page. (required)
				326
				327	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	328	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]	329	page. Returns None if there are no more items in the collection.
				330	</pre>
				331	</div>
				332
				333	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	334	<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]	335	<pre>Updates the settings of a specific instance.
				336
				337	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	338	name: string, Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	339	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	340	The object takes the form of:
				341
				342	{ # A Cloud Filestore instance.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	343	"networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
				344	{ # Network configuration for the instance.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	345	"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	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	346	"reservedIpRange": "A String", # A /29 CIDR block 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/29. 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	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	347	"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}.
				348	"A String",
				349	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	350	"modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
				351	"A String",
				352	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	353	},
				354	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	355	"description": "A String", # The description of the instance (2048 characters or less).
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	356	"statusMessage": "A String", # Output only. Additional information about the instance state, if available.
				357	"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
				358	"fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.
				359	{ # File share configuration for the instance.
				360	"sourceBackup": "A String", # The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.
				361	"capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
				362	"name": "A String", # The name of the file share (must be 16 characters or less).
				363	},
				364	],
				365	"labels": { # Resource labels to represent user provided metadata.
				366	"a_key": "A String",
				367	},
				368	"tier": "A String", # The service tier of the instance.
				369	"name": "A String", # Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.
				370	"createTime": "A String", # Output only. The time when the instance was created.
				371	"state": "A String", # Output only. The instance state.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	372	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	373
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	374	updateMask: string, 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]	375	x__xgafv: string, V1 error format.
				376	Allowed values
				377	1 - v1 error format
				378	2 - v2 error format
				379
				380	Returns:
				381	An object of the form:
				382
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	383	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	384	"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}`.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	385	"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.
				386	"a_key": "", # Properties of the object. Contains field @type with type URL.
				387	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	388	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	389	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	390	"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]	391	{
				392	"a_key": "", # Properties of the object. Contains field @type with type URL.
				393	},
				394	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	395	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	396	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	397	"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]	398	"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`.
				399	"a_key": "", # Properties of the object. Contains field @type with type URL.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	400	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	401	}</pre>
				402	</div>
				403
				404	<div class="method">
				405	<code class="details" id="restore">restore(name, body=None, x__xgafv=None)</code>
				406	<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.
				407
				408	Args:
				409	name: string, Required. The resource name of the instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}. (required)
				410	body: object, The request body.
				411	The object takes the form of:
				412
				413	{ # RestoreInstanceRequest restores an existing instances's file share from a backup.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	414	"sourceBackup": "A String", # The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	415	"fileShare": "A String", # Required. Name of the file share in the Cloud Filestore instance that the backup is being restored to.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	416	}
				417
				418	x__xgafv: string, V1 error format.
				419	Allowed values
				420	1 - v1 error format
				421	2 - v2 error format
				422
				423	Returns:
				424	An object of the form:
				425
				426	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	427	"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}`.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	428	"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.
				429	"a_key": "", # Properties of the object. Contains field @type with type URL.
				430	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	431	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	432	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	433	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				434	{
				435	"a_key": "", # Properties of the object. Contains field @type with type URL.
				436	},
				437	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	438	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	439	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	440	"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]	441	"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`.
				442	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	443	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	444	}</pre>
				445	</div>
				446
				447	</body></html>