Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b8458c0b73030155b64a3c2392b2f70e5fbc3baf / . / docs / dyn / file_v1beta1.projects.locations.instances.html
blob: c12f8dcd40b6d78449bc741e42c0436e6bc46da7 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Creates an instance.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes an instance.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets the details of a specific instance.</p>
86<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]87 <code><a href="#list">list(parent, pageToken=None, orderBy=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Lists all instances in a project for either a specified location</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="firstline">Updates the settings of a specific instance.</p>
95<h3>Method Details</h3>
96<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]97 <code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 <pre>Creates an instance.
99
100Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]101 parent: string, Required. The instance&#x27;s project and location, in the format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]102projects/{project_id}/locations/{location}. In Cloud Filestore,
103locations map to GCP zones, for example **us-west1-b**. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]104 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105 The object takes the form of:
106
107{ # A Cloud Filestore instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]108 &quot;etag&quot;: &quot;A String&quot;, # Server-specified ETag for the instance resource to prevent simultaneous
109 # updates from overwriting each other.
110 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the instance was created.
111 &quot;labels&quot;: { # Resource labels to represent user provided metadata.
112 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]114 &quot;state&quot;: &quot;A String&quot;, # Output only. The instance state.
115 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the instance, in the format
116 # projects/{project_id}/locations/{location_id}/instances/{instance_id}.
117 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the instance state, if available.
118 &quot;networks&quot;: [ # VPC networks to which the instance is connected.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119 # For this version, only a single network is supported.
120 { # Network configuration for the instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]121 &quot;ipAddresses&quot;: [ # Output only. IPv4 addresses in the format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122 # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format
123 # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block
124 # 7}:{block 8}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]125 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]126 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]127 &quot;network&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128 # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
129 # instance is connected.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]130 &quot;modes&quot;: [ # Internet protocol versions for which the instance has IP addresses
131 # assigned. For this version, only MODE_IPV4 is supported.
132 &quot;A String&quot;,
133 ],
134 &quot;reservedIpRange&quot;: &quot;A String&quot;, # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the
135 # [internal IP address
136 # ranges](https://www.arin.net/knowledge/address_filters.html) that
137 # identifies the range of IP addresses reserved for this instance. For
138 # example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can&#x27;t overlap
139 # with either existing subnets or assigned IP address ranges for other Cloud
140 # Filestore instances in the selected VPC network.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 },
142 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]143 &quot;fileShares&quot;: [ # File system shares on the instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]144 # For this version, only a single file share is supported.
145 { # File share configuration for the instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]146 &quot;name&quot;: &quot;A String&quot;, # The name of the file share (must be 16 characters or less).
147 &quot;capacityGb&quot;: &quot;A String&quot;, # File share capacity in gigabytes (GB).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]148 # Cloud Filestore defines 1 GB as 1024^3 bytes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]149 },
150 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]151 &quot;tier&quot;: &quot;A String&quot;, # The service tier of the instance.
152 &quot;description&quot;: &quot;A String&quot;, # The description of the instance (2048 characters or less).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]153 }
154
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]155 instanceId: string, Required. The ID of the instance to create.
156The ID must be unique within the specified project and location.
157
158This value must start with a lowercase letter followed by up to 62
159lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]160 x__xgafv: string, V1 error format.
161 Allowed values
162 1 - v1 error format
163 2 - v2 error format
164
165Returns:
166 An object of the form:
167
168 { # This resource represents a long-running operation that is the result of a
169 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]170 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
171 # contains progress information and common metadata such as create time.
172 # Some services might not provide such metadata. Any method that returns a
173 # long-running operation should document the metadata type, if any.
174 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
175 },
176 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
177 # If `true`, the operation is completed, and either `error` or `response` is
178 # available.
179 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]180 # method returns no data on success, such as `Delete`, the response is
181 # `google.protobuf.Empty`. If the original method is standard
182 # `Get`/`Create`/`Update`, the response should be the resource. For other
183 # methods, the response should have the type `XxxResponse`, where `Xxx`
184 # is the original method name. For example, if the original method name
185 # is `TakeSnapshot()`, the inferred response type is
186 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]187 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]188 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]189 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]190 # originally returns it. If you use the default HTTP mapping, the
191 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]192 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]193 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]194 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
195 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]196 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]197 # You can find out more about this error model and how to work with it in the
198 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]199 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]200 # user-facing error message should be localized and sent in the
201 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]202 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]203 # message types for APIs to use.
204 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]205 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]206 },
207 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]208 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]209 },
210 }</pre>
211</div>
212
213<div class="method">
214 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
215 <pre>Deletes an instance.
216
217Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]218 name: string, Required. The instance resource name, in the format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]219projects/{project_id}/locations/{location}/instances/{instance_id} (required)
220 x__xgafv: string, V1 error format.
221 Allowed values
222 1 - v1 error format
223 2 - v2 error format
224
225Returns:
226 An object of the form:
227
228 { # This resource represents a long-running operation that is the result of a
229 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]230 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
231 # contains progress information and common metadata such as create time.
232 # Some services might not provide such metadata. Any method that returns a
233 # long-running operation should document the metadata type, if any.
234 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
235 },
236 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
237 # If `true`, the operation is completed, and either `error` or `response` is
238 # available.
239 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]240 # method returns no data on success, such as `Delete`, the response is
241 # `google.protobuf.Empty`. If the original method is standard
242 # `Get`/`Create`/`Update`, the response should be the resource. For other
243 # methods, the response should have the type `XxxResponse`, where `Xxx`
244 # is the original method name. For example, if the original method name
245 # is `TakeSnapshot()`, the inferred response type is
246 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]247 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]248 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]249 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]250 # originally returns it. If you use the default HTTP mapping, the
251 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]252 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]253 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]254 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
255 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]256 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]257 # You can find out more about this error model and how to work with it in the
258 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]259 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]260 # user-facing error message should be localized and sent in the
261 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]262 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]263 # message types for APIs to use.
264 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]265 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]266 },
267 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]268 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]269 },
270 }</pre>
271</div>
272
273<div class="method">
274 <code class="details" id="get">get(name, x__xgafv=None)</code>
275 <pre>Gets the details of a specific instance.
276
277Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]278 name: string, Required. The instance resource name, in the format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]279projects/{project_id}/locations/{location}/instances/{instance_id}. (required)
280 x__xgafv: string, V1 error format.
281 Allowed values
282 1 - v1 error format
283 2 - v2 error format
284
285Returns:
286 An object of the form:
287
288 { # A Cloud Filestore instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]289 &quot;etag&quot;: &quot;A String&quot;, # Server-specified ETag for the instance resource to prevent simultaneous
290 # updates from overwriting each other.
291 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the instance was created.
292 &quot;labels&quot;: { # Resource labels to represent user provided metadata.
293 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]294 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]295 &quot;state&quot;: &quot;A String&quot;, # Output only. The instance state.
296 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the instance, in the format
297 # projects/{project_id}/locations/{location_id}/instances/{instance_id}.
298 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the instance state, if available.
299 &quot;networks&quot;: [ # VPC networks to which the instance is connected.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]300 # For this version, only a single network is supported.
301 { # Network configuration for the instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]302 &quot;ipAddresses&quot;: [ # Output only. IPv4 addresses in the format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]303 # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format
304 # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block
305 # 7}:{block 8}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]306 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]307 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]308 &quot;network&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]309 # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
310 # instance is connected.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]311 &quot;modes&quot;: [ # Internet protocol versions for which the instance has IP addresses
312 # assigned. For this version, only MODE_IPV4 is supported.
313 &quot;A String&quot;,
314 ],
315 &quot;reservedIpRange&quot;: &quot;A String&quot;, # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the
316 # [internal IP address
317 # ranges](https://www.arin.net/knowledge/address_filters.html) that
318 # identifies the range of IP addresses reserved for this instance. For
319 # example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can&#x27;t overlap
320 # with either existing subnets or assigned IP address ranges for other Cloud
321 # Filestore instances in the selected VPC network.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]322 },
323 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]324 &quot;fileShares&quot;: [ # File system shares on the instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]325 # For this version, only a single file share is supported.
326 { # File share configuration for the instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]327 &quot;name&quot;: &quot;A String&quot;, # The name of the file share (must be 16 characters or less).
328 &quot;capacityGb&quot;: &quot;A String&quot;, # File share capacity in gigabytes (GB).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]329 # Cloud Filestore defines 1 GB as 1024^3 bytes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]330 },
331 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]332 &quot;tier&quot;: &quot;A String&quot;, # The service tier of the instance.
333 &quot;description&quot;: &quot;A String&quot;, # The description of the instance (2048 characters or less).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]334 }</pre>
335</div>
336
337<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]338 <code class="details" id="list">list(parent, pageToken=None, orderBy=None, pageSize=None, filter=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]339 <pre>Lists all instances in a project for either a specified location
340or for all locations.
341
342Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]343 parent: string, Required. The project and location for which to retrieve instance information,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]344in the format projects/{project_id}/locations/{location}. In Cloud
345Filestore, locations map to GCP zones, for example **us-west1-b**. To
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]346retrieve instance information for all locations, use &quot;-&quot; for the {location}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]347value. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]348 pageToken: string, The next_page_token value to use if there are additional
349results to retrieve for this list request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]350 orderBy: string, Sort results. Supported values are &quot;name&quot;, &quot;name desc&quot; or &quot;&quot; (unsorted).
351 pageSize: integer, The maximum number of items to return.
352 filter: string, List filter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]353 x__xgafv: string, V1 error format.
354 Allowed values
355 1 - v1 error format
356 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]357
358Returns:
359 An object of the form:
360
361 { # ListInstancesResponse is the result of ListInstancesRequest.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]362 &quot;instances&quot;: [ # A list of instances in the project for the specified location.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]363 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]364 # If the {location} value in the request is &quot;-&quot;, the response contains a list
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]365 # of instances from all locations. If any location is unreachable, the
366 # response will only return instances in reachable locations and the
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]367 # &quot;unreachable&quot; field will be populated with a list of unreachable locations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]368 { # A Cloud Filestore instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]369 &quot;etag&quot;: &quot;A String&quot;, # Server-specified ETag for the instance resource to prevent simultaneous
370 # updates from overwriting each other.
371 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the instance was created.
372 &quot;labels&quot;: { # Resource labels to represent user provided metadata.
373 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]374 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]375 &quot;state&quot;: &quot;A String&quot;, # Output only. The instance state.
376 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the instance, in the format
377 # projects/{project_id}/locations/{location_id}/instances/{instance_id}.
378 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the instance state, if available.
379 &quot;networks&quot;: [ # VPC networks to which the instance is connected.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]380 # For this version, only a single network is supported.
381 { # Network configuration for the instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]382 &quot;ipAddresses&quot;: [ # Output only. IPv4 addresses in the format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]383 # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format
384 # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block
385 # 7}:{block 8}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]386 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]387 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]388 &quot;network&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]389 # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
390 # instance is connected.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]391 &quot;modes&quot;: [ # Internet protocol versions for which the instance has IP addresses
392 # assigned. For this version, only MODE_IPV4 is supported.
393 &quot;A String&quot;,
394 ],
395 &quot;reservedIpRange&quot;: &quot;A String&quot;, # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the
396 # [internal IP address
397 # ranges](https://www.arin.net/knowledge/address_filters.html) that
398 # identifies the range of IP addresses reserved for this instance. For
399 # example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can&#x27;t overlap
400 # with either existing subnets or assigned IP address ranges for other Cloud
401 # Filestore instances in the selected VPC network.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]402 },
403 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]404 &quot;fileShares&quot;: [ # File system shares on the instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]405 # For this version, only a single file share is supported.
406 { # File share configuration for the instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]407 &quot;name&quot;: &quot;A String&quot;, # The name of the file share (must be 16 characters or less).
408 &quot;capacityGb&quot;: &quot;A String&quot;, # File share capacity in gigabytes (GB).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]409 # Cloud Filestore defines 1 GB as 1024^3 bytes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]410 },
411 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]412 &quot;tier&quot;: &quot;A String&quot;, # The service tier of the instance.
413 &quot;description&quot;: &quot;A String&quot;, # The description of the instance (2048 characters or less).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]414 },
415 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]416 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token you can use to retrieve the next page of results. Not returned
417 # if there are no more results in the list.
418 &quot;unreachable&quot;: [ # Locations that could not be reached.
419 &quot;A String&quot;,
420 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]421 }</pre>
422</div>
423
424<div class="method">
425 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
426 <pre>Retrieves the next page of results.
427
428Args:
429 previous_request: The request for the previous page. (required)
430 previous_response: The response from the request for the previous page. (required)
431
432Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]433 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]434 page. Returns None if there are no more items in the collection.
435 </pre>
436</div>
437
438<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]439 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]440 <pre>Updates the settings of a specific instance.
441
442Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]443 name: string, Output only. The resource name of the instance, in the format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]444projects/{project_id}/locations/{location_id}/instances/{instance_id}. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]445 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]446 The object takes the form of:
447
448{ # A Cloud Filestore instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]449 &quot;etag&quot;: &quot;A String&quot;, # Server-specified ETag for the instance resource to prevent simultaneous
450 # updates from overwriting each other.
451 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the instance was created.
452 &quot;labels&quot;: { # Resource labels to represent user provided metadata.
453 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]454 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]455 &quot;state&quot;: &quot;A String&quot;, # Output only. The instance state.
456 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the instance, in the format
457 # projects/{project_id}/locations/{location_id}/instances/{instance_id}.
458 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the instance state, if available.
459 &quot;networks&quot;: [ # VPC networks to which the instance is connected.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]460 # For this version, only a single network is supported.
461 { # Network configuration for the instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]462 &quot;ipAddresses&quot;: [ # Output only. IPv4 addresses in the format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]463 # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format
464 # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block
465 # 7}:{block 8}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]466 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]467 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]468 &quot;network&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]469 # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
470 # instance is connected.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]471 &quot;modes&quot;: [ # Internet protocol versions for which the instance has IP addresses
472 # assigned. For this version, only MODE_IPV4 is supported.
473 &quot;A String&quot;,
474 ],
475 &quot;reservedIpRange&quot;: &quot;A String&quot;, # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the
476 # [internal IP address
477 # ranges](https://www.arin.net/knowledge/address_filters.html) that
478 # identifies the range of IP addresses reserved for this instance. For
479 # example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can&#x27;t overlap
480 # with either existing subnets or assigned IP address ranges for other Cloud
481 # Filestore instances in the selected VPC network.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]482 },
483 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]484 &quot;fileShares&quot;: [ # File system shares on the instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]485 # For this version, only a single file share is supported.
486 { # File share configuration for the instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]487 &quot;name&quot;: &quot;A String&quot;, # The name of the file share (must be 16 characters or less).
488 &quot;capacityGb&quot;: &quot;A String&quot;, # File share capacity in gigabytes (GB).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]489 # Cloud Filestore defines 1 GB as 1024^3 bytes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]490 },
491 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]492 &quot;tier&quot;: &quot;A String&quot;, # The service tier of the instance.
493 &quot;description&quot;: &quot;A String&quot;, # The description of the instance (2048 characters or less).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]494 }
495
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]496 updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]497field. The elements of the repeated paths field may only include these
498fields:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]499
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]500* &quot;description&quot;
501* &quot;file_shares&quot;
502* &quot;labels&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]503 x__xgafv: string, V1 error format.
504 Allowed values
505 1 - v1 error format
506 2 - v2 error format
507
508Returns:
509 An object of the form:
510
511 { # This resource represents a long-running operation that is the result of a
512 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]513 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
514 # contains progress information and common metadata such as create time.
515 # Some services might not provide such metadata. Any method that returns a
516 # long-running operation should document the metadata type, if any.
517 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
518 },
519 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
520 # If `true`, the operation is completed, and either `error` or `response` is
521 # available.
522 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]523 # method returns no data on success, such as `Delete`, the response is
524 # `google.protobuf.Empty`. If the original method is standard
525 # `Get`/`Create`/`Update`, the response should be the resource. For other
526 # methods, the response should have the type `XxxResponse`, where `Xxx`
527 # is the original method name. For example, if the original method name
528 # is `TakeSnapshot()`, the inferred response type is
529 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]530 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]531 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]532 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]533 # originally returns it. If you use the default HTTP mapping, the
534 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]535 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]536 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]537 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
538 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]539 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]540 # You can find out more about this error model and how to work with it in the
541 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]542 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]543 # user-facing error message should be localized and sent in the
544 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]545 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]546 # message types for APIs to use.
547 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]548 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]549 },
550 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]551 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]552 },
553 }</pre>
554</div>
555
556</body></html>