1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="netapp_v1.html">NetApp API</a> . <a href="netapp_v1.projects.html">projects</a> . <a href="netapp_v1.projects.locations.html">locations</a> . <a href="netapp_v1.projects.locations.volumes.html">volumes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="netapp_v1.projects.locations.volumes.quotaRules.html">quotaRules()</a></code>
</p>
<p class="firstline">Returns the quotaRules Resource.</p>
<p class="toc_element">
<code><a href="netapp_v1.projects.locations.volumes.replications.html">replications()</a></code>
</p>
<p class="firstline">Returns the replications Resource.</p>
<p class="toc_element">
<code><a href="netapp_v1.projects.locations.volumes.snapshots.html">snapshots()</a></code>
</p>
<p class="firstline">Returns the snapshots Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, volumeId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Volume in a given project and location.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single Volume.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single Volume.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Volumes in a given project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the parameters of a single Volume.</p>
<p class="toc_element">
<code><a href="#revert">revert(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Revert an existing volume to a specified snapshot. Warning! This operation will permanently revert all changes made after the snapshot was created.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, volumeId=None, x__xgafv=None)</code>
<pre>Creates a new Volume in a given project and location.
Args:
parent: string, Required. Value for parent. (required)
body: object, The request body.
The object takes the form of:
{ # Volume provides a filesystem that you can mount.
"activeDirectory": "A String", # Output only. Specifies the ActiveDirectory name of a SMB volume.
"backupConfig": { # BackupConfig contains backup related config on a volume. # BackupConfig of the volume.
"backupChainBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).
"backupPolicies": [ # Optional. When specified, schedule backups will be created based on the policy configuration.
"A String",
],
"backupVault": "A String", # Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
"scheduledBackupEnabled": True or False, # Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.
},
"capacityGib": "A String", # Required. Capacity in GIB of the volume
"coldTierSizeGib": "A String", # Output only. Size of the volume cold tier data rounded down to the nearest GiB.
"createTime": "A String", # Output only. Create time of the volume
"description": "A String", # Optional. Description of the volume
"encryptionType": "A String", # Output only. Specified the current volume encryption key source.
"exportPolicy": { # Defines the export policy for the volume. # Optional. Export policy of the volume
"rules": [ # Required. List of export policy rules
{ # An export policy rule describing various export options.
"accessType": "A String", # Access type (ReadWrite, ReadOnly, None)
"allowedClients": "A String", # Comma separated list of allowed clients IP addresses
"hasRootAccess": "A String", # Whether Unix root access will be granted.
"kerberos5ReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.
"kerberos5ReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled.
"kerberos5iReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.
"kerberos5iReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value be ignored if this is enabled.
"kerberos5pReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.
"kerberos5pReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value be ignored if this is enabled.
"nfsv3": True or False, # NFS V3 protocol.
"nfsv4": True or False, # NFS V4 protocol.
},
],
},
"hasReplication": True or False, # Output only. Indicates whether the volume is part of a replication relationship.
"hybridReplicationParameters": { # The Hybrid Replication parameters for the volume. # Optional. The Hybrid Replication parameters for the volume.
"clusterLocation": "A String", # Optional. Name of source cluster location associated with the Hybrid replication. This is a free-form field for the display purpose only.
"description": "A String", # Optional. Description of the replication.
"hybridReplicationType": "A String", # Optional. Type of the hybrid replication.
"labels": { # Optional. Labels to be added to the replication as the key value pairs.
"a_key": "A String",
},
"largeVolumeConstituentCount": 42, # Optional. Constituent volume count for large volume.
"peerClusterName": "A String", # Required. Name of the user's local source cluster to be peered with the destination cluster.
"peerIpAddresses": [ # Required. List of node ip addresses to be peered with.
"A String",
],
"peerSvmName": "A String", # Required. Name of the user's local source vserver svm to be peered with the destination vserver svm.
"peerVolumeName": "A String", # Required. Name of the user's local source volume to be peered with the destination volume.
"replication": "A String", # Required. Desired name for the replication of this volume.
"replicationSchedule": "A String", # Optional. Replication Schedule for the replication created.
},
"kerberosEnabled": True or False, # Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
"kmsConfig": "A String", # Output only. Specifies the KMS config to be used for volume encryption.
"labels": { # Optional. Labels as key value pairs
"a_key": "A String",
},
"largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
"ldapEnabled": True or False, # Output only. Flag indicating if the volume is NFS LDAP enabled or not.
"mountOptions": [ # Output only. Mount options of this volume
{ # View only mount options for a volume.
"export": "A String", # Export string
"exportFull": "A String", # Full export string
"instructions": "A String", # Instructions for mounting
"ipAddress": "A String", # Output only. IP Address.
"protocol": "A String", # Protocol to mount with.
},
],
"multipleEndpoints": True or False, # Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.
"name": "A String", # Identifier. Name of the volume
"network": "A String", # Output only. VPC Network name. Format: projects/{project}/global/networks/{network}
"protocols": [ # Required. Protocols required for the volume
"A String",
],
"psaRange": "A String", # Output only. This field is not implemented. The values provided in this field are ignored.
"replicaZone": "A String", # Output only. Specifies the replica zone for regional volume.
"restoreParameters": { # The RestoreParameters if volume is created from a snapshot or backup. # Optional. Specifies the source of the volume to be created from.
"sourceBackup": "A String", # Full name of the backup resource. Format: projects/{project}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}
"sourceSnapshot": "A String", # Full name of the snapshot resource. Format: projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot}
},
"restrictedActions": [ # Optional. List of actions that are restricted on this volume.
"A String",
],
"securityStyle": "A String", # Optional. Security Style of the Volume
"serviceLevel": "A String", # Output only. Service level of the volume
"shareName": "A String", # Required. Share name of the volume
"smbSettings": [ # Optional. SMB share settings for the volume.
"A String",
],
"snapReserve": 3.14, # Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.
"snapshotDirectory": True or False, # Optional. Snapshot_directory if enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots.
"snapshotPolicy": { # Snapshot Policy for a volume. # Optional. SnapshotPolicy for a volume.
"dailySchedule": { # Make a snapshot every day e.g. at 04:00, 05:20, 23:50 # Daily schedule policy.
"hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
"minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
"snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
},
"enabled": True or False, # If enabled, make snapshots automatically according to the schedules. Default is false.
"hourlySchedule": { # Make a snapshot every hour e.g. at 04:00, 05:00, 06:00. # Hourly schedule policy.
"minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
"snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
},
"monthlySchedule": { # Make a snapshot once a month e.g. at 2nd 04:00, 7th 05:20, 24th 23:50 # Monthly schedule policy.
"daysOfMonth": "A String", # Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.
"hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
"minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
"snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
},
"weeklySchedule": { # Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20, Sunday 23:50 # Weekly schedule policy.
"day": "A String", # Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.
"hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
"minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
"snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
},
},
"state": "A String", # Output only. State of the volume
"stateDetails": "A String", # Output only. State details of the volume
"storagePool": "A String", # Required. StoragePool name of the volume
"throughputMibps": 3.14, # Optional. Throughput of the volume (in MiB/s)
"tieringPolicy": { # Defines tiering policy for the volume. # Tiering policy for the volume.
"coolingThresholdDays": 42, # Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31.
"hotTierBypassModeEnabled": True or False, # Optional. Flag indicating that the hot tier bypass mode is enabled. Default is false. This is only applicable to Flex service level.
"tierAction": "A String", # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
},
"unixPermissions": "A String", # Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.
"usedGib": "A String", # Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.
"zone": "A String", # Output only. Specifies the active zone for regional volume.
}
volumeId: string, Required. Id of the requesting volume. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>
<pre>Deletes a single Volume.
Args:
name: string, Required. Name of the volume (required)
force: boolean, If this field is set as true, CCFE will not block the volume resource deletion even if it has any snapshots resource. (Otherwise, the request will only work if the volume has no snapshots.)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single Volume.
Args:
name: string, Required. Name of the volume (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Volume provides a filesystem that you can mount.
"activeDirectory": "A String", # Output only. Specifies the ActiveDirectory name of a SMB volume.
"backupConfig": { # BackupConfig contains backup related config on a volume. # BackupConfig of the volume.
"backupChainBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).
"backupPolicies": [ # Optional. When specified, schedule backups will be created based on the policy configuration.
"A String",
],
"backupVault": "A String", # Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
"scheduledBackupEnabled": True or False, # Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.
},
"capacityGib": "A String", # Required. Capacity in GIB of the volume
"coldTierSizeGib": "A String", # Output only. Size of the volume cold tier data rounded down to the nearest GiB.
"createTime": "A String", # Output only. Create time of the volume
"description": "A String", # Optional. Description of the volume
"encryptionType": "A String", # Output only. Specified the current volume encryption key source.
"exportPolicy": { # Defines the export policy for the volume. # Optional. Export policy of the volume
"rules": [ # Required. List of export policy rules
{ # An export policy rule describing various export options.
"accessType": "A String", # Access type (ReadWrite, ReadOnly, None)
"allowedClients": "A String", # Comma separated list of allowed clients IP addresses
"hasRootAccess": "A String", # Whether Unix root access will be granted.
"kerberos5ReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.
"kerberos5ReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled.
"kerberos5iReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.
"kerberos5iReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value be ignored if this is enabled.
"kerberos5pReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.
"kerberos5pReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value be ignored if this is enabled.
"nfsv3": True or False, # NFS V3 protocol.
"nfsv4": True or False, # NFS V4 protocol.
},
],
},
"hasReplication": True or False, # Output only. Indicates whether the volume is part of a replication relationship.
"hybridReplicationParameters": { # The Hybrid Replication parameters for the volume. # Optional. The Hybrid Replication parameters for the volume.
"clusterLocation": "A String", # Optional. Name of source cluster location associated with the Hybrid replication. This is a free-form field for the display purpose only.
"description": "A String", # Optional. Description of the replication.
"hybridReplicationType": "A String", # Optional. Type of the hybrid replication.
"labels": { # Optional. Labels to be added to the replication as the key value pairs.
"a_key": "A String",
},
"largeVolumeConstituentCount": 42, # Optional. Constituent volume count for large volume.
"peerClusterName": "A String", # Required. Name of the user's local source cluster to be peered with the destination cluster.
"peerIpAddresses": [ # Required. List of node ip addresses to be peered with.
"A String",
],
"peerSvmName": "A String", # Required. Name of the user's local source vserver svm to be peered with the destination vserver svm.
"peerVolumeName": "A String", # Required. Name of the user's local source volume to be peered with the destination volume.
"replication": "A String", # Required. Desired name for the replication of this volume.
"replicationSchedule": "A String", # Optional. Replication Schedule for the replication created.
},
"kerberosEnabled": True or False, # Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
"kmsConfig": "A String", # Output only. Specifies the KMS config to be used for volume encryption.
"labels": { # Optional. Labels as key value pairs
"a_key": "A String",
},
"largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
"ldapEnabled": True or False, # Output only. Flag indicating if the volume is NFS LDAP enabled or not.
"mountOptions": [ # Output only. Mount options of this volume
{ # View only mount options for a volume.
"export": "A String", # Export string
"exportFull": "A String", # Full export string
"instructions": "A String", # Instructions for mounting
"ipAddress": "A String", # Output only. IP Address.
"protocol": "A String", # Protocol to mount with.
},
],
"multipleEndpoints": True or False, # Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.
"name": "A String", # Identifier. Name of the volume
"network": "A String", # Output only. VPC Network name. Format: projects/{project}/global/networks/{network}
"protocols": [ # Required. Protocols required for the volume
"A String",
],
"psaRange": "A String", # Output only. This field is not implemented. The values provided in this field are ignored.
"replicaZone": "A String", # Output only. Specifies the replica zone for regional volume.
"restoreParameters": { # The RestoreParameters if volume is created from a snapshot or backup. # Optional. Specifies the source of the volume to be created from.
"sourceBackup": "A String", # Full name of the backup resource. Format: projects/{project}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}
"sourceSnapshot": "A String", # Full name of the snapshot resource. Format: projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot}
},
"restrictedActions": [ # Optional. List of actions that are restricted on this volume.
"A String",
],
"securityStyle": "A String", # Optional. Security Style of the Volume
"serviceLevel": "A String", # Output only. Service level of the volume
"shareName": "A String", # Required. Share name of the volume
"smbSettings": [ # Optional. SMB share settings for the volume.
"A String",
],
"snapReserve": 3.14, # Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.
"snapshotDirectory": True or False, # Optional. Snapshot_directory if enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots.
"snapshotPolicy": { # Snapshot Policy for a volume. # Optional. SnapshotPolicy for a volume.
"dailySchedule": { # Make a snapshot every day e.g. at 04:00, 05:20, 23:50 # Daily schedule policy.
"hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
"minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
"snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
},
"enabled": True or False, # If enabled, make snapshots automatically according to the schedules. Default is false.
"hourlySchedule": { # Make a snapshot every hour e.g. at 04:00, 05:00, 06:00. # Hourly schedule policy.
"minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
"snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
},
"monthlySchedule": { # Make a snapshot once a month e.g. at 2nd 04:00, 7th 05:20, 24th 23:50 # Monthly schedule policy.
"daysOfMonth": "A String", # Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.
"hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
"minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
"snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
},
"weeklySchedule": { # Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20, Sunday 23:50 # Weekly schedule policy.
"day": "A String", # Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.
"hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
"minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
"snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
},
},
"state": "A String", # Output only. State of the volume
"stateDetails": "A String", # Output only. State details of the volume
"storagePool": "A String", # Required. StoragePool name of the volume
"throughputMibps": 3.14, # Optional. Throughput of the volume (in MiB/s)
"tieringPolicy": { # Defines tiering policy for the volume. # Tiering policy for the volume.
"coolingThresholdDays": 42, # Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31.
"hotTierBypassModeEnabled": True or False, # Optional. Flag indicating that the hot tier bypass mode is enabled. Default is false. This is only applicable to Flex service level.
"tierAction": "A String", # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
},
"unixPermissions": "A String", # Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.
"usedGib": "A String", # Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.
"zone": "A String", # Output only. Specifies the active zone for regional volume.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Volumes in a given project.
Args:
parent: string, Required. Parent value for ListVolumesRequest (required)
filter: string, Filtering results
orderBy: string, Hint for how to order the results
pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
pageToken: string, A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for response to listing Volumes
"nextPageToken": "A String", # A token identifying a page of results the server should return.
"unreachable": [ # Locations that could not be reached.
"A String",
],
"volumes": [ # The list of Volume
{ # Volume provides a filesystem that you can mount.
"activeDirectory": "A String", # Output only. Specifies the ActiveDirectory name of a SMB volume.
"backupConfig": { # BackupConfig contains backup related config on a volume. # BackupConfig of the volume.
"backupChainBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).
"backupPolicies": [ # Optional. When specified, schedule backups will be created based on the policy configuration.
"A String",
],
"backupVault": "A String", # Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
"scheduledBackupEnabled": True or False, # Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.
},
"capacityGib": "A String", # Required. Capacity in GIB of the volume
"coldTierSizeGib": "A String", # Output only. Size of the volume cold tier data rounded down to the nearest GiB.
"createTime": "A String", # Output only. Create time of the volume
"description": "A String", # Optional. Description of the volume
"encryptionType": "A String", # Output only. Specified the current volume encryption key source.
"exportPolicy": { # Defines the export policy for the volume. # Optional. Export policy of the volume
"rules": [ # Required. List of export policy rules
{ # An export policy rule describing various export options.
"accessType": "A String", # Access type (ReadWrite, ReadOnly, None)
"allowedClients": "A String", # Comma separated list of allowed clients IP addresses
"hasRootAccess": "A String", # Whether Unix root access will be granted.
"kerberos5ReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.
"kerberos5ReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled.
"kerberos5iReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.
"kerberos5iReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value be ignored if this is enabled.
"kerberos5pReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.
"kerberos5pReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value be ignored if this is enabled.
"nfsv3": True or False, # NFS V3 protocol.
"nfsv4": True or False, # NFS V4 protocol.
},
],
},
"hasReplication": True or False, # Output only. Indicates whether the volume is part of a replication relationship.
"hybridReplicationParameters": { # The Hybrid Replication parameters for the volume. # Optional. The Hybrid Replication parameters for the volume.
"clusterLocation": "A String", # Optional. Name of source cluster location associated with the Hybrid replication. This is a free-form field for the display purpose only.
"description": "A String", # Optional. Description of the replication.
"hybridReplicationType": "A String", # Optional. Type of the hybrid replication.
"labels": { # Optional. Labels to be added to the replication as the key value pairs.
"a_key": "A String",
},
"largeVolumeConstituentCount": 42, # Optional. Constituent volume count for large volume.
"peerClusterName": "A String", # Required. Name of the user's local source cluster to be peered with the destination cluster.
"peerIpAddresses": [ # Required. List of node ip addresses to be peered with.
"A String",
],
"peerSvmName": "A String", # Required. Name of the user's local source vserver svm to be peered with the destination vserver svm.
"peerVolumeName": "A String", # Required. Name of the user's local source volume to be peered with the destination volume.
"replication": "A String", # Required. Desired name for the replication of this volume.
"replicationSchedule": "A String", # Optional. Replication Schedule for the replication created.
},
"kerberosEnabled": True or False, # Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
"kmsConfig": "A String", # Output only. Specifies the KMS config to be used for volume encryption.
"labels": { # Optional. Labels as key value pairs
"a_key": "A String",
},
"largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
"ldapEnabled": True or False, # Output only. Flag indicating if the volume is NFS LDAP enabled or not.
"mountOptions": [ # Output only. Mount options of this volume
{ # View only mount options for a volume.
"export": "A String", # Export string
"exportFull": "A String", # Full export string
"instructions": "A String", # Instructions for mounting
"ipAddress": "A String", # Output only. IP Address.
"protocol": "A String", # Protocol to mount with.
},
],
"multipleEndpoints": True or False, # Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.
"name": "A String", # Identifier. Name of the volume
"network": "A String", # Output only. VPC Network name. Format: projects/{project}/global/networks/{network}
"protocols": [ # Required. Protocols required for the volume
"A String",
],
"psaRange": "A String", # Output only. This field is not implemented. The values provided in this field are ignored.
"replicaZone": "A String", # Output only. Specifies the replica zone for regional volume.
"restoreParameters": { # The RestoreParameters if volume is created from a snapshot or backup. # Optional. Specifies the source of the volume to be created from.
"sourceBackup": "A String", # Full name of the backup resource. Format: projects/{project}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}
"sourceSnapshot": "A String", # Full name of the snapshot resource. Format: projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot}
},
"restrictedActions": [ # Optional. List of actions that are restricted on this volume.
"A String",
],
"securityStyle": "A String", # Optional. Security Style of the Volume
"serviceLevel": "A String", # Output only. Service level of the volume
"shareName": "A String", # Required. Share name of the volume
"smbSettings": [ # Optional. SMB share settings for the volume.
"A String",
],
"snapReserve": 3.14, # Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.
"snapshotDirectory": True or False, # Optional. Snapshot_directory if enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots.
"snapshotPolicy": { # Snapshot Policy for a volume. # Optional. SnapshotPolicy for a volume.
"dailySchedule": { # Make a snapshot every day e.g. at 04:00, 05:20, 23:50 # Daily schedule policy.
"hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
"minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
"snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
},
"enabled": True or False, # If enabled, make snapshots automatically according to the schedules. Default is false.
"hourlySchedule": { # Make a snapshot every hour e.g. at 04:00, 05:00, 06:00. # Hourly schedule policy.
"minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
"snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
},
"monthlySchedule": { # Make a snapshot once a month e.g. at 2nd 04:00, 7th 05:20, 24th 23:50 # Monthly schedule policy.
"daysOfMonth": "A String", # Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.
"hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
"minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
"snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
},
"weeklySchedule": { # Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20, Sunday 23:50 # Weekly schedule policy.
"day": "A String", # Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.
"hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
"minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
"snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
},
},
"state": "A String", # Output only. State of the volume
"stateDetails": "A String", # Output only. State details of the volume
"storagePool": "A String", # Required. StoragePool name of the volume
"throughputMibps": 3.14, # Optional. Throughput of the volume (in MiB/s)
"tieringPolicy": { # Defines tiering policy for the volume. # Tiering policy for the volume.
"coolingThresholdDays": 42, # Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31.
"hotTierBypassModeEnabled": True or False, # Optional. Flag indicating that the hot tier bypass mode is enabled. Default is false. This is only applicable to Flex service level.
"tierAction": "A String", # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
},
"unixPermissions": "A String", # Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.
"usedGib": "A String", # Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.
"zone": "A String", # Output only. Specifies the active zone for regional volume.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the parameters of a single Volume.
Args:
name: string, Identifier. Name of the volume (required)
body: object, The request body.
The object takes the form of:
{ # Volume provides a filesystem that you can mount.
"activeDirectory": "A String", # Output only. Specifies the ActiveDirectory name of a SMB volume.
"backupConfig": { # BackupConfig contains backup related config on a volume. # BackupConfig of the volume.
"backupChainBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).
"backupPolicies": [ # Optional. When specified, schedule backups will be created based on the policy configuration.
"A String",
],
"backupVault": "A String", # Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
"scheduledBackupEnabled": True or False, # Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.
},
"capacityGib": "A String", # Required. Capacity in GIB of the volume
"coldTierSizeGib": "A String", # Output only. Size of the volume cold tier data rounded down to the nearest GiB.
"createTime": "A String", # Output only. Create time of the volume
"description": "A String", # Optional. Description of the volume
"encryptionType": "A String", # Output only. Specified the current volume encryption key source.
"exportPolicy": { # Defines the export policy for the volume. # Optional. Export policy of the volume
"rules": [ # Required. List of export policy rules
{ # An export policy rule describing various export options.
"accessType": "A String", # Access type (ReadWrite, ReadOnly, None)
"allowedClients": "A String", # Comma separated list of allowed clients IP addresses
"hasRootAccess": "A String", # Whether Unix root access will be granted.
"kerberos5ReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode.
"kerberos5ReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled.
"kerberos5iReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode.
"kerberos5iReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'integrity' kerberos security mode. The 'kerberos5iReadOnly' value be ignored if this is enabled.
"kerberos5pReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode.
"kerberos5pReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'privacy' kerberos security mode. The 'kerberos5pReadOnly' value be ignored if this is enabled.
"nfsv3": True or False, # NFS V3 protocol.
"nfsv4": True or False, # NFS V4 protocol.
},
],
},
"hasReplication": True or False, # Output only. Indicates whether the volume is part of a replication relationship.
"hybridReplicationParameters": { # The Hybrid Replication parameters for the volume. # Optional. The Hybrid Replication parameters for the volume.
"clusterLocation": "A String", # Optional. Name of source cluster location associated with the Hybrid replication. This is a free-form field for the display purpose only.
"description": "A String", # Optional. Description of the replication.
"hybridReplicationType": "A String", # Optional. Type of the hybrid replication.
"labels": { # Optional. Labels to be added to the replication as the key value pairs.
"a_key": "A String",
},
"largeVolumeConstituentCount": 42, # Optional. Constituent volume count for large volume.
"peerClusterName": "A String", # Required. Name of the user's local source cluster to be peered with the destination cluster.
"peerIpAddresses": [ # Required. List of node ip addresses to be peered with.
"A String",
],
"peerSvmName": "A String", # Required. Name of the user's local source vserver svm to be peered with the destination vserver svm.
"peerVolumeName": "A String", # Required. Name of the user's local source volume to be peered with the destination volume.
"replication": "A String", # Required. Desired name for the replication of this volume.
"replicationSchedule": "A String", # Optional. Replication Schedule for the replication created.
},
"kerberosEnabled": True or False, # Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
"kmsConfig": "A String", # Output only. Specifies the KMS config to be used for volume encryption.
"labels": { # Optional. Labels as key value pairs
"a_key": "A String",
},
"largeCapacity": True or False, # Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
"ldapEnabled": True or False, # Output only. Flag indicating if the volume is NFS LDAP enabled or not.
"mountOptions": [ # Output only. Mount options of this volume
{ # View only mount options for a volume.
"export": "A String", # Export string
"exportFull": "A String", # Full export string
"instructions": "A String", # Instructions for mounting
"ipAddress": "A String", # Output only. IP Address.
"protocol": "A String", # Protocol to mount with.
},
],
"multipleEndpoints": True or False, # Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.
"name": "A String", # Identifier. Name of the volume
"network": "A String", # Output only. VPC Network name. Format: projects/{project}/global/networks/{network}
"protocols": [ # Required. Protocols required for the volume
"A String",
],
"psaRange": "A String", # Output only. This field is not implemented. The values provided in this field are ignored.
"replicaZone": "A String", # Output only. Specifies the replica zone for regional volume.
"restoreParameters": { # The RestoreParameters if volume is created from a snapshot or backup. # Optional. Specifies the source of the volume to be created from.
"sourceBackup": "A String", # Full name of the backup resource. Format: projects/{project}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}
"sourceSnapshot": "A String", # Full name of the snapshot resource. Format: projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot}
},
"restrictedActions": [ # Optional. List of actions that are restricted on this volume.
"A String",
],
"securityStyle": "A String", # Optional. Security Style of the Volume
"serviceLevel": "A String", # Output only. Service level of the volume
"shareName": "A String", # Required. Share name of the volume
"smbSettings": [ # Optional. SMB share settings for the volume.
"A String",
],
"snapReserve": 3.14, # Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.
"snapshotDirectory": True or False, # Optional. Snapshot_directory if enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots.
"snapshotPolicy": { # Snapshot Policy for a volume. # Optional. SnapshotPolicy for a volume.
"dailySchedule": { # Make a snapshot every day e.g. at 04:00, 05:20, 23:50 # Daily schedule policy.
"hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
"minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
"snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
},
"enabled": True or False, # If enabled, make snapshots automatically according to the schedules. Default is false.
"hourlySchedule": { # Make a snapshot every hour e.g. at 04:00, 05:00, 06:00. # Hourly schedule policy.
"minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
"snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
},
"monthlySchedule": { # Make a snapshot once a month e.g. at 2nd 04:00, 7th 05:20, 24th 23:50 # Monthly schedule policy.
"daysOfMonth": "A String", # Set the day or days of the month to make a snapshot (1-31). Accepts a comma separated number of days. Defaults to '1'.
"hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
"minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
"snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
},
"weeklySchedule": { # Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20, Sunday 23:50 # Weekly schedule policy.
"day": "A String", # Set the day or days of the week to make a snapshot. Accepts a comma separated days of the week. Defaults to 'Sunday'.
"hour": 3.14, # Set the hour to start the snapshot (0-23), defaults to midnight (0).
"minute": 3.14, # Set the minute of the hour to start the snapshot (0-59), defaults to the top of the hour (0).
"snapshotsToKeep": 3.14, # The maximum number of Snapshots to keep for the hourly schedule
},
},
"state": "A String", # Output only. State of the volume
"stateDetails": "A String", # Output only. State details of the volume
"storagePool": "A String", # Required. StoragePool name of the volume
"throughputMibps": 3.14, # Optional. Throughput of the volume (in MiB/s)
"tieringPolicy": { # Defines tiering policy for the volume. # Tiering policy for the volume.
"coolingThresholdDays": 42, # Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31.
"hotTierBypassModeEnabled": True or False, # Optional. Flag indicating that the hot tier bypass mode is enabled. Default is false. This is only applicable to Flex service level.
"tierAction": "A String", # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
},
"unixPermissions": "A String", # Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.
"usedGib": "A String", # Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.
"zone": "A String", # Output only. Specifies the active zone for regional volume.
}
updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Volume resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="revert">revert(name, body=None, x__xgafv=None)</code>
<pre>Revert an existing volume to a specified snapshot. Warning! This operation will permanently revert all changes made after the snapshot was created.
Args:
name: string, Required. The resource name of the volume, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}. (required)
body: object, The request body.
The object takes the form of:
{ # RevertVolumeRequest reverts the given volume to the specified snapshot.
"snapshotId": "A String", # Required. The snapshot resource ID, in the format 'my-snapshot', where the specified ID is the {snapshot_id} of the fully qualified name like projects/{project_id}/locations/{location_id}/volumes/{volume_id}/snapshots/{snapshot_id}
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>
|
