| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="file_v1beta1.html">Cloud Filestore API</a> . <a href="file_v1beta1.projects.html">projects</a> . <a href="file_v1beta1.projects.locations.html">locations</a> . <a href="file_v1beta1.projects.locations.instances.html">instances</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-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 Kim | 715bd7f | 2019-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 Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 87 | <code><a href="#list">list(parent, pageToken=None, filter=None, orderBy=None, pageSize=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-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'Meara | dd49464 | 2020-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 Kim | 715bd7f | 2019-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'Meara | dd49464 | 2020-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 Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 98 | <pre>Creates an instance. |
| 99 | |
| 100 | Args: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 101 | parent: string, Required. The instance's project and location, in the format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 102 | projects/{project_id}/locations/{location}. In Cloud Filestore, |
| 103 | locations map to GCP zones, for example **us-west1-b**. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 104 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 105 | The object takes the form of: |
| 106 | |
| 107 | { # A Cloud Filestore instance. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 108 | "tier": "A String", # The service tier of the instance. |
| 109 | "statusMessage": "A String", # Output only. Additional information about the instance state, if available. |
| 110 | "description": "A String", # The description of the instance (2048 characters or less). |
| 111 | "createTime": "A String", # Output only. The time when the instance was created. |
| 112 | "fileShares": [ # File system shares on the instance. |
| 113 | # For this version, only a single file share is supported. |
| 114 | { # File share configuration for the instance. |
| 115 | "nfsExportOptions": [ # Nfs Export Options. |
| 116 | # There is a limit of 10 export options per file share. |
| 117 | { # NFS export options specifications. |
| 118 | "accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported |
| 119 | # directory, or READ_WRITE, for allowing both read and write requests. |
| 120 | # The default is READ_WRITE. |
| 121 | "anonGid": "A String", # An integer representing the anonymous group id with a default value of |
| 122 | # 65534. |
| 123 | # Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be |
| 124 | # returned if this field is specified for other squash_mode settings. |
| 125 | "anonUid": "A String", # An integer representing the anonymous user id with a default value of |
| 126 | # 65534. |
| 127 | # Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be |
| 128 | # returned if this field is specified for other squash_mode settings. |
| 129 | "ipRanges": [ # List of either an IPv4 addresses in the format |
| 130 | # {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format |
| 131 | # {octet 1}.{octet 2}.{octet 3}.{octet 4}/{mask size} which may mount the |
| 132 | # file share. |
| 133 | # Overlapping IP ranges are not allowed, both within and across |
| 134 | # NfsExportOptions. An error will be returned. |
| 135 | # The limit is 64 IP ranges/addresses for each FileShareConfig among all |
| 136 | # NfsExportOptions. |
| 137 | "A String", |
| 138 | ], |
| 139 | "squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, |
| 140 | # or ROOT_SQUASH, for not allowing root access. The default is |
| 141 | # NO_ROOT_SQUASH. |
| 142 | }, |
| 143 | ], |
| 144 | "capacityGb": "A String", # File share capacity in gigabytes (GB). |
| 145 | # Cloud Filestore defines 1 GB as 1024^3 bytes. |
| 146 | "name": "A String", # The name of the file share (must be 16 characters or less). |
| 147 | }, |
| 148 | ], |
| 149 | "state": "A String", # Output only. The instance state. |
| 150 | "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous |
| 151 | # updates from overwriting each other. |
| 152 | "name": "A String", # Output only. The resource name of the instance, in the format |
| 153 | # projects/{project_id}/locations/{location_id}/instances/{instance_id}. |
| 154 | "networks": [ # VPC networks to which the instance is connected. |
| 155 | # For this version, only a single network is supported. |
| 156 | { # Network configuration for the instance. |
| 157 | "reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the |
| 158 | # [internal IP address |
| 159 | # ranges](https://www.arin.net/knowledge/address_filters.html) that |
| 160 | # identifies the range of IP addresses reserved for this instance. For |
| 161 | # example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can't overlap |
| 162 | # with either existing subnets or assigned IP address ranges for other Cloud |
| 163 | # Filestore instances in the selected VPC network. |
| 164 | "ipAddresses": [ # Output only. IPv4 addresses in the format |
| 165 | # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format |
| 166 | # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block |
| 167 | # 7}:{block 8}. |
| 168 | "A String", |
| 169 | ], |
| 170 | "modes": [ # Internet protocol versions for which the instance has IP addresses |
| 171 | # assigned. For this version, only MODE_IPV4 is supported. |
| 172 | "A String", |
| 173 | ], |
| 174 | "network": "A String", # The name of the Google Compute Engine |
| 175 | # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the |
| 176 | # instance is connected. |
| 177 | }, |
| 178 | ], |
| 179 | "labels": { # Resource labels to represent user provided metadata. |
| 180 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 181 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 182 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 183 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 184 | instanceId: string, Required. The ID of the instance to create. |
| 185 | The ID must be unique within the specified project and location. |
| 186 | |
| 187 | This value must start with a lowercase letter followed by up to 62 |
| 188 | lowercase letters, numbers, or hyphens, and cannot end with a hyphen. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 189 | x__xgafv: string, V1 error format. |
| 190 | Allowed values |
| 191 | 1 - v1 error format |
| 192 | 2 - v2 error format |
| 193 | |
| 194 | Returns: |
| 195 | An object of the form: |
| 196 | |
| 197 | { # This resource represents a long-running operation that is the result of a |
| 198 | # network API call. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 199 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 200 | # originally returns it. If you use the default HTTP mapping, the |
| 201 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 202 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 203 | # different programming environments, including REST APIs and RPC APIs. It is |
| 204 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 205 | # three pieces of data: error code, error message, and error details. |
| 206 | # |
| 207 | # You can find out more about this error model and how to work with it in the |
| 208 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 209 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 210 | # user-facing error message should be localized and sent in the |
| 211 | # google.rpc.Status.details field, or localized by the client. |
| 212 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 213 | # message types for APIs to use. |
| 214 | { |
| 215 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 216 | }, |
| 217 | ], |
| 218 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 219 | }, |
| 220 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 221 | # contains progress information and common metadata such as create time. |
| 222 | # Some services might not provide such metadata. Any method that returns a |
| 223 | # long-running operation should document the metadata type, if any. |
| 224 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 225 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 226 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 227 | # If `true`, the operation is completed, and either `error` or `response` is |
| 228 | # available. |
| 229 | "response": { # The normal response of the operation in case of success. If the original |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 230 | # method returns no data on success, such as `Delete`, the response is |
| 231 | # `google.protobuf.Empty`. If the original method is standard |
| 232 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 233 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 234 | # is the original method name. For example, if the original method name |
| 235 | # is `TakeSnapshot()`, the inferred response type is |
| 236 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 237 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 238 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 239 | }</pre> |
| 240 | </div> |
| 241 | |
| 242 | <div class="method"> |
| 243 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 244 | <pre>Deletes an instance. |
| 245 | |
| 246 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 247 | name: string, Required. The instance resource name, in the format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 248 | projects/{project_id}/locations/{location}/instances/{instance_id} (required) |
| 249 | x__xgafv: string, V1 error format. |
| 250 | Allowed values |
| 251 | 1 - v1 error format |
| 252 | 2 - v2 error format |
| 253 | |
| 254 | Returns: |
| 255 | An object of the form: |
| 256 | |
| 257 | { # This resource represents a long-running operation that is the result of a |
| 258 | # network API call. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 259 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 260 | # originally returns it. If you use the default HTTP mapping, the |
| 261 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 262 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 263 | # different programming environments, including REST APIs and RPC APIs. It is |
| 264 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 265 | # three pieces of data: error code, error message, and error details. |
| 266 | # |
| 267 | # You can find out more about this error model and how to work with it in the |
| 268 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 269 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 270 | # user-facing error message should be localized and sent in the |
| 271 | # google.rpc.Status.details field, or localized by the client. |
| 272 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 273 | # message types for APIs to use. |
| 274 | { |
| 275 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 276 | }, |
| 277 | ], |
| 278 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 279 | }, |
| 280 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 281 | # contains progress information and common metadata such as create time. |
| 282 | # Some services might not provide such metadata. Any method that returns a |
| 283 | # long-running operation should document the metadata type, if any. |
| 284 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 285 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 286 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 287 | # If `true`, the operation is completed, and either `error` or `response` is |
| 288 | # available. |
| 289 | "response": { # The normal response of the operation in case of success. If the original |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 290 | # method returns no data on success, such as `Delete`, the response is |
| 291 | # `google.protobuf.Empty`. If the original method is standard |
| 292 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 293 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 294 | # is the original method name. For example, if the original method name |
| 295 | # is `TakeSnapshot()`, the inferred response type is |
| 296 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 297 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 298 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 299 | }</pre> |
| 300 | </div> |
| 301 | |
| 302 | <div class="method"> |
| 303 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 304 | <pre>Gets the details of a specific instance. |
| 305 | |
| 306 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 307 | name: string, Required. The instance resource name, in the format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 308 | projects/{project_id}/locations/{location}/instances/{instance_id}. (required) |
| 309 | x__xgafv: string, V1 error format. |
| 310 | Allowed values |
| 311 | 1 - v1 error format |
| 312 | 2 - v2 error format |
| 313 | |
| 314 | Returns: |
| 315 | An object of the form: |
| 316 | |
| 317 | { # A Cloud Filestore instance. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 318 | "tier": "A String", # The service tier of the instance. |
| 319 | "statusMessage": "A String", # Output only. Additional information about the instance state, if available. |
| 320 | "description": "A String", # The description of the instance (2048 characters or less). |
| 321 | "createTime": "A String", # Output only. The time when the instance was created. |
| 322 | "fileShares": [ # File system shares on the instance. |
| 323 | # For this version, only a single file share is supported. |
| 324 | { # File share configuration for the instance. |
| 325 | "nfsExportOptions": [ # Nfs Export Options. |
| 326 | # There is a limit of 10 export options per file share. |
| 327 | { # NFS export options specifications. |
| 328 | "accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported |
| 329 | # directory, or READ_WRITE, for allowing both read and write requests. |
| 330 | # The default is READ_WRITE. |
| 331 | "anonGid": "A String", # An integer representing the anonymous group id with a default value of |
| 332 | # 65534. |
| 333 | # Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be |
| 334 | # returned if this field is specified for other squash_mode settings. |
| 335 | "anonUid": "A String", # An integer representing the anonymous user id with a default value of |
| 336 | # 65534. |
| 337 | # Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be |
| 338 | # returned if this field is specified for other squash_mode settings. |
| 339 | "ipRanges": [ # List of either an IPv4 addresses in the format |
| 340 | # {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format |
| 341 | # {octet 1}.{octet 2}.{octet 3}.{octet 4}/{mask size} which may mount the |
| 342 | # file share. |
| 343 | # Overlapping IP ranges are not allowed, both within and across |
| 344 | # NfsExportOptions. An error will be returned. |
| 345 | # The limit is 64 IP ranges/addresses for each FileShareConfig among all |
| 346 | # NfsExportOptions. |
| 347 | "A String", |
| 348 | ], |
| 349 | "squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, |
| 350 | # or ROOT_SQUASH, for not allowing root access. The default is |
| 351 | # NO_ROOT_SQUASH. |
| 352 | }, |
| 353 | ], |
| 354 | "capacityGb": "A String", # File share capacity in gigabytes (GB). |
| 355 | # Cloud Filestore defines 1 GB as 1024^3 bytes. |
| 356 | "name": "A String", # The name of the file share (must be 16 characters or less). |
| 357 | }, |
| 358 | ], |
| 359 | "state": "A String", # Output only. The instance state. |
| 360 | "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous |
| 361 | # updates from overwriting each other. |
| 362 | "name": "A String", # Output only. The resource name of the instance, in the format |
| 363 | # projects/{project_id}/locations/{location_id}/instances/{instance_id}. |
| 364 | "networks": [ # VPC networks to which the instance is connected. |
| 365 | # For this version, only a single network is supported. |
| 366 | { # Network configuration for the instance. |
| 367 | "reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the |
| 368 | # [internal IP address |
| 369 | # ranges](https://www.arin.net/knowledge/address_filters.html) that |
| 370 | # identifies the range of IP addresses reserved for this instance. For |
| 371 | # example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can't overlap |
| 372 | # with either existing subnets or assigned IP address ranges for other Cloud |
| 373 | # Filestore instances in the selected VPC network. |
| 374 | "ipAddresses": [ # Output only. IPv4 addresses in the format |
| 375 | # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format |
| 376 | # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block |
| 377 | # 7}:{block 8}. |
| 378 | "A String", |
| 379 | ], |
| 380 | "modes": [ # Internet protocol versions for which the instance has IP addresses |
| 381 | # assigned. For this version, only MODE_IPV4 is supported. |
| 382 | "A String", |
| 383 | ], |
| 384 | "network": "A String", # The name of the Google Compute Engine |
| 385 | # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the |
| 386 | # instance is connected. |
| 387 | }, |
| 388 | ], |
| 389 | "labels": { # Resource labels to represent user provided metadata. |
| 390 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 391 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 392 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 393 | </div> |
| 394 | |
| 395 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 396 | <code class="details" id="list">list(parent, pageToken=None, filter=None, orderBy=None, pageSize=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 397 | <pre>Lists all instances in a project for either a specified location |
| 398 | or for all locations. |
| 399 | |
| 400 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 401 | parent: string, Required. The project and location for which to retrieve instance information, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 402 | in the format projects/{project_id}/locations/{location}. In Cloud |
| 403 | Filestore, locations map to GCP zones, for example **us-west1-b**. To |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 404 | retrieve instance information for all locations, use "-" for the {location} |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 405 | value. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 406 | pageToken: string, The next_page_token value to use if there are additional |
| 407 | results to retrieve for this list request. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 408 | filter: string, List filter. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 409 | orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted). |
| 410 | pageSize: integer, The maximum number of items to return. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 411 | x__xgafv: string, V1 error format. |
| 412 | Allowed values |
| 413 | 1 - v1 error format |
| 414 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 415 | |
| 416 | Returns: |
| 417 | An object of the form: |
| 418 | |
| 419 | { # ListInstancesResponse is the result of ListInstancesRequest. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 420 | "unreachable": [ # Locations that could not be reached. |
| 421 | "A String", |
| 422 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 423 | "instances": [ # A list of instances in the project for the specified location. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 424 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 425 | # If the {location} value in the request is "-", the response contains a list |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 426 | # of instances from all locations. If any location is unreachable, the |
| 427 | # response will only return instances in reachable locations and the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 428 | # "unreachable" field will be populated with a list of unreachable locations. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 429 | { # A Cloud Filestore instance. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 430 | "tier": "A String", # The service tier of the instance. |
| 431 | "statusMessage": "A String", # Output only. Additional information about the instance state, if available. |
| 432 | "description": "A String", # The description of the instance (2048 characters or less). |
| 433 | "createTime": "A String", # Output only. The time when the instance was created. |
| 434 | "fileShares": [ # File system shares on the instance. |
| 435 | # For this version, only a single file share is supported. |
| 436 | { # File share configuration for the instance. |
| 437 | "nfsExportOptions": [ # Nfs Export Options. |
| 438 | # There is a limit of 10 export options per file share. |
| 439 | { # NFS export options specifications. |
| 440 | "accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported |
| 441 | # directory, or READ_WRITE, for allowing both read and write requests. |
| 442 | # The default is READ_WRITE. |
| 443 | "anonGid": "A String", # An integer representing the anonymous group id with a default value of |
| 444 | # 65534. |
| 445 | # Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be |
| 446 | # returned if this field is specified for other squash_mode settings. |
| 447 | "anonUid": "A String", # An integer representing the anonymous user id with a default value of |
| 448 | # 65534. |
| 449 | # Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be |
| 450 | # returned if this field is specified for other squash_mode settings. |
| 451 | "ipRanges": [ # List of either an IPv4 addresses in the format |
| 452 | # {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format |
| 453 | # {octet 1}.{octet 2}.{octet 3}.{octet 4}/{mask size} which may mount the |
| 454 | # file share. |
| 455 | # Overlapping IP ranges are not allowed, both within and across |
| 456 | # NfsExportOptions. An error will be returned. |
| 457 | # The limit is 64 IP ranges/addresses for each FileShareConfig among all |
| 458 | # NfsExportOptions. |
| 459 | "A String", |
| 460 | ], |
| 461 | "squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, |
| 462 | # or ROOT_SQUASH, for not allowing root access. The default is |
| 463 | # NO_ROOT_SQUASH. |
| 464 | }, |
| 465 | ], |
| 466 | "capacityGb": "A String", # File share capacity in gigabytes (GB). |
| 467 | # Cloud Filestore defines 1 GB as 1024^3 bytes. |
| 468 | "name": "A String", # The name of the file share (must be 16 characters or less). |
| 469 | }, |
| 470 | ], |
| 471 | "state": "A String", # Output only. The instance state. |
| 472 | "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous |
| 473 | # updates from overwriting each other. |
| 474 | "name": "A String", # Output only. The resource name of the instance, in the format |
| 475 | # projects/{project_id}/locations/{location_id}/instances/{instance_id}. |
| 476 | "networks": [ # VPC networks to which the instance is connected. |
| 477 | # For this version, only a single network is supported. |
| 478 | { # Network configuration for the instance. |
| 479 | "reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the |
| 480 | # [internal IP address |
| 481 | # ranges](https://www.arin.net/knowledge/address_filters.html) that |
| 482 | # identifies the range of IP addresses reserved for this instance. For |
| 483 | # example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can't overlap |
| 484 | # with either existing subnets or assigned IP address ranges for other Cloud |
| 485 | # Filestore instances in the selected VPC network. |
| 486 | "ipAddresses": [ # Output only. IPv4 addresses in the format |
| 487 | # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format |
| 488 | # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block |
| 489 | # 7}:{block 8}. |
| 490 | "A String", |
| 491 | ], |
| 492 | "modes": [ # Internet protocol versions for which the instance has IP addresses |
| 493 | # assigned. For this version, only MODE_IPV4 is supported. |
| 494 | "A String", |
| 495 | ], |
| 496 | "network": "A String", # The name of the Google Compute Engine |
| 497 | # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the |
| 498 | # instance is connected. |
| 499 | }, |
| 500 | ], |
| 501 | "labels": { # Resource labels to represent user provided metadata. |
| 502 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 503 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 504 | }, |
| 505 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 506 | "nextPageToken": "A String", # The token you can use to retrieve the next page of results. Not returned |
| 507 | # if there are no more results in the list. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 508 | }</pre> |
| 509 | </div> |
| 510 | |
| 511 | <div class="method"> |
| 512 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 513 | <pre>Retrieves the next page of results. |
| 514 | |
| 515 | Args: |
| 516 | previous_request: The request for the previous page. (required) |
| 517 | previous_response: The response from the request for the previous page. (required) |
| 518 | |
| 519 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 520 | 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] | 521 | page. Returns None if there are no more items in the collection. |
| 522 | </pre> |
| 523 | </div> |
| 524 | |
| 525 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 526 | <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] | 527 | <pre>Updates the settings of a specific instance. |
| 528 | |
| 529 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 530 | name: string, Output only. The resource name of the instance, in the format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 531 | projects/{project_id}/locations/{location_id}/instances/{instance_id}. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 532 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 533 | The object takes the form of: |
| 534 | |
| 535 | { # A Cloud Filestore instance. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 536 | "tier": "A String", # The service tier of the instance. |
| 537 | "statusMessage": "A String", # Output only. Additional information about the instance state, if available. |
| 538 | "description": "A String", # The description of the instance (2048 characters or less). |
| 539 | "createTime": "A String", # Output only. The time when the instance was created. |
| 540 | "fileShares": [ # File system shares on the instance. |
| 541 | # For this version, only a single file share is supported. |
| 542 | { # File share configuration for the instance. |
| 543 | "nfsExportOptions": [ # Nfs Export Options. |
| 544 | # There is a limit of 10 export options per file share. |
| 545 | { # NFS export options specifications. |
| 546 | "accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported |
| 547 | # directory, or READ_WRITE, for allowing both read and write requests. |
| 548 | # The default is READ_WRITE. |
| 549 | "anonGid": "A String", # An integer representing the anonymous group id with a default value of |
| 550 | # 65534. |
| 551 | # Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be |
| 552 | # returned if this field is specified for other squash_mode settings. |
| 553 | "anonUid": "A String", # An integer representing the anonymous user id with a default value of |
| 554 | # 65534. |
| 555 | # Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be |
| 556 | # returned if this field is specified for other squash_mode settings. |
| 557 | "ipRanges": [ # List of either an IPv4 addresses in the format |
| 558 | # {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format |
| 559 | # {octet 1}.{octet 2}.{octet 3}.{octet 4}/{mask size} which may mount the |
| 560 | # file share. |
| 561 | # Overlapping IP ranges are not allowed, both within and across |
| 562 | # NfsExportOptions. An error will be returned. |
| 563 | # The limit is 64 IP ranges/addresses for each FileShareConfig among all |
| 564 | # NfsExportOptions. |
| 565 | "A String", |
| 566 | ], |
| 567 | "squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, |
| 568 | # or ROOT_SQUASH, for not allowing root access. The default is |
| 569 | # NO_ROOT_SQUASH. |
| 570 | }, |
| 571 | ], |
| 572 | "capacityGb": "A String", # File share capacity in gigabytes (GB). |
| 573 | # Cloud Filestore defines 1 GB as 1024^3 bytes. |
| 574 | "name": "A String", # The name of the file share (must be 16 characters or less). |
| 575 | }, |
| 576 | ], |
| 577 | "state": "A String", # Output only. The instance state. |
| 578 | "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous |
| 579 | # updates from overwriting each other. |
| 580 | "name": "A String", # Output only. The resource name of the instance, in the format |
| 581 | # projects/{project_id}/locations/{location_id}/instances/{instance_id}. |
| 582 | "networks": [ # VPC networks to which the instance is connected. |
| 583 | # For this version, only a single network is supported. |
| 584 | { # Network configuration for the instance. |
| 585 | "reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the |
| 586 | # [internal IP address |
| 587 | # ranges](https://www.arin.net/knowledge/address_filters.html) that |
| 588 | # identifies the range of IP addresses reserved for this instance. For |
| 589 | # example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can't overlap |
| 590 | # with either existing subnets or assigned IP address ranges for other Cloud |
| 591 | # Filestore instances in the selected VPC network. |
| 592 | "ipAddresses": [ # Output only. IPv4 addresses in the format |
| 593 | # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format |
| 594 | # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block |
| 595 | # 7}:{block 8}. |
| 596 | "A String", |
| 597 | ], |
| 598 | "modes": [ # Internet protocol versions for which the instance has IP addresses |
| 599 | # assigned. For this version, only MODE_IPV4 is supported. |
| 600 | "A String", |
| 601 | ], |
| 602 | "network": "A String", # The name of the Google Compute Engine |
| 603 | # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the |
| 604 | # instance is connected. |
| 605 | }, |
| 606 | ], |
| 607 | "labels": { # Resource labels to represent user provided metadata. |
| 608 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 609 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 610 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 611 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 612 | updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 613 | field. The elements of the repeated paths field may only include these |
| 614 | fields: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 615 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 616 | * "description" |
| 617 | * "file_shares" |
| 618 | * "labels" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 619 | x__xgafv: string, V1 error format. |
| 620 | Allowed values |
| 621 | 1 - v1 error format |
| 622 | 2 - v2 error format |
| 623 | |
| 624 | Returns: |
| 625 | An object of the form: |
| 626 | |
| 627 | { # This resource represents a long-running operation that is the result of a |
| 628 | # network API call. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 629 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 630 | # originally returns it. If you use the default HTTP mapping, the |
| 631 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 632 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 633 | # different programming environments, including REST APIs and RPC APIs. It is |
| 634 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 635 | # three pieces of data: error code, error message, and error details. |
| 636 | # |
| 637 | # You can find out more about this error model and how to work with it in the |
| 638 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 639 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 640 | # user-facing error message should be localized and sent in the |
| 641 | # google.rpc.Status.details field, or localized by the client. |
| 642 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 643 | # message types for APIs to use. |
| 644 | { |
| 645 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 646 | }, |
| 647 | ], |
| 648 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 649 | }, |
| 650 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 651 | # contains progress information and common metadata such as create time. |
| 652 | # Some services might not provide such metadata. Any method that returns a |
| 653 | # long-running operation should document the metadata type, if any. |
| 654 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 655 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 656 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 657 | # If `true`, the operation is completed, and either `error` or `response` is |
| 658 | # available. |
| 659 | "response": { # The normal response of the operation in case of success. If the original |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 660 | # method returns no data on success, such as `Delete`, the response is |
| 661 | # `google.protobuf.Empty`. If the original method is standard |
| 662 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 663 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 664 | # is the original method name. For example, if the original method name |
| 665 | # is `TakeSnapshot()`, the inferred response type is |
| 666 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 667 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 668 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 669 | }</pre> |
| 670 | </div> |
| 671 | |
| 672 | </body></html> |