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

blob: 12cb633c393223708b79b88781eda62ebc6a77de [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	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	82	<p class="firstline">Creates an instance.</p>
				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">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	90	<code><a href="#list">list(parent, orderBy=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
				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>
				98	<h3>Method Details</h3>
				99	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	100	<code class="details" id="close">close()</code>
				101	<pre>Close httplib2 connections.</pre>
				102	</div>
				103
				104	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	105	<code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	106	<pre>Creates an instance.
				107
				108	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	109	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]	110	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	111	The object takes the form of:
				112
				113	{ # A Cloud Filestore instance.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	114	"name": "A String", # Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.
				115	"description": "A String", # The description of the instance (2048 characters or less).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	116	"state": "A String", # Output only. The instance state.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	117	"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
				118	"statusMessage": "A String", # Output only. Additional information about the instance state, if available.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	119	"labels": { # Resource labels to represent user provided metadata.
				120	"a_key": "A String",
				121	},
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	122	"tier": "A String", # The service tier of the instance.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[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.
				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.
				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}.
				127	"A String",
				128	],
				129	"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.
				130	"modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
				131	"A String",
				132	],
				133	},
				134	],
				135	"fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.
				136	{ # File share configuration for the instance.
				137	"name": "A String", # The name of the file share (must be 16 characters or less).
				138	"capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
				139	},
				140	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	141	"createTime": "A String", # Output only. The time when the instance was created.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	142	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	143
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	144	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]	145	x__xgafv: string, V1 error format.
				146	Allowed values
				147	1 - v1 error format
				148	2 - v2 error format
				149
				150	Returns:
				151	An object of the form:
				152
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	153	{ # This resource represents a long-running operation that is the result of a network API call.
				154	"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.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	155	"a_key": "", # Properties of the object. Contains field @type with type URL.
				156	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	157	"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.
				158	"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`.
				159	"a_key": "", # Properties of the object. Contains field @type with type URL.
				160	},
				161	"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}`.
				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.
				163	"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]	164	{
				165	"a_key": "", # Properties of the object. Contains field @type with type URL.
				166	},
				167	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	168	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				169	"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.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	170	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	171	}</pre>
				172	</div>
				173
				174	<div class="method">
				175	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				176	<pre>Deletes an instance.
				177
				178	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	179	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]	180	x__xgafv: string, V1 error format.
				181	Allowed values
				182	1 - v1 error format
				183	2 - v2 error format
				184
				185	Returns:
				186	An object of the form:
				187
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	188	{ # This resource represents a long-running operation that is the result of a network API call.
				189	"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.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	190	"a_key": "", # Properties of the object. Contains field @type with type URL.
				191	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	192	"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.
				193	"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`.
				194	"a_key": "", # Properties of the object. Contains field @type with type URL.
				195	},
				196	"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}`.
				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.
				198	"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]	199	{
				200	"a_key": "", # Properties of the object. Contains field @type with type URL.
				201	},
				202	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	203	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				204	"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.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	205	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	206	}</pre>
				207	</div>
				208
				209	<div class="method">
				210	<code class="details" id="get">get(name, x__xgafv=None)</code>
				211	<pre>Gets the details of a specific instance.
				212
				213	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	214	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]	215	x__xgafv: string, V1 error format.
				216	Allowed values
				217	1 - v1 error format
				218	2 - v2 error format
				219
				220	Returns:
				221	An object of the form:
				222
				223	{ # A Cloud Filestore instance.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	224	"name": "A String", # Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.
				225	"description": "A String", # The description of the instance (2048 characters or less).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	226	"state": "A String", # Output only. The instance state.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	227	"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
				228	"statusMessage": "A String", # Output only. Additional information about the instance state, if available.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	229	"labels": { # Resource labels to represent user provided metadata.
				230	"a_key": "A String",
				231	},
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	232	"tier": "A String", # The service tier of the instance.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	233	"networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
				234	{ # Network configuration for the instance.
				235	"network": "A String", # The name of the Google Compute Engine [VPC network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected.
				236	"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}.
				237	"A String",
				238	],
				239	"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.
				240	"modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
				241	"A String",
				242	],
				243	},
				244	],
				245	"fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.
				246	{ # File share configuration for the instance.
				247	"name": "A String", # The name of the file share (must be 16 characters or less).
				248	"capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
				249	},
				250	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	251	"createTime": "A String", # Output only. The time when the instance was created.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	252	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	253	</div>
				254
				255	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	256	<code class="details" id="list">list(parent, orderBy=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
				257	<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]	258
				259	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	260	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	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	261	orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	262	pageSize: integer, The maximum number of items to return.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	263	filter: string, List filter.
				264	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]	265	x__xgafv: string, V1 error format.
				266	Allowed values
				267	1 - v1 error format
				268	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	269
				270	Returns:
				271	An object of the form:
				272
				273	{ # ListInstancesResponse is the result of ListInstancesRequest.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	274	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	275	{ # A Cloud Filestore instance.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	276	"name": "A String", # Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.
				277	"description": "A String", # The description of the instance (2048 characters or less).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	278	"state": "A String", # Output only. The instance state.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	279	"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
				280	"statusMessage": "A String", # Output only. Additional information about the instance state, if available.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	281	"labels": { # Resource labels to represent user provided metadata.
				282	"a_key": "A String",
				283	},
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	284	"tier": "A String", # The service tier of the instance.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	285	"networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
				286	{ # Network configuration for the instance.
				287	"network": "A String", # The name of the Google Compute Engine [VPC network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected.
				288	"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}.
				289	"A String",
				290	],
				291	"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.
				292	"modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
				293	"A String",
				294	],
				295	},
				296	],
				297	"fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.
				298	{ # File share configuration for the instance.
				299	"name": "A String", # The name of the file share (must be 16 characters or less).
				300	"capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
				301	},
				302	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	303	"createTime": "A String", # Output only. The time when the instance was created.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	304	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	305	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	306	"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]	307	"unreachable": [ # Locations that could not be reached.
				308	"A String",
				309	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	310	}</pre>
				311	</div>
				312
				313	<div class="method">
				314	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				315	<pre>Retrieves the next page of results.
				316
				317	Args:
				318	previous_request: The request for the previous page. (required)
				319	previous_response: The response from the request for the previous page. (required)
				320
				321	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	322	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]	323	page. Returns None if there are no more items in the collection.
				324	</pre>
				325	</div>
				326
				327	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	328	<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]	329	<pre>Updates the settings of a specific instance.
				330
				331	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	332	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]	333	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	334	The object takes the form of:
				335
				336	{ # A Cloud Filestore instance.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	337	"name": "A String", # Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.
				338	"description": "A String", # The description of the instance (2048 characters or less).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	339	"state": "A String", # Output only. The instance state.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	340	"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
				341	"statusMessage": "A String", # Output only. Additional information about the instance state, if available.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	342	"labels": { # Resource labels to represent user provided metadata.
				343	"a_key": "A String",
				344	},
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	345	"tier": "A String", # The service tier of the instance.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	346	"networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
				347	{ # Network configuration for the instance.
				348	"network": "A String", # The name of the Google Compute Engine [VPC network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected.
				349	"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}.
				350	"A String",
				351	],
				352	"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.
				353	"modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
				354	"A String",
				355	],
				356	},
				357	],
				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	"name": "A String", # The name of the file share (must be 16 characters or less).
				361	"capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
				362	},
				363	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	364	"createTime": "A String", # Output only. The time when the instance was created.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	365	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	366
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	367	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]	368	x__xgafv: string, V1 error format.
				369	Allowed values
				370	1 - v1 error format
				371	2 - v2 error format
				372
				373	Returns:
				374	An object of the form:
				375
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	376	{ # This resource represents a long-running operation that is the result of a network API call.
				377	"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.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	378	"a_key": "", # Properties of the object. Contains field @type with type URL.
				379	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	380	"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.
				381	"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`.
				382	"a_key": "", # Properties of the object. Contains field @type with type URL.
				383	},
				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}`.
				385	"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.
				386	"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]	387	{
				388	"a_key": "", # Properties of the object. Contains field @type with type URL.
				389	},
				390	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	391	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				392	"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.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	393	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	394	}</pre>
				395	</div>
				396
				397	</body></html>