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

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

Dan O'Meara

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

2019-06-14 16:50:42 -0700

[diff] [blame]

82

<p class="firstline">Creates an instance.</p>

83

84

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

85

<p class="firstline">Deletes an instance.</p>

86

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

90

<code><a href="#list">list(parent, filter=None, pageToken=None, orderBy=None, pageSize=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

2019-06-14 16:50:42 -0700

[diff] [blame]

92

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

Dan O'Meara

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

2019-06-14 16:50:42 -0700

[diff] [blame]

97

<p class="firstline">Updates the settings of a specific instance.</p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

98

99

<code><a href="#restore">restore(name, body=None, x__xgafv=None)</a></code></p>

100

<p class="firstline">Restores an existing instance's file share from a snapshot or backup.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

101

<h3>Method Details</h3>

102

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

103

<code class="details" id="close">close()</code>

104

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

108

<code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

109

<pre>Creates an instance.

110

111

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

112

parent: string, Required. The instance's project and location, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

113

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

114

The object takes the form of:

115

116

{ # A Cloud Filestore instance.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

117

"description": "A String", # The description of the instance (2048 characters or less).

118

"labels": { # Resource labels to represent user provided metadata.

119

"a_key": "A String",

120

},

121

"fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.

122

{ # File share configuration for the instance.

123

"capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.

124

"sourceBackup": "A String", # The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.

125

"name": "A String", # The name of the file share (must be 16 characters or less).

126

"nfsExportOptions": [ # Nfs Export Options. There is a limit of 10 export options per file share.

127

{ # NFS export options specifications.

128

"ipRanges": [ # List of either an IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format {octet 1}.{octet 2}.{octet 3}.{octet 4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.

129

"A String",

130

],

131

"accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.

132

"anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

133

"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.

134

"anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

135

},

136

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

137

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

138

],

139

"statusMessage": "A String", # Output only. Additional information about the instance state, if available.

140

"state": "A String", # Output only. The instance state.

141

"name": "A String", # Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.

142

"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

143

"createTime": "A String", # Output only. The time when the instance was created.

144

"tier": "A String", # The service tier of the instance.

145

"networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.

146

{ # Network configuration for the instance.

147

"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}.

148

"A String",

149

],

150

"reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network.

151

"modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.

152

"A String",

153

],

154

"network": "A String", # The name of the Google Compute Engine [VPC network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected.

155

},

156

],

157

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

158

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

159

instanceId: string, Required. The ID of the instance to create. The ID must be unique within the specified project and location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

160

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

167

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

168

{ # This resource represents a long-running operation that is the result of a network API call.

169

"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.

170

"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`.

171

"a_key": "", # Properties of the object. Contains field @type with type URL.

172

},

173

"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.

174

"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

2020-07-22 17:02:09 -0700

[diff] [blame]

175

{

176

"a_key": "", # Properties of the object. Contains field @type with type URL.

177

},

178

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

179

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

180

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

181

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

182

"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

2020-07-22 17:02:09 -0700

[diff] [blame]

183

"a_key": "", # Properties of the object. Contains field @type with type URL.

184

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

185

"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}`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

191

<pre>Deletes an instance.

192

193

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

194

name: string, Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id} (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

195

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

202

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

203

{ # This resource represents a long-running operation that is the result of a network API call.

204

"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.

205

"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`.

206

"a_key": "", # Properties of the object. Contains field @type with type URL.

207

},

208

"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.

209

"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

2020-07-22 17:02:09 -0700

[diff] [blame]

210

{

211

"a_key": "", # Properties of the object. Contains field @type with type URL.

212

},

213

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

214

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

215

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

216

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

217

"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

2020-07-22 17:02:09 -0700

[diff] [blame]

218

"a_key": "", # Properties of the object. Contains field @type with type URL.

219

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

220

"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}`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

226

<pre>Gets the details of a specific instance.

227

228

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

229

name: string, Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

230

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

237

238

{ # A Cloud Filestore instance.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

239

"description": "A String", # The description of the instance (2048 characters or less).

240

"labels": { # Resource labels to represent user provided metadata.

241

"a_key": "A String",

242

},

243

"fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.

244

{ # File share configuration for the instance.

245

"capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.

246

"sourceBackup": "A String", # The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.

247

"name": "A String", # The name of the file share (must be 16 characters or less).

248

"nfsExportOptions": [ # Nfs Export Options. There is a limit of 10 export options per file share.

249

{ # NFS export options specifications.

250

"ipRanges": [ # List of either an IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format {octet 1}.{octet 2}.{octet 3}.{octet 4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.

251

"A String",

252

],

253

"accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.

254

"anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

255

"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.

256

"anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

257

},

258

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

259

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

260

],

261

"statusMessage": "A String", # Output only. Additional information about the instance state, if available.

262

"state": "A String", # Output only. The instance state.

263

"name": "A String", # Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.

264

"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

265

"createTime": "A String", # Output only. The time when the instance was created.

266

"tier": "A String", # The service tier of the instance.

267

"networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.

268

{ # Network configuration for the instance.

269

"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}.

270

"A String",

271

],

272

"reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network.

273

"modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.

274

"A String",

275

],

276

"network": "A String", # The name of the Google Compute Engine [VPC network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected.

277

},

278

],

279

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

283

<code class="details" id="list">list(parent, filter=None, pageToken=None, orderBy=None, pageSize=None, x__xgafv=None)</code>

284

<pre>Lists all instances in a project for either a specified location or for all locations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

285

286

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

287

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

2020-07-22 17:02:09 -0700

[diff] [blame]

288

filter: string, List filter.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

289

pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

290

orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).

291

pageSize: integer, The maximum number of items to return.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

292

x__xgafv: string, V1 error format.

293

Allowed values

294

1 - v1 error format

295

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

296

297

Returns:

298

An object of the form:

299

300

{ # ListInstancesResponse is the result of ListInstancesRequest.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

301

"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.

302

{ # A Cloud Filestore instance.

303

"description": "A String", # The description of the instance (2048 characters or less).

304

"labels": { # Resource labels to represent user provided metadata.

305

"a_key": "A String",

306

},

307

"fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.

308

{ # File share configuration for the instance.

309

"capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.

310

"sourceBackup": "A String", # The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.

311

"name": "A String", # The name of the file share (must be 16 characters or less).

312

"nfsExportOptions": [ # Nfs Export Options. There is a limit of 10 export options per file share.

313

{ # NFS export options specifications.

314

"ipRanges": [ # List of either an IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format {octet 1}.{octet 2}.{octet 3}.{octet 4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.

315

"A String",

316

],

317

"accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.

318

"anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

319

"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.

320

"anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

},

],

},

],

"statusMessage": "A String", # Output only. Additional information about the instance state, if available.

326

"state": "A String", # Output only. The instance state.

327

"name": "A String", # Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.

328

"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

329

"createTime": "A String", # Output only. The time when the instance was created.

330

"tier": "A String", # The service tier of the instance.

331

"networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.

332

{ # Network configuration for the instance.

333

"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}.

334

"A String",

335

],

336

"reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network.

337

"modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.

338

"A String",

339

],

340

"network": "A String", # The name of the Google Compute Engine [VPC network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected.

},

],

},

],

"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]

346

"unreachable": [ # Locations that could not be reached.

347

"A String",

348

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

354

<pre>Retrieves the next page of results.

355

356

Args:

357

previous_request: The request for the previous page. (required)

358

previous_response: The response from the request for the previous page. (required)

359

360

Returns:

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

361

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

362

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

367

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

368

<pre>Updates the settings of a specific instance.

369

370

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

371

name: string, Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

372

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

373

The object takes the form of:

374

375

{ # A Cloud Filestore instance.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

376

"description": "A String", # The description of the instance (2048 characters or less).

377

"labels": { # Resource labels to represent user provided metadata.

378

"a_key": "A String",

379

},

380

"fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.

381

{ # File share configuration for the instance.

382

"capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.

383

"sourceBackup": "A String", # The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.

384

"name": "A String", # The name of the file share (must be 16 characters or less).

385

"nfsExportOptions": [ # Nfs Export Options. There is a limit of 10 export options per file share.

386

{ # NFS export options specifications.

387

"ipRanges": [ # List of either an IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format {octet 1}.{octet 2}.{octet 3}.{octet 4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.

388

"A String",

389

],

390

"accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.

391

"anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

392

"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.

393

"anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

394

},

395

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

396

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

397

],

398

"statusMessage": "A String", # Output only. Additional information about the instance state, if available.

399

"state": "A String", # Output only. The instance state.

400

"name": "A String", # Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.

401

"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

402

"createTime": "A String", # Output only. The time when the instance was created.

403

"tier": "A String", # The service tier of the instance.

404

"networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.

405

{ # Network configuration for the instance.

406

"ipAddresses": [ # Output only. IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 7}:{block 8}.

407

"A String",

408

],

409

"reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network.

410

"modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.

411

"A String",

412

],

413

"network": "A String", # The name of the Google Compute Engine [VPC network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected.

414

},

415

],

416

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

417

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

418

updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * "description" * "file_shares" * "labels"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

419

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

426

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

427

{ # This resource represents a long-running operation that is the result of a network API call.

428

"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.

429

"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`.

430

"a_key": "", # Properties of the object. Contains field @type with type URL.

431

},

432

"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.

433

"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

2020-07-22 17:02:09 -0700

[diff] [blame]

434

{

435

"a_key": "", # Properties of the object. Contains field @type with type URL.

436

},

437

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

438

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

439

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

440

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

441

"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

2020-07-22 17:02:09 -0700

[diff] [blame]

442

"a_key": "", # Properties of the object. Contains field @type with type URL.

443

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

444

"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}`.

}</pre>

</div>

<code class="details" id="restore">restore(name, body=None, x__xgafv=None)</code>

450

<pre>Restores an existing instance's file share from a snapshot or backup.

451

452

Args:

453

name: string, Required. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}. (required)

454

body: object, The request body.

455

The object takes the form of:

456

457

{ # RestoreInstanceRequest restores an existing instances's file share from a snapshot or backup.

458

"fileShare": "A String", # Required. Name of the file share in the Cloud Filestore instance that the snapshot is being restored to.

459

"sourceSnapshot": "A String", # The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/snapshots/{snapshot_id}.

460

"sourceBackup": "A String", # The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.

461

}

462

463

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

470

471

{ # This resource represents a long-running operation that is the result of a network API call.

472

"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.

473

"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`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

474

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

475

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

476

"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.

477

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

478

{

479

"a_key": "", # Properties of the object. Contains field @type with type URL.

480

},

481

],

482

"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.

483

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

484

},

485

"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.

486

"a_key": "", # Properties of the object. Contains field @type with type URL.

487

},

488

"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}`.

Bu Sun Kim