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
|
<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_v1beta1.html">NetApp API</a> . <a href="netapp_v1beta1.projects.html">projects</a> . <a href="netapp_v1beta1.projects.locations.html">locations</a> . <a href="netapp_v1beta1.projects.locations.volumes.html">volumes</a> . <a href="netapp_v1beta1.projects.locations.volumes.replications.html">replications</a></h1>
<h2>Instance Methods</h2>
<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, replicationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a new replication for a volume.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a replication.</p>
<p class="toc_element">
<code><a href="#establishPeering">establishPeering(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Establish replication peering.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Describe a replication for a 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">Returns descriptions of all replications for a volume.</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 settings of a specific replication.</p>
<p class="toc_element">
<code><a href="#resume">resume(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Resume Cross Region Replication.</p>
<p class="toc_element">
<code><a href="#reverseDirection">reverseDirection(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Reverses direction of replication. Source becomes destination and destination becomes source.</p>
<p class="toc_element">
<code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Stop Cross Region Replication.</p>
<p class="toc_element">
<code><a href="#sync">sync(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Syncs the replication. This will invoke one time volume data transfer from source to destination.</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, replicationId=None, x__xgafv=None)</code>
<pre>Create a new replication for a volume.
Args:
parent: string, Required. The NetApp volume to create the replications of, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}` (required)
body: object, The request body.
The object takes the form of:
{ # Replication is a nested resource under Volume, that describes a cross-region replication relationship between 2 volumes in different regions.
"clusterLocation": "A String", # Optional. Location of the user cluster.
"createTime": "A String", # Output only. Replication create time.
"description": "A String", # A description about this replication relationship.
"destinationVolume": "A String", # Output only. Full name of destination volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
"destinationVolumeParameters": { # DestinationVolumeParameters specify input parameters used for creating destination volume. # Required. Input only. Destination volume parameters
"description": "A String", # Description for the destination volume.
"shareName": "A String", # Destination volume's share name. If not specified, source volume's share name will be used.
"storagePool": "A String", # Required. Existing destination StoragePool name.
"tieringPolicy": { # Defines tiering policy for the volume. # Optional. 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.
},
"volumeId": "A String", # Desired destination volume resource id. If not specified, source volume's resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
},
"healthy": True or False, # Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.
"hybridPeeringDetails": { # HybridPeeringDetails contains details about the hybrid peering. # Output only. Hybrid peering details.
"command": "A String", # Output only. Copy-paste-able commands to be used on user's ONTAP to accept peering requests.
"commandExpiryTime": "A String", # Output only. Expiration time for the peering command to be executed on user's ONTAP.
"passphrase": "A String", # Output only. Temporary passphrase generated to accept cluster peering command.
"peerClusterName": "A String", # Output only. Name of the user's local source cluster to be peered with the destination cluster.
"peerSvmName": "A String", # Output only. Name of the user's local source vserver svm to be peered with the destination vserver svm.
"peerVolumeName": "A String", # Output only. Name of the user's local source volume to be peered with the destination volume.
"subnetIp": "A String", # Output only. IP address of the subnet.
},
"hybridReplicationType": "A String", # Output only. Type of the hybrid replication.
"hybridReplicationUserCommands": { # UserCommands contains the commands to be executed by the customer. # Output only. Copy pastable snapmirror commands to be executed on onprem cluster by the customer.
"commands": [ # Output only. List of commands to be executed by the customer.
"A String",
],
},
"labels": { # Resource labels to represent user provided metadata.
"a_key": "A String",
},
"mirrorState": "A String", # Output only. Indicates the state of mirroring.
"name": "A String", # Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.
"replicationSchedule": "A String", # Required. Indicates the schedule for replication.
"role": "A String", # Output only. Indicates whether this points to source or destination.
"sourceVolume": "A String", # Output only. Full name of source volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
"state": "A String", # Output only. State of the replication.
"stateDetails": "A String", # Output only. State details of the replication.
"transferStats": { # TransferStats reports all statistics related to replication transfer. # Output only. Replication transfer statistics.
"lagDuration": "A String", # Lag duration indicates the duration by which Destination region volume content lags behind the primary region volume content.
"lastTransferBytes": "A String", # Last transfer size in bytes.
"lastTransferDuration": "A String", # Time taken during last transfer.
"lastTransferEndTime": "A String", # Time when last transfer completed.
"lastTransferError": "A String", # A message describing the cause of the last transfer failure.
"totalTransferDuration": "A String", # Cumulative time taken across all transfers for the replication relationship.
"transferBytes": "A String", # Cumulative bytes transferred so far for the replication relationship.
"updateTime": "A String", # Time when progress was updated last.
},
}
replicationId: string, Required. ID of the replication to create. 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, x__xgafv=None)</code>
<pre>Deletes a replication.
Args:
name: string, Required. The replication resource name, in the format `projects/*/locations/*/volumes/*/replications/{replication_id}` (required)
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="establishPeering">establishPeering(name, body=None, x__xgafv=None)</code>
<pre>Establish replication peering.
Args:
name: string, Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}. (required)
body: object, The request body.
The object takes the form of:
{ # EstablishPeeringRequest establishes cluster and svm peerings between the source and the destination replications.
"peerClusterName": "A String", # Required. Name of the user's local source cluster to be peered with the destination cluster.
"peerIpAddresses": [ # Optional. List of IPv4 ip addresses to be used for peering.
"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.
}
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>Describe a replication for a volume.
Args:
name: string, Required. The replication resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Replication is a nested resource under Volume, that describes a cross-region replication relationship between 2 volumes in different regions.
"clusterLocation": "A String", # Optional. Location of the user cluster.
"createTime": "A String", # Output only. Replication create time.
"description": "A String", # A description about this replication relationship.
"destinationVolume": "A String", # Output only. Full name of destination volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
"destinationVolumeParameters": { # DestinationVolumeParameters specify input parameters used for creating destination volume. # Required. Input only. Destination volume parameters
"description": "A String", # Description for the destination volume.
"shareName": "A String", # Destination volume's share name. If not specified, source volume's share name will be used.
"storagePool": "A String", # Required. Existing destination StoragePool name.
"tieringPolicy": { # Defines tiering policy for the volume. # Optional. 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.
},
"volumeId": "A String", # Desired destination volume resource id. If not specified, source volume's resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
},
"healthy": True or False, # Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.
"hybridPeeringDetails": { # HybridPeeringDetails contains details about the hybrid peering. # Output only. Hybrid peering details.
"command": "A String", # Output only. Copy-paste-able commands to be used on user's ONTAP to accept peering requests.
"commandExpiryTime": "A String", # Output only. Expiration time for the peering command to be executed on user's ONTAP.
"passphrase": "A String", # Output only. Temporary passphrase generated to accept cluster peering command.
"peerClusterName": "A String", # Output only. Name of the user's local source cluster to be peered with the destination cluster.
"peerSvmName": "A String", # Output only. Name of the user's local source vserver svm to be peered with the destination vserver svm.
"peerVolumeName": "A String", # Output only. Name of the user's local source volume to be peered with the destination volume.
"subnetIp": "A String", # Output only. IP address of the subnet.
},
"hybridReplicationType": "A String", # Output only. Type of the hybrid replication.
"hybridReplicationUserCommands": { # UserCommands contains the commands to be executed by the customer. # Output only. Copy pastable snapmirror commands to be executed on onprem cluster by the customer.
"commands": [ # Output only. List of commands to be executed by the customer.
"A String",
],
},
"labels": { # Resource labels to represent user provided metadata.
"a_key": "A String",
},
"mirrorState": "A String", # Output only. Indicates the state of mirroring.
"name": "A String", # Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.
"replicationSchedule": "A String", # Required. Indicates the schedule for replication.
"role": "A String", # Output only. Indicates whether this points to source or destination.
"sourceVolume": "A String", # Output only. Full name of source volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
"state": "A String", # Output only. State of the replication.
"stateDetails": "A String", # Output only. State details of the replication.
"transferStats": { # TransferStats reports all statistics related to replication transfer. # Output only. Replication transfer statistics.
"lagDuration": "A String", # Lag duration indicates the duration by which Destination region volume content lags behind the primary region volume content.
"lastTransferBytes": "A String", # Last transfer size in bytes.
"lastTransferDuration": "A String", # Time taken during last transfer.
"lastTransferEndTime": "A String", # Time when last transfer completed.
"lastTransferError": "A String", # A message describing the cause of the last transfer failure.
"totalTransferDuration": "A String", # Cumulative time taken across all transfers for the replication relationship.
"transferBytes": "A String", # Cumulative bytes transferred so far for the replication relationship.
"updateTime": "A String", # Time when progress was updated last.
},
}</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>Returns descriptions of all replications for a volume.
Args:
parent: string, Required. The volume for which to retrieve replication information, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`. (required)
filter: string, List filter.
orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
pageSize: integer, The maximum number of items to return.
pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # ListReplicationsResponse is the result of ListReplicationsRequest.
"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.
"replications": [ # A list of replications in the project for the specified volume.
{ # Replication is a nested resource under Volume, that describes a cross-region replication relationship between 2 volumes in different regions.
"clusterLocation": "A String", # Optional. Location of the user cluster.
"createTime": "A String", # Output only. Replication create time.
"description": "A String", # A description about this replication relationship.
"destinationVolume": "A String", # Output only. Full name of destination volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
"destinationVolumeParameters": { # DestinationVolumeParameters specify input parameters used for creating destination volume. # Required. Input only. Destination volume parameters
"description": "A String", # Description for the destination volume.
"shareName": "A String", # Destination volume's share name. If not specified, source volume's share name will be used.
"storagePool": "A String", # Required. Existing destination StoragePool name.
"tieringPolicy": { # Defines tiering policy for the volume. # Optional. 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.
},
"volumeId": "A String", # Desired destination volume resource id. If not specified, source volume's resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
},
"healthy": True or False, # Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.
"hybridPeeringDetails": { # HybridPeeringDetails contains details about the hybrid peering. # Output only. Hybrid peering details.
"command": "A String", # Output only. Copy-paste-able commands to be used on user's ONTAP to accept peering requests.
"commandExpiryTime": "A String", # Output only. Expiration time for the peering command to be executed on user's ONTAP.
"passphrase": "A String", # Output only. Temporary passphrase generated to accept cluster peering command.
"peerClusterName": "A String", # Output only. Name of the user's local source cluster to be peered with the destination cluster.
"peerSvmName": "A String", # Output only. Name of the user's local source vserver svm to be peered with the destination vserver svm.
"peerVolumeName": "A String", # Output only. Name of the user's local source volume to be peered with the destination volume.
"subnetIp": "A String", # Output only. IP address of the subnet.
},
"hybridReplicationType": "A String", # Output only. Type of the hybrid replication.
"hybridReplicationUserCommands": { # UserCommands contains the commands to be executed by the customer. # Output only. Copy pastable snapmirror commands to be executed on onprem cluster by the customer.
"commands": [ # Output only. List of commands to be executed by the customer.
"A String",
],
},
"labels": { # Resource labels to represent user provided metadata.
"a_key": "A String",
},
"mirrorState": "A String", # Output only. Indicates the state of mirroring.
"name": "A String", # Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.
"replicationSchedule": "A String", # Required. Indicates the schedule for replication.
"role": "A String", # Output only. Indicates whether this points to source or destination.
"sourceVolume": "A String", # Output only. Full name of source volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
"state": "A String", # Output only. State of the replication.
"stateDetails": "A String", # Output only. State details of the replication.
"transferStats": { # TransferStats reports all statistics related to replication transfer. # Output only. Replication transfer statistics.
"lagDuration": "A String", # Lag duration indicates the duration by which Destination region volume content lags behind the primary region volume content.
"lastTransferBytes": "A String", # Last transfer size in bytes.
"lastTransferDuration": "A String", # Time taken during last transfer.
"lastTransferEndTime": "A String", # Time when last transfer completed.
"lastTransferError": "A String", # A message describing the cause of the last transfer failure.
"totalTransferDuration": "A String", # Cumulative time taken across all transfers for the replication relationship.
"transferBytes": "A String", # Cumulative bytes transferred so far for the replication relationship.
"updateTime": "A String", # Time when progress was updated last.
},
},
],
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</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 settings of a specific replication.
Args:
name: string, Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`. (required)
body: object, The request body.
The object takes the form of:
{ # Replication is a nested resource under Volume, that describes a cross-region replication relationship between 2 volumes in different regions.
"clusterLocation": "A String", # Optional. Location of the user cluster.
"createTime": "A String", # Output only. Replication create time.
"description": "A String", # A description about this replication relationship.
"destinationVolume": "A String", # Output only. Full name of destination volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
"destinationVolumeParameters": { # DestinationVolumeParameters specify input parameters used for creating destination volume. # Required. Input only. Destination volume parameters
"description": "A String", # Description for the destination volume.
"shareName": "A String", # Destination volume's share name. If not specified, source volume's share name will be used.
"storagePool": "A String", # Required. Existing destination StoragePool name.
"tieringPolicy": { # Defines tiering policy for the volume. # Optional. 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.
},
"volumeId": "A String", # Desired destination volume resource id. If not specified, source volume's resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
},
"healthy": True or False, # Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.
"hybridPeeringDetails": { # HybridPeeringDetails contains details about the hybrid peering. # Output only. Hybrid peering details.
"command": "A String", # Output only. Copy-paste-able commands to be used on user's ONTAP to accept peering requests.
"commandExpiryTime": "A String", # Output only. Expiration time for the peering command to be executed on user's ONTAP.
"passphrase": "A String", # Output only. Temporary passphrase generated to accept cluster peering command.
"peerClusterName": "A String", # Output only. Name of the user's local source cluster to be peered with the destination cluster.
"peerSvmName": "A String", # Output only. Name of the user's local source vserver svm to be peered with the destination vserver svm.
"peerVolumeName": "A String", # Output only. Name of the user's local source volume to be peered with the destination volume.
"subnetIp": "A String", # Output only. IP address of the subnet.
},
"hybridReplicationType": "A String", # Output only. Type of the hybrid replication.
"hybridReplicationUserCommands": { # UserCommands contains the commands to be executed by the customer. # Output only. Copy pastable snapmirror commands to be executed on onprem cluster by the customer.
"commands": [ # Output only. List of commands to be executed by the customer.
"A String",
],
},
"labels": { # Resource labels to represent user provided metadata.
"a_key": "A String",
},
"mirrorState": "A String", # Output only. Indicates the state of mirroring.
"name": "A String", # Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.
"replicationSchedule": "A String", # Required. Indicates the schedule for replication.
"role": "A String", # Output only. Indicates whether this points to source or destination.
"sourceVolume": "A String", # Output only. Full name of source volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
"state": "A String", # Output only. State of the replication.
"stateDetails": "A String", # Output only. State details of the replication.
"transferStats": { # TransferStats reports all statistics related to replication transfer. # Output only. Replication transfer statistics.
"lagDuration": "A String", # Lag duration indicates the duration by which Destination region volume content lags behind the primary region volume content.
"lastTransferBytes": "A String", # Last transfer size in bytes.
"lastTransferDuration": "A String", # Time taken during last transfer.
"lastTransferEndTime": "A String", # Time when last transfer completed.
"lastTransferError": "A String", # A message describing the cause of the last transfer failure.
"totalTransferDuration": "A String", # Cumulative time taken across all transfers for the replication relationship.
"transferBytes": "A String", # Cumulative bytes transferred so far for the replication relationship.
"updateTime": "A String", # Time when progress was updated last.
},
}
updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field.
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="resume">resume(name, body=None, x__xgafv=None)</code>
<pre>Resume Cross Region Replication.
Args:
name: string, Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}. (required)
body: object, The request body.
The object takes the form of:
{ # ResumeReplicationRequest resumes a stopped replication.
}
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="reverseDirection">reverseDirection(name, body=None, x__xgafv=None)</code>
<pre>Reverses direction of replication. Source becomes destination and destination becomes source.
Args:
name: string, Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}. (required)
body: object, The request body.
The object takes the form of:
{ # ReverseReplicationDirectionRequest reverses direction of replication. Source becomes destination and destination becomes source.
}
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="stop">stop(name, body=None, x__xgafv=None)</code>
<pre>Stop Cross Region Replication.
Args:
name: string, Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}. (required)
body: object, The request body.
The object takes the form of:
{ # StopReplicationRequest stops a replication until resumed.
"force": True or False, # Indicates whether to stop replication forcefully while data transfer is in progress. Warning! if force is true, this will abort any current transfers and can lead to data loss due to partial transfer. If force is false, stop replication will fail while data transfer is in progress and you will need to retry later.
}
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="sync">sync(name, body=None, x__xgafv=None)</code>
<pre>Syncs the replication. This will invoke one time volume data transfer from source to destination.
Args:
name: string, Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}. (required)
body: object, The request body.
The object takes the form of:
{ # SyncReplicationRequest syncs the replication from source to destination.
}
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>
|
