forked from GoogleCloudPlatform/magic-modules
-
Notifications
You must be signed in to change notification settings - Fork 5
/
api.yaml
19399 lines (19015 loc) · 930 KB
/
api.yaml
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
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright 2017 Google Inc.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# TODO(nelsonjr): Make all Zone and Region resource ref
--- !ruby/object:Api::Product
name: Compute
display_name: Compute Engine
versions:
- !ruby/object:Api::Product::Version
name: ga
base_url: https://compute.googleapis.com/compute/v1/
- !ruby/object:Api::Product::Version
name: beta
base_url: https://compute.googleapis.com/compute/beta/
scopes:
- https://www.googleapis.com/auth/compute
apis_required:
- !ruby/object:Api::Product::ApiReference
name: Compute Engine API
url: https://console.cloud.google.com/apis/library/compute.googleapis.com/
objects:
- !ruby/object:Api::Resource
name: 'Address'
kind: 'compute#address'
base_url: projects/{{project}}/regions/{{region}}/addresses
collection_url_key: 'items'
has_self_link: true
input: true
description: |
Represents an Address resource.
Each virtual machine instance has an ephemeral internal IP address and,
optionally, an external IP address. To communicate between instances on
the same network, you can use an instance's internal IP address. To
communicate with the Internet and instances outside of the same network,
you must specify the instance's external IP address.
Internal IP addresses are ephemeral and only belong to an instance for
the lifetime of the instance; if the instance is deleted and recreated,
the instance is assigned a new internal IP address, either by Compute
Engine or by you. External IP addresses can be either ephemeral or
static.
references: !ruby/object:Api::Resource::ReferenceLinks
guides:
'Reserving a Static External IP Address': 'https://cloud.google.com/compute/docs/instances-and-network'
'Reserving a Static Internal IP Address': 'https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address'
api: 'https://cloud.google.com/compute/docs/reference/beta/addresses'
async: !ruby/object:Api::OpAsync
operation: !ruby/object:Api::OpAsync::Operation
kind: 'compute#operation'
path: 'name'
base_url: 'projects/{{project}}/regions/{{region}}/operations/{{op_id}}'
wait_ms: 1000
result: !ruby/object:Api::OpAsync::Result
path: 'targetLink'
status: !ruby/object:Api::OpAsync::Status
path: 'status'
complete: 'DONE'
allowed:
- 'PENDING'
- 'RUNNING'
- 'DONE'
error: !ruby/object:Api::OpAsync::Error
path: 'error/errors'
message: 'message'
parameters:
- !ruby/object:Api::Type::ResourceRef
name: 'region'
resource: 'Region'
imports: 'name'
description: |
URL of the region where the regional address resides.
This field is not applicable to global addresses.
required: true
properties:
- !ruby/object:Api::Type::String
name: 'address'
description: |
The static external IP address represented by this resource. Only
IPv4 is supported. An address may only be specified for INTERNAL
address types. The IP address must be inside the specified subnetwork,
if any. Set by the API if undefined.
- !ruby/object:Api::Type::Enum
name: 'addressType'
description: |
The type of address to reserve.
values:
- :INTERNAL
- :EXTERNAL
default_value: :EXTERNAL
- !ruby/object:Api::Type::Time
name: 'creationTimestamp'
description: 'Creation timestamp in RFC3339 text format.'
output: true
- !ruby/object:Api::Type::String
name: 'description'
description: 'An optional description of this resource.'
- !ruby/object:Api::Type::Integer
name: 'id'
description: 'The unique identifier for the resource.'
output: true
- !ruby/object:Api::Type::String
name: 'name'
description: |
Name of the resource. The name must be 1-63 characters long, and
comply with RFC1035. Specifically, the name must be 1-63 characters
long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
which means the first character must be a lowercase letter, and all
following characters must be a dash, lowercase letter, or digit,
except the last character, which cannot be a dash.
required: true
- !ruby/object:Api::Type::String
name: purpose
description: |
The purpose of this resource, which can be one of the following values:
* GCE_ENDPOINT for addresses that are used by VM instances, alias IP
ranges, internal load balancers, and similar resources.
* SHARED_LOADBALANCER_VIP for an address that can be used by multiple
internal load balancers.
* VPC_PEERING for addresses that are reserved for VPC peer networks.
* IPSEC_INTERCONNECT for addresses created from a private IP range
that are reserved for a VLAN attachment in an IPsec-encrypted Cloud
Interconnect configuration. These addresses are regional resources.
* PRIVATE_SERVICE_CONNECT for a private network address that is used
to configure Private Service Connect. Only global internal addresses
can use this purpose.
This should only be set when using an Internal address.
- !ruby/object:Api::Type::Enum
name: 'networkTier'
description: |
The networking tier used for configuring this address. If this field is not
specified, it is assumed to be PREMIUM.
values:
- :PREMIUM
- :STANDARD
# TODO(alexstephen): Add in status with exclude attribute. What does this
# mean?
- !ruby/object:Api::Type::ResourceRef
name: 'subnetwork'
resource: 'Subnetwork'
imports: 'selfLink'
description: |
The URL of the subnetwork in which to reserve the address. If an IP
address is specified, it must be within the subnetwork's IP range.
This field can only be used with INTERNAL type with
GCE_ENDPOINT/DNS_RESOLVER purposes.
- !ruby/object:Api::Type::Array
name: 'users'
description: 'The URLs of the resources that are using this address.'
item_type: Api::Type::String
output: true
- !ruby/object:Api::Type::KeyValuePairs
name: 'labels'
description: |
Labels to apply to this address. A list of key->value pairs.
update_verb: :POST
update_url: 'projects/{{project}}/regions/{{region}}/addresses/{{name}}/setLabels'
min_version: beta
- !ruby/object:Api::Type::Fingerprint
name: 'labelFingerprint'
description: |
The fingerprint used for optimistic locking of this resource. Used
internally during updates.
update_url: 'projects/{{project}}/regions/{{region}}/addresses/{{name}}/setLabels'
update_verb: :POST
min_version: beta
- !ruby/object:Api::Type::Enum
name: 'status'
output: true
description: |
The status of the address, which can be one of RESERVING, RESERVED, or IN_USE.
An address that is RESERVING is currently in the process of being reserved.
A RESERVED address is currently reserved and available to use. An IN_USE address
is currently being used by another resource and is not available.
values:
- :RESERVING
- :RESERVED
- :IN_USE
- !ruby/object:Api::Type::ResourceRef
name: 'network'
resource: 'Network'
imports: 'selfLink'
description: |
The URL of the network in which to reserve the address. This field
can only be used with INTERNAL type with the VPC_PEERING and
IPSEC_INTERCONNECT purposes.
- !ruby/object:Api::Type::Integer
name: prefixLength
description: |
The prefix length if the resource represents an IP range.
- !ruby/object:Api::Resource
name: 'Autoscaler'
kind: 'compute#autoscaler'
base_url: projects/{{project}}/zones/{{zone}}/autoscalers
update_url: projects/{{project}}/zones/{{zone}}/autoscalers?autoscaler={{name}}
collection_url_key: 'items'
has_self_link: true
description: |
Represents an Autoscaler resource.
Autoscalers allow you to automatically scale virtual machine instances in
managed instance groups according to an autoscaling policy that you
define.
references: !ruby/object:Api::Resource::ReferenceLinks
guides:
'Autoscaling Groups of Instances': 'https://cloud.google.com/compute/docs/autoscaler/'
api: 'https://cloud.google.com/compute/docs/reference/rest/v1/autoscalers'
async: !ruby/object:Api::OpAsync
operation: !ruby/object:Api::OpAsync::Operation
kind: 'compute#operation'
path: 'name'
base_url: 'projects/{{project}}/zones/{{zone}}/operations/{{op_id}}'
wait_ms: 1000
result: !ruby/object:Api::OpAsync::Result
path: 'targetLink'
status: !ruby/object:Api::OpAsync::Status
path: 'status'
complete: 'DONE'
allowed:
- 'PENDING'
- 'RUNNING'
- 'DONE'
error: !ruby/object:Api::OpAsync::Error
path: 'error/errors'
message: 'message'
parameters:
- !ruby/object:Api::Type::ResourceRef
name: 'zone'
resource: 'Zone'
imports: 'name'
description: |
URL of the zone where the instance group resides.
required: true
input: true
properties:
- !ruby/object:Api::Type::Integer
name: 'id'
description: 'Unique identifier for the resource.'
output: true
- !ruby/object:Api::Type::Time
name: 'creationTimestamp'
description: 'Creation timestamp in RFC3339 text format.'
output: true
- !ruby/object:Api::Type::String
name: 'name'
description: |
Name of the resource. The name must be 1-63 characters long and match
the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the
first character must be a lowercase letter, and all following
characters must be a dash, lowercase letter, or digit, except the last
character, which cannot be a dash.
required: true
input: true
- !ruby/object:Api::Type::String
name: 'description'
description: |
An optional description of this resource.
- !ruby/object:Api::Type::NestedObject
name: 'autoscalingPolicy'
description: |
The configuration parameters for the autoscaling algorithm. You can
define one or more of the policies for an autoscaler: cpuUtilization,
customMetricUtilizations, and loadBalancingUtilization.
If none of these are specified, the default will be to autoscale based
on cpuUtilization to 0.6 or 60%.
required: true
properties:
- !ruby/object:Api::Type::Integer
name: 'minNumReplicas'
description: |
The minimum number of replicas that the autoscaler can scale down
to. This cannot be less than 0. If not provided, autoscaler will
choose a default value depending on maximum number of instances
allowed.
send_empty_value: true
- !ruby/object:Api::Type::Integer
name: 'maxNumReplicas'
description: |
The maximum number of instances that the autoscaler can scale up
to. This is required when creating or updating an autoscaler. The
maximum number of replicas should not be lower than minimal number
of replicas.
required: true
- !ruby/object:Api::Type::Integer
name: 'coolDownPeriodSec'
description: |
The number of seconds that the autoscaler should wait before it
starts collecting information from a new instance. This prevents
the autoscaler from collecting information when the instance is
initializing, during which the collected usage would not be
reliable. The default time autoscaler waits is 60 seconds.
Virtual machine initialization times might vary because of
numerous factors. We recommend that you test how long an
instance may take to initialize. To do this, create an instance
and time the startup process.
default_value: 60
- !ruby/object:Api::Type::Enum
name: 'mode'
default_value: :ON
description: |
Defines operating mode for this policy.
values:
- :OFF
- :ONLY_UP
- :ON
- !ruby/object:Api::Type::NestedObject
name: 'scaleDownControl'
min_version: beta
description: |
Defines scale down controls to reduce the risk of response latency
and outages due to abrupt scale-in events
properties:
- !ruby/object:Api::Type::NestedObject
name: 'maxScaledDownReplicas'
at_least_one_of:
- autoscaling_policy.0.scale_down_control.0.max_scaled_down_replicas
- autoscaling_policy.0.scale_down_control.0.time_window_sec
properties:
- !ruby/object:Api::Type::Integer
name: 'fixed'
at_least_one_of:
- autoscaling_policy.0.scale_down_control.0.max_scaled_down_replicas.0.fixed
- autoscaling_policy.0.scale_down_control.0.max_scaled_down_replicas.0.percent
description: |
Specifies a fixed number of VM instances. This must be a positive
integer.
- !ruby/object:Api::Type::Integer
name: 'percent'
at_least_one_of:
- autoscaling_policy.0.scale_down_control.0.max_scaled_down_replicas.0.fixed
- autoscaling_policy.0.scale_down_control.0.max_scaled_down_replicas.0.percent
description: |
Specifies a percentage of instances between 0 to 100%, inclusive.
For example, specify 80 for 80%.
- !ruby/object:Api::Type::Integer
name: 'timeWindowSec'
at_least_one_of:
- autoscaling_policy.0.scale_down_control.0.max_scaled_down_replicas
- autoscaling_policy.0.scale_down_control.0.time_window_sec
description: |
How long back autoscaling should look when computing recommendations
to include directives regarding slower scale down, as described above.
- !ruby/object:Api::Type::NestedObject
name: 'scaleInControl'
description: |
Defines scale in controls to reduce the risk of response latency
and outages due to abrupt scale-in events
properties:
- !ruby/object:Api::Type::NestedObject
name: 'maxScaledInReplicas'
at_least_one_of:
- autoscaling_policy.0.scale_in_control.0.max_scaled_in_replicas
- autoscaling_policy.0.scale_in_control.0.time_window_sec
properties:
- !ruby/object:Api::Type::Integer
name: 'fixed'
at_least_one_of:
- autoscaling_policy.0.scale_in_control.0.max_scaled_in_replicas.0.fixed
- autoscaling_policy.0.scale_in_control.0.max_scaled_in_replicas.0.percent
description: |
Specifies a fixed number of VM instances. This must be a positive
integer.
- !ruby/object:Api::Type::Integer
name: 'percent'
at_least_one_of:
- autoscaling_policy.0.scale_in_control.0.max_scaled_in_replicas.0.fixed
- autoscaling_policy.0.scale_in_control.0.max_scaled_in_replicas.0.percent
description: |
Specifies a percentage of instances between 0 to 100%, inclusive.
For example, specify 80 for 80%.
- !ruby/object:Api::Type::Integer
name: 'timeWindowSec'
at_least_one_of:
- autoscaling_policy.0.scale_in_control.0.max_scaled_in_replicas
- autoscaling_policy.0.scale_in_control.0.time_window_sec
description: |
How long back autoscaling should look when computing recommendations
to include directives regarding slower scale down, as described above.
- !ruby/object:Api::Type::NestedObject
name: 'cpuUtilization'
description: |
Defines the CPU utilization policy that allows the autoscaler to
scale based on the average CPU utilization of a managed instance
group.
properties:
- !ruby/object:Api::Type::Double
name: 'utilizationTarget'
description: |
The target CPU utilization that the autoscaler should maintain.
Must be a float value in the range (0, 1]. If not specified, the
default is 0.6.
If the CPU level is below the target utilization, the autoscaler
scales down the number of instances until it reaches the minimum
number of instances you specified or until the average CPU of
your instances reaches the target utilization.
If the average CPU is above the target utilization, the autoscaler
scales up until it reaches the maximum number of instances you
specified or until the average utilization reaches the target
utilization.
- !ruby/object:Api::Type::String
name: 'predictiveMethod'
default_value: NONE
description: |
Indicates whether predictive autoscaling based on CPU metric is enabled. Valid values are:
- NONE (default). No predictive method is used. The autoscaler scales the group to meet current demand based on real-time metrics.
- OPTIMIZE_AVAILABILITY. Predictive autoscaling improves availability by monitoring daily and weekly load patterns and scaling out ahead of anticipated demand.
- !ruby/object:Api::Type::Array
name: 'customMetricUtilizations'
description: |
Configuration parameters of autoscaling based on a custom metric.
item_type: !ruby/object:Api::Type::NestedObject
properties:
- !ruby/object:Api::Type::String
name: 'metric'
description: |
The identifier (type) of the Stackdriver Monitoring metric.
The metric cannot have negative values.
The metric must have a value type of INT64 or DOUBLE.
required: true
- !ruby/object:Api::Type::Double
name: 'singleInstanceAssignment'
min_version: beta
description: |
If scaling is based on a per-group metric value that represents the
total amount of work to be done or resource usage, set this value to
an amount assigned for a single instance of the scaled group.
The autoscaler will keep the number of instances proportional to the
value of this metric, the metric itself should not change value due
to group resizing.
For example, a good metric to use with the target is
`pubsub.googleapis.com/subscription/num_undelivered_messages`
or a custom metric exporting the total number of requests coming to
your instances.
A bad example would be a metric exporting an average or median
latency, since this value can't include a chunk assignable to a
single instance, it could be better used with utilization_target
instead.
- !ruby/object:Api::Type::Double
name: 'utilizationTarget'
description: |
The target value of the metric that autoscaler should
maintain. This must be a positive value. A utilization
metric scales number of virtual machines handling requests
to increase or decrease proportionally to the metric.
For example, a good metric to use as a utilizationTarget is
www.googleapis.com/compute/instance/network/received_bytes_count.
The autoscaler will work to keep this value constant for each
of the instances.
- !ruby/object:Api::Type::Enum
name: 'utilizationTargetType'
description: |
Defines how target utilization value is expressed for a
Stackdriver Monitoring metric.
values:
- :GAUGE
- :DELTA_PER_SECOND
- :DELTA_PER_MINUTE
- !ruby/object:Api::Type::String
name: 'filter'
description: |
A filter string to be used as the filter string for
a Stackdriver Monitoring TimeSeries.list API call.
This filter is used to select a specific TimeSeries for
the purpose of autoscaling and to determine whether the metric
is exporting per-instance or per-group data.
You can only use the AND operator for joining selectors.
You can only use direct equality comparison operator (=) without
any functions for each selector.
You can specify the metric in both the filter string and in the
metric field. However, if specified in both places, the metric must
be identical.
The monitored resource type determines what kind of values are
expected for the metric. If it is a gce_instance, the autoscaler
expects the metric to include a separate TimeSeries for each
instance in a group. In such a case, you cannot filter on resource
labels.
If the resource type is any other value, the autoscaler expects
this metric to contain values that apply to the entire autoscaled
instance group and resource label filtering can be performed to
point autoscaler at the correct TimeSeries to scale upon.
This is called a per-group metric for the purpose of autoscaling.
If not specified, the type defaults to gce_instance.
You should provide a filter that is selective enough to pick just
one TimeSeries for the autoscaled group or for each of the instances
(if you are using gce_instance resource type). If multiple
TimeSeries are returned upon the query execution, the autoscaler
will sum their respective values to obtain its scaling value.
min_version: beta
- !ruby/object:Api::Type::NestedObject
name: 'loadBalancingUtilization'
description: |
Configuration parameters of autoscaling based on a load balancer.
properties:
- !ruby/object:Api::Type::Double
name: 'utilizationTarget'
description: |
Fraction of backend capacity utilization (set in HTTP(s) load
balancing configuration) that autoscaler should maintain. Must
be a positive float value. If not defined, the default is 0.8.
- !ruby/object:Api::Type::Map
name: 'scalingSchedules'
description: |
Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler and they can overlap.
key_name: name
key_description: |
A name for the schedule.
value_type: !ruby/object:Api::Type::NestedObject
name: scalingSchedule
properties:
- !ruby/object:Api::Type::Integer
name: 'minRequiredReplicas'
description: |
Minimum number of VM instances that autoscaler will recommend in time intervals starting according to schedule.
required: true
send_empty_value: true
- !ruby/object:Api::Type::String
name: 'schedule'
description: |
The start timestamps of time intervals when this scaling schedule should provide a scaling signal. This field uses the extended cron format (with an optional year field).
required: true
- !ruby/object:Api::Type::String
name: 'timeZone'
default_value: UTC
description: |
The time zone to be used when interpreting the schedule. The value of this field must be a time zone name from the tz database: http://en.wikipedia.org/wiki/Tz_database.
- !ruby/object:Api::Type::Integer
name: 'durationSec'
description: |
The duration of time intervals (in seconds) for which this scaling schedule will be running. The minimum allowed value is 300.
required: true
- !ruby/object:Api::Type::Boolean
name: 'disabled'
description: |
A boolean value that specifies if a scaling schedule can influence autoscaler recommendations. If set to true, then a scaling schedule has no effect.
default_value: false
- !ruby/object:Api::Type::String
name: 'description'
description: |
A description of a scaling schedule.
- !ruby/object:Api::Type::ResourceRef
name: 'target'
resource: 'InstanceGroupManager'
imports: 'selfLink'
description: |
URL of the managed instance group that this autoscaler will scale.
required: true
- !ruby/object:Api::Resource
name: 'BackendBucket'
kind: 'compute#backendBucket'
base_url: projects/{{project}}/global/backendBuckets
collection_url_key: 'items'
has_self_link: true
description: |
Backend buckets allow you to use Google Cloud Storage buckets with HTTP(S)
load balancing.
An HTTP(S) load balancer can direct traffic to specified URLs to a
backend bucket rather than a backend service. It can send requests for
static content to a Cloud Storage bucket and requests for dynamic content
to a virtual machine instance.
references: !ruby/object:Api::Resource::ReferenceLinks
guides:
'Using a Cloud Storage bucket as a load balancer backend': 'https://cloud.google.com/compute/docs/load-balancing/http/backend-bucket'
api: 'https://cloud.google.com/compute/docs/reference/v1/backendBuckets'
async: !ruby/object:Api::OpAsync
operation: !ruby/object:Api::OpAsync::Operation
kind: 'compute#operation'
path: 'name'
base_url: 'projects/{{project}}/global/operations/{{op_id}}'
wait_ms: 1000
result: !ruby/object:Api::OpAsync::Result
path: 'targetLink'
status: !ruby/object:Api::OpAsync::Status
path: 'status'
complete: 'DONE'
allowed:
- 'PENDING'
- 'RUNNING'
- 'DONE'
error: !ruby/object:Api::OpAsync::Error
path: 'error/errors'
message: 'message'
iam_policy: !ruby/object:Api::Resource::IamPolicy
min_version: beta
exclude: false
parent_resource_attribute: 'name'
import_format: ["projects/{{project}}/global/backendBuckets/{{name}}", "{{name}}"]
properties:
- !ruby/object:Api::Type::String
name: 'bucketName'
description: 'Cloud Storage bucket name.'
required: true
- !ruby/object:Api::Type::NestedObject
name: 'cdnPolicy'
description: 'Cloud CDN configuration for this Backend Bucket.'
properties:
- !ruby/object:Api::Type::NestedObject
name: 'cacheKeyPolicy'
description: 'The CacheKeyPolicy for this CdnPolicy.'
properties:
- !ruby/object:Api::Type::Array
send_empty_value: true
name: 'queryStringWhitelist'
at_least_one_of:
- cdn_policy.0.cache_key_policy.0.query_string_whitelist
- cdn_policy.0.cache_key_policy.0.include_http_headers
description: |
Names of query string parameters to include in cache keys.
Default parameters are always included. '&' and '=' will
be percent encoded and not treated as delimiters.
item_type: Api::Type::String
- !ruby/object:Api::Type::Array
send_empty_value: true
name: 'includeHttpHeaders'
at_least_one_of:
- cdn_policy.0.cache_key_policy.0.query_string_whitelist
- cdn_policy.0.cache_key_policy.0.include_http_headers
description: |
Allows HTTP request headers (by name) to be used in the
cache key.
item_type: Api::Type::String
- !ruby/object:Api::Type::Integer
name: 'signedUrlCacheMaxAgeSec'
description: |
Maximum number of seconds the response to a signed URL request will
be considered fresh. After this time period,
the response will be revalidated before being served.
When serving responses to signed URL requests,
Cloud CDN will internally behave as though
all responses from this backend had a "Cache-Control: public,
max-age=[TTL]" header, regardless of any existing Cache-Control
header. The actual headers served in responses will not be altered.
- !ruby/object:Api::Type::Integer
name: 'defaultTtl'
description: |
Specifies the default TTL for cached content served by this origin for responses
that do not have an existing valid TTL (max-age or s-max-age).
- !ruby/object:Api::Type::Integer
name: 'maxTtl'
description: |
Specifies the maximum allowed TTL for cached content served by this origin.
- !ruby/object:Api::Type::Integer
name: 'clientTtl'
description: |
Specifies the maximum allowed TTL for cached content served by this origin.
- !ruby/object:Api::Type::Boolean
name: 'negativeCaching'
send_empty_value: true
description: |
Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.
- !ruby/object:Api::Type::Array
name: 'negativeCachingPolicy'
description: |
Sets a cache TTL for the specified HTTP status code. negativeCaching must be enabled to configure negativeCachingPolicy.
Omitting the policy and leaving negativeCaching enabled will use Cloud CDN's default cache TTLs.
item_type: !ruby/object:Api::Type::NestedObject
properties:
- !ruby/object:Api::Type::Integer
name: 'code'
description: |
The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 308, 404, 405, 410, 421, 451 and 501
can be specified as values, and you cannot specify a status code more than once.
- !ruby/object:Api::Type::Integer
name: 'ttl'
description: |
The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s
(30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
- !ruby/object:Api::Type::Enum
name: 'cacheMode'
description: |
Specifies the cache setting for all responses from this backend.
The possible values are: USE_ORIGIN_HEADERS, FORCE_CACHE_ALL and CACHE_ALL_STATIC
values:
- :USE_ORIGIN_HEADERS
- :FORCE_CACHE_ALL
- :CACHE_ALL_STATIC
- !ruby/object:Api::Type::Integer
name: 'serveWhileStale'
send_empty_value: true
description: |
Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.
- !ruby/object:Api::Type::Boolean
name: 'requestCoalescing'
send_empty_value: true
description: |
If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
- !ruby/object:Api::Type::Array
name: 'bypassCacheOnRequestHeaders'
description: |
Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
max_size: 5
item_type: !ruby/object:Api::Type::NestedObject
properties:
- !ruby/object:Api::Type::String
name: 'headerName'
description: |
The header field name to match on when bypassing cache. Values are case-insensitive.
- !ruby/object:Api::Type::Enum
name: 'compressionMode'
description: |
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.
values:
- :AUTOMATIC
- :DISABLED
- !ruby/object:Api::Type::String
name: 'edgeSecurityPolicy'
description: |
The security policy associated with this backend bucket.
- !ruby/object:Api::Type::Array
name: 'customResponseHeaders'
description: |
Headers that the HTTP/S load balancer should add to proxied responses.
item_type: Api::Type::String
- !ruby/object:Api::Type::Time
name: 'creationTimestamp'
description: 'Creation timestamp in RFC3339 text format.'
output: true
- !ruby/object:Api::Type::String
name: 'description'
description: |
An optional textual description of the resource; provided by the
client when the resource is created.
- !ruby/object:Api::Type::Boolean
name: 'enableCdn'
description: 'If true, enable Cloud CDN for this BackendBucket.'
- !ruby/object:Api::Type::Integer
name: 'id'
description: 'Unique identifier for the resource.'
output: true
- !ruby/object:Api::Type::String
name: 'name'
description: |
Name of the resource. Provided by the client when the resource is
created. The name must be 1-63 characters long, and comply with
RFC1035. Specifically, the name must be 1-63 characters long and
match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means
the first character must be a lowercase letter, and all following
characters must be a dash, lowercase letter, or digit, except the
last character, which cannot be a dash.
input: true
required: true
- !ruby/object:Api::Resource
name: 'BackendBucketSignedUrlKey'
kind: 'compute#BackendBucketSignedUrlKey'
input: true
base_url: projects/{{project}}/global/backendBuckets/{{backend_bucket}}
create_url: projects/{{project}}/global/backendBuckets/{{backend_bucket}}/addSignedUrlKey
create_verb: :POST
delete_url: projects/{{project}}/global/backendBuckets/{{backend_bucket}}/deleteSignedUrlKey?keyName={{name}}
delete_verb: :POST
self_link: projects/{{project}}/global/backendBuckets/{{backend_bucket}}
identity:
- name
nested_query: !ruby/object:Api::Resource::NestedQuery
keys:
- cdnPolicy
- signedUrlKeyNames
is_list_of_ids: true
description: |
A key for signing Cloud CDN signed URLs for BackendBuckets.
references: !ruby/object:Api::Resource::ReferenceLinks
guides:
'Using Signed URLs': 'https://cloud.google.com/cdn/docs/using-signed-urls/'
api: 'https://cloud.google.com/compute/docs/reference/rest/v1/backendBuckets'
async: !ruby/object:Api::OpAsync
operation: !ruby/object:Api::OpAsync::Operation
kind: 'compute#operation'
path: 'name'
base_url: 'projects/{{project}}/global/operations/{{op_id}}'
wait_ms: 1000
result: !ruby/object:Api::OpAsync::Result
path: 'targetLink'
status: !ruby/object:Api::OpAsync::Status
path: 'status'
complete: 'DONE'
allowed:
- 'PENDING'
- 'RUNNING'
- 'DONE'
error: !ruby/object:Api::OpAsync::Error
path: 'error/errors'
message: 'message'
parameters:
- !ruby/object:Api::Type::ResourceRef
name: 'backendBucket'
resource: 'BackendBucket'
imports: 'name'
description: |
The backend bucket this signed URL key belongs.
required: true
input: true
properties:
- !ruby/object:Api::Type::String
name: 'name'
api_name: 'keyName'
description: |
Name of the signed URL key.
required: true
input: true
- !ruby/object:Api::Type::String
name: 'keyValue'
description: |
128-bit key value used for signing the URL. The key value must be a
valid RFC 4648 Section 5 base64url encoded string.
required: true
input: true
- !ruby/object:Api::Resource
name: 'BackendService'
kind: 'compute#backendService'
base_url: projects/{{project}}/global/backendServices
collection_url_key: 'items'
has_self_link: true
description: |
A Backend Service defines a group of virtual machines that will serve
traffic for load balancing. This resource is a global backend service,
appropriate for external load balancing or self-managed internal load balancing.
For managed internal load balancing, use a regional backend service instead.
Currently self-managed internal load balancing is only available in beta.
references: !ruby/object:Api::Resource::ReferenceLinks
guides:
'Official Documentation': 'https://cloud.google.com/compute/docs/load-balancing/http/backend-service'
api: 'https://cloud.google.com/compute/docs/reference/v1/backendServices'
async: !ruby/object:Api::OpAsync
operation: !ruby/object:Api::OpAsync::Operation
kind: 'compute#operation'
path: 'name'
base_url: 'projects/{{project}}/global/operations/{{op_id}}'
wait_ms: 1000
result: !ruby/object:Api::OpAsync::Result
path: 'targetLink'
status: !ruby/object:Api::OpAsync::Status
path: 'status'
complete: 'DONE'
allowed:
- 'PENDING'
- 'RUNNING'
- 'DONE'
error: !ruby/object:Api::OpAsync::Error
path: 'error/errors'
message: 'message'
properties:
- !ruby/object:Api::Type::Integer
name: 'affinityCookieTtlSec'
description: |
Lifetime of cookies in seconds if session_affinity is
GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts
only until the end of the browser session (or equivalent). The
maximum allowed value for TTL is one day.
When the load balancing scheme is INTERNAL, this field is not used.
- !ruby/object:Api::Type::Array
name: 'backends'
description: |
The set of backends that serve this BackendService.
item_type: !ruby/object:Api::Type::NestedObject
properties:
- !ruby/object:Api::Type::Enum
name: 'balancingMode'
default_value: :UTILIZATION
values:
- :UTILIZATION
- :RATE
- :CONNECTION
description: |
Specifies the balancing mode for this backend.
For global HTTP(S) or TCP/SSL load balancing, the default is
UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S))
and CONNECTION (for TCP/SSL).
See the [Backend Services Overview](https://cloud.google.com/load-balancing/docs/backend-service#balancing-mode)
for an explanation of load balancing modes.
- !ruby/object:Api::Type::Double
name: 'capacityScaler'
send_empty_value: true
default_value: 1.0
description: |
A multiplier applied to the group's maximum servicing capacity
(based on UTILIZATION, RATE or CONNECTION).
Default value is 1, which means the group will serve up to 100%
of its configured capacity (depending on balancingMode). A
setting of 0 means the group is completely drained, offering
0% of its available Capacity. Valid range is [0.0,1.0].
- !ruby/object:Api::Type::String
name: 'description'
description: |
An optional description of this resource.
Provide this property when you create the resource.
- !ruby/object:Api::Type::String
name: 'group'
description: |
The fully-qualified URL of an Instance Group or Network Endpoint
Group resource. In case of instance group this defines the list
of instances that serve traffic. Member virtual machine
instances from each instance group must live in the same zone as
the instance group itself. No two backends in a backend service
are allowed to use same Instance Group resource.
For Network Endpoint Groups this defines list of endpoints. All
endpoints of Network Endpoint Group must be hosted on instances
located in the same zone as the Network Endpoint Group.
Backend services cannot mix Instance Group and
Network Endpoint Group backends.
Note that you must specify an Instance Group or Network Endpoint
Group resource using the fully-qualified URL, rather than a
partial URL.
required: true
- !ruby/object:Api::Type::Integer
name: 'maxConnections'
description: |
The max number of simultaneous connections for the group. Can
be used with either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or one
of maxConnectionsPerInstance or maxConnectionsPerEndpoint,
as appropriate for group type, must be set.
- !ruby/object:Api::Type::Integer
name: 'maxConnectionsPerInstance'
description: |
The max number of simultaneous connections that a single
backend instance can handle. This is used to calculate the
capacity of the group. Can be used in either CONNECTION or
UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or
maxConnectionsPerInstance must be set.
- !ruby/object:Api::Type::Integer
name: 'maxConnectionsPerEndpoint'
description: |
The max number of simultaneous connections that a single backend
network endpoint can handle. This is used to calculate the
capacity of the group. Can be used in either CONNECTION or
UTILIZATION balancing modes.
For CONNECTION mode, either
maxConnections or maxConnectionsPerEndpoint must be set.
- !ruby/object:Api::Type::Integer
name: 'maxRate'
description: |
The max requests per second (RPS) of the group.
Can be used with either RATE or UTILIZATION balancing modes,
but required if RATE mode. For RATE mode, either maxRate or one
of maxRatePerInstance or maxRatePerEndpoint, as appropriate for
group type, must be set.
- !ruby/object:Api::Type::Double
name: 'maxRatePerInstance'
description: |
The max requests per second (RPS) that a single backend
instance can handle. This is used to calculate the capacity of
the group. Can be used in either balancing mode. For RATE mode,
either maxRate or maxRatePerInstance must be set.
- !ruby/object:Api::Type::Double
name: 'maxRatePerEndpoint'
description: |
The max requests per second (RPS) that a single backend network
endpoint can handle. This is used to calculate the capacity of
the group. Can be used in either balancing mode. For RATE mode,
either maxRate or maxRatePerEndpoint must be set.
- !ruby/object:Api::Type::Double
name: 'maxUtilization'
description: |
Used when balancingMode is UTILIZATION. This ratio defines the
CPU utilization target for the group. Valid range is [0.0, 1.0].