-
Notifications
You must be signed in to change notification settings - Fork 242
/
Copy pathstoragetransferjob_v1beta1.json
747 lines (747 loc) · 31.7 KB
/
storagetransferjob_v1beta1.json
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
{
"properties": {
"apiVersion": {
"description": "apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources",
"type": "string"
},
"kind": {
"description": "kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds",
"type": "string"
},
"metadata": {
"type": "object"
},
"spec": {
"properties": {
"description": {
"description": "Unique description to identify the Transfer Job.",
"type": "string"
},
"notificationConfig": {
"description": "Notification configuration.",
"properties": {
"eventTypes": {
"description": "Event types for which a notification is desired. If empty, send notifications for all event types. The valid types are \"TRANSFER_OPERATION_SUCCESS\", \"TRANSFER_OPERATION_FAILED\", \"TRANSFER_OPERATION_ABORTED\".",
"items": {
"type": "string"
},
"type": "array"
},
"payloadFormat": {
"description": "The desired format of the notification message payloads. One of \"NONE\" or \"JSON\".",
"type": "string"
},
"topicRef": {
"description": "The PubSubTopic to which to publish notifications.",
"oneOf": [
{
"not": {
"required": [
"external"
]
},
"required": [
"name"
]
},
{
"not": {
"anyOf": [
{
"required": [
"name"
]
},
{
"required": [
"namespace"
]
}
]
},
"required": [
"external"
]
}
],
"properties": {
"external": {
"description": "Allowed value: string of the format `projects/{{project}}/topics/{{value}}`, where {{value}} is the `name` field of a `PubSubTopic` resource.",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"namespace": {
"description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
"type": "string"
}
},
"type": "object",
"additionalProperties": false
}
},
"required": [
"payloadFormat",
"topicRef"
],
"type": "object",
"additionalProperties": false
},
"resourceID": {
"description": "Immutable. Optional. The service-generated name of the resource. Used for acquisition only. Leave unset to create a new resource.",
"type": "string"
},
"schedule": {
"description": "Schedule specification defining when the Transfer Job should be scheduled to start, end and what time to run.",
"properties": {
"repeatInterval": {
"description": "Interval between the start of each scheduled transfer. If unspecified, the default value is 24 hours. This value may not be less than 1 hour. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: \"3.5s\".",
"type": "string"
},
"scheduleEndDate": {
"description": "The last day the recurring transfer will be run. If schedule_end_date is the same as schedule_start_date, the transfer will be executed only once.",
"properties": {
"day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"type": "integer"
},
"month": {
"description": "Month of year. Must be from 1 to 12.",
"type": "integer"
},
"year": {
"description": "Year of date. Must be from 1 to 9999.",
"type": "integer"
}
},
"required": [
"day",
"month",
"year"
],
"type": "object",
"additionalProperties": false
},
"scheduleStartDate": {
"description": "The first day the recurring transfer is scheduled to run. If schedule_start_date is in the past, the transfer will run for the first time on the following day.",
"properties": {
"day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month.",
"type": "integer"
},
"month": {
"description": "Month of year. Must be from 1 to 12.",
"type": "integer"
},
"year": {
"description": "Year of date. Must be from 1 to 9999.",
"type": "integer"
}
},
"required": [
"day",
"month",
"year"
],
"type": "object",
"additionalProperties": false
},
"startTimeOfDay": {
"description": "The time in UTC at which the transfer will be scheduled to start in a day. Transfers may start later than this time. If not specified, recurring and one-time transfers that are scheduled to run today will run immediately; recurring transfers that are scheduled to run on a future date will start at approximately midnight UTC on that date. Note that when configuring a transfer with the Cloud Platform Console, the transfer's start time in a day is specified in your local timezone.",
"properties": {
"hours": {
"description": "Hours of day in 24 hour format. Should be from 0 to 23.",
"type": "integer"
},
"minutes": {
"description": "Minutes of hour of day. Must be from 0 to 59.",
"type": "integer"
},
"nanos": {
"description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
"type": "integer"
},
"seconds": {
"description": "Seconds of minutes of the time. Must normally be from 0 to 59.",
"type": "integer"
}
},
"required": [
"hours",
"minutes",
"nanos",
"seconds"
],
"type": "object",
"additionalProperties": false
}
},
"required": [
"scheduleStartDate"
],
"type": "object",
"additionalProperties": false
},
"status": {
"description": "Status of the job. Default: ENABLED. NOTE: The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from ENABLED to DISABLED, and an operation spawned by the transfer is running, the status change would not affect the current operation.",
"type": "string"
},
"transferSpec": {
"description": "Transfer specification.",
"properties": {
"awsS3DataSource": {
"description": "An AWS S3 data source.",
"properties": {
"awsAccessKey": {
"description": "AWS credentials block.",
"properties": {
"accessKeyId": {
"description": "AWS Key ID.",
"oneOf": [
{
"not": {
"required": [
"valueFrom"
]
},
"required": [
"value"
]
},
{
"not": {
"required": [
"value"
]
},
"required": [
"valueFrom"
]
}
],
"properties": {
"value": {
"description": "Value of the field. Cannot be used if 'valueFrom' is specified.",
"type": "string"
},
"valueFrom": {
"description": "Source for the field's value. Cannot be used if 'value' is specified.",
"properties": {
"secretKeyRef": {
"description": "Reference to a value with the given key in the given Secret in the resource's namespace.",
"properties": {
"key": {
"description": "Key that identifies the value to be extracted.",
"type": "string"
},
"name": {
"description": "Name of the Secret to extract a value from.",
"type": "string"
}
},
"required": [
"name",
"key"
],
"type": "object",
"additionalProperties": false
}
},
"type": "object",
"additionalProperties": false
}
},
"type": "object",
"additionalProperties": false
},
"secretAccessKey": {
"description": "AWS Secret Access Key.",
"oneOf": [
{
"not": {
"required": [
"valueFrom"
]
},
"required": [
"value"
]
},
{
"not": {
"required": [
"value"
]
},
"required": [
"valueFrom"
]
}
],
"properties": {
"value": {
"description": "Value of the field. Cannot be used if 'valueFrom' is specified.",
"type": "string"
},
"valueFrom": {
"description": "Source for the field's value. Cannot be used if 'value' is specified.",
"properties": {
"secretKeyRef": {
"description": "Reference to a value with the given key in the given Secret in the resource's namespace.",
"properties": {
"key": {
"description": "Key that identifies the value to be extracted.",
"type": "string"
},
"name": {
"description": "Name of the Secret to extract a value from.",
"type": "string"
}
},
"required": [
"name",
"key"
],
"type": "object",
"additionalProperties": false
}
},
"type": "object",
"additionalProperties": false
}
},
"type": "object",
"additionalProperties": false
}
},
"required": [
"accessKeyId",
"secretAccessKey"
],
"type": "object",
"additionalProperties": false
},
"bucketName": {
"description": "S3 Bucket name.",
"type": "string"
},
"path": {
"description": "S3 Bucket path in bucket to transfer.",
"type": "string"
},
"roleArn": {
"description": "The Amazon Resource Name (ARN) of the role to support temporary credentials via 'AssumeRoleWithWebIdentity'. For more information about ARNs, see [IAM ARNs](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns). When a role ARN is provided, Transfer Service fetches temporary credentials for the session using a 'AssumeRoleWithWebIdentity' call for the provided role using the [GoogleServiceAccount][] for this project.",
"type": "string"
}
},
"required": [
"bucketName"
],
"type": "object",
"additionalProperties": false
},
"azureBlobStorageDataSource": {
"description": "An Azure Blob Storage data source.",
"properties": {
"azureCredentials": {
"description": " Credentials used to authenticate API requests to Azure.",
"properties": {
"sasToken": {
"description": "Azure shared access signature.",
"oneOf": [
{
"not": {
"required": [
"valueFrom"
]
},
"required": [
"value"
]
},
{
"not": {
"required": [
"value"
]
},
"required": [
"valueFrom"
]
}
],
"properties": {
"value": {
"description": "Value of the field. Cannot be used if 'valueFrom' is specified.",
"type": "string"
},
"valueFrom": {
"description": "Source for the field's value. Cannot be used if 'value' is specified.",
"properties": {
"secretKeyRef": {
"description": "Reference to a value with the given key in the given Secret in the resource's namespace.",
"properties": {
"key": {
"description": "Key that identifies the value to be extracted.",
"type": "string"
},
"name": {
"description": "Name of the Secret to extract a value from.",
"type": "string"
}
},
"required": [
"name",
"key"
],
"type": "object",
"additionalProperties": false
}
},
"type": "object",
"additionalProperties": false
}
},
"type": "object",
"additionalProperties": false
}
},
"required": [
"sasToken"
],
"type": "object",
"additionalProperties": false
},
"container": {
"description": "The container to transfer from the Azure Storage account.",
"type": "string"
},
"path": {
"description": "Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'.",
"type": "string"
},
"storageAccount": {
"description": "The name of the Azure Storage account.",
"type": "string"
}
},
"required": [
"azureCredentials",
"container",
"storageAccount"
],
"type": "object",
"additionalProperties": false
},
"gcsDataSink": {
"description": "A Google Cloud Storage data sink.",
"properties": {
"bucketRef": {
"oneOf": [
{
"not": {
"required": [
"external"
]
},
"required": [
"name"
]
},
{
"not": {
"anyOf": [
{
"required": [
"name"
]
},
{
"required": [
"namespace"
]
}
]
},
"required": [
"external"
]
}
],
"properties": {
"external": {
"description": "Allowed value: The `name` field of a `StorageBucket` resource.",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"namespace": {
"description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
"type": "string"
}
},
"type": "object",
"additionalProperties": false
},
"path": {
"description": "Google Cloud Storage path in bucket to transfer.",
"type": "string"
}
},
"required": [
"bucketRef"
],
"type": "object",
"additionalProperties": false
},
"gcsDataSource": {
"description": "A Google Cloud Storage data source.",
"properties": {
"bucketRef": {
"oneOf": [
{
"not": {
"required": [
"external"
]
},
"required": [
"name"
]
},
{
"not": {
"anyOf": [
{
"required": [
"name"
]
},
{
"required": [
"namespace"
]
}
]
},
"required": [
"external"
]
}
],
"properties": {
"external": {
"description": "Allowed value: The `name` field of a `StorageBucket` resource.",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"namespace": {
"description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
"type": "string"
}
},
"type": "object",
"additionalProperties": false
},
"path": {
"description": "Google Cloud Storage path in bucket to transfer.",
"type": "string"
}
},
"required": [
"bucketRef"
],
"type": "object",
"additionalProperties": false
},
"httpDataSource": {
"description": "A HTTP URL data source.",
"properties": {
"listUrl": {
"description": "The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported.",
"type": "string"
}
},
"required": [
"listUrl"
],
"type": "object",
"additionalProperties": false
},
"objectConditions": {
"description": "Only objects that satisfy these object conditions are included in the set of data source and data sink objects. Object conditions based on objects' last_modification_time do not exclude objects in a data sink.",
"properties": {
"excludePrefixes": {
"description": "exclude_prefixes must follow the requirements described for include_prefixes.",
"items": {
"type": "string"
},
"type": "array"
},
"includePrefixes": {
"description": "If include_refixes is specified, objects that satisfy the object conditions must have names that start with one of the include_prefixes and that do not start with any of the exclude_prefixes. If include_prefixes is not specified, all objects except those that have names starting with one of the exclude_prefixes must satisfy the object conditions.",
"items": {
"type": "string"
},
"type": "array"
},
"lastModifiedBefore": {
"description": "If specified, only objects with a \"last modification time\" before this timestamp and objects that don't have a \"last modification time\" are transferred. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: \"2014-10-02T15:01:23Z\" and \"2014-10-02T15:01:23.045123456Z\".",
"type": "string"
},
"lastModifiedSince": {
"description": "If specified, only objects with a \"last modification time\" on or after this timestamp and objects that don't have a \"last modification time\" are transferred. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: \"2014-10-02T15:01:23Z\" and \"2014-10-02T15:01:23.045123456Z\".",
"type": "string"
},
"maxTimeElapsedSinceLastModification": {
"description": "A duration in seconds with up to nine fractional digits, terminated by 's'. Example: \"3.5s\".",
"type": "string"
},
"minTimeElapsedSinceLastModification": {
"description": "A duration in seconds with up to nine fractional digits, terminated by 's'. Example: \"3.5s\".",
"type": "string"
}
},
"type": "object",
"additionalProperties": false
},
"posixDataSink": {
"description": "A POSIX filesystem data sink.",
"properties": {
"rootDirectory": {
"description": "Root directory path to the filesystem.",
"type": "string"
}
},
"required": [
"rootDirectory"
],
"type": "object",
"additionalProperties": false
},
"posixDataSource": {
"description": "A POSIX filesystem data source.",
"properties": {
"rootDirectory": {
"description": "Root directory path to the filesystem.",
"type": "string"
}
},
"required": [
"rootDirectory"
],
"type": "object",
"additionalProperties": false
},
"sinkAgentPoolName": {
"description": "Immutable. Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used.",
"type": "string"
},
"sourceAgentPoolName": {
"description": "Immutable. Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used.",
"type": "string"
},
"transferOptions": {
"description": "Characteristics of how to treat files from datasource and sink during job. If the option delete_objects_unique_in_sink is true, object conditions based on objects' last_modification_time are ignored and do not exclude objects in a data source or a data sink.",
"properties": {
"deleteObjectsFromSourceAfterTransfer": {
"description": "Whether objects should be deleted from the source after they are transferred to the sink. Note that this option and delete_objects_unique_in_sink are mutually exclusive.",
"type": "boolean"
},
"deleteObjectsUniqueInSink": {
"description": "Whether objects that exist only in the sink should be deleted. Note that this option and delete_objects_from_source_after_transfer are mutually exclusive.",
"type": "boolean"
},
"overwriteObjectsAlreadyExistingInSink": {
"description": "Whether overwriting objects that already exist in the sink is allowed.",
"type": "boolean"
},
"overwriteWhen": {
"description": "When to overwrite objects that already exist in the sink. If not set, overwrite behavior is determined by overwriteObjectsAlreadyExistingInSink.",
"type": "string"
}
},
"type": "object",
"additionalProperties": false
}
},
"type": "object",
"additionalProperties": false
}
},
"required": [
"description",
"transferSpec"
],
"type": "object",
"additionalProperties": false
},
"status": {
"properties": {
"conditions": {
"description": "Conditions represent the latest available observation of the resource's current state.",
"items": {
"properties": {
"lastTransitionTime": {
"description": "Last time the condition transitioned from one status to another.",
"type": "string"
},
"message": {
"description": "Human-readable message indicating details about last transition.",
"type": "string"
},
"reason": {
"description": "Unique, one-word, CamelCase reason for the condition's last transition.",
"type": "string"
},
"status": {
"description": "Status is the status of the condition. Can be True, False, Unknown.",
"type": "string"
},
"type": {
"description": "Type is the type of the condition.",
"type": "string"
}
},
"type": "object",
"additionalProperties": false
},
"type": "array"
},
"creationTime": {
"description": "When the Transfer Job was created.",
"type": "string"
},
"deletionTime": {
"description": "When the Transfer Job was deleted.",
"type": "string"
},
"lastModificationTime": {
"description": "When the Transfer Job was last modified.",
"type": "string"
},
"name": {
"description": "The name of the Transfer Job.",
"type": "string"
},
"observedGeneration": {
"description": "ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.",
"type": "integer"
}
},
"type": "object",
"additionalProperties": false
}
},
"required": [
"spec"
],
"type": "object"
}