v1beta1.d.ts
75.4 KB
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
/**
* Copyright 2019 Google LLC
*
* 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.
*/
import { GaxiosPromise } from 'gaxios';
import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library';
import { APIRequestContext, BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common';
export declare namespace runtimeconfig_v1beta1 {
interface Options extends GlobalOptions {
version: 'v1beta1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API
* access, quota, and reports. Required unless you provide an OAuth 2.0
* token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be
* any arbitrary string assigned to a user, but should not exceed 40
* characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud Runtime Configuration API
*
* The Runtime Configurator allows you to dynamically configure and expose
* variables through Google Cloud Platform. In addition, you can also set
* Watchers and Waiters that will watch for changes to your data and return
* based on certain conditions.
*
* @example
* const {google} = require('googleapis');
* const runtimeconfig = google.runtimeconfig('v1beta1');
*
* @namespace runtimeconfig
* @type {Function}
* @version v1beta1
* @variation v1beta1
* @param {object=} options Options for Runtimeconfig
*/
class Runtimeconfig {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Associates `members` with a `role`.
*/
interface Schema$Binding {
/**
* The condition that is associated with this binding. NOTE: an unsatisfied
* condition will not allow user access via current binding. Different
* bindings, including their conditions, are examined independently.
*/
condition?: Schema$Expr;
/**
* Specifies the identities requesting access for a Cloud Platform resource.
* `members` can have the following values: * `allUsers`: A special
* identifier that represents anyone who is on the internet; with or
* without a Google account. * `allAuthenticatedUsers`: A special
* identifier that represents anyone who is authenticated with a Google
* account or a service account. * `user:{emailid}`: An email address that
* represents a specific Google account. For example, `alice@gmail.com` .
* * `serviceAccount:{emailid}`: An email address that represents a service
* account. For example, `my-other-app@appspot.gserviceaccount.com`. *
* `group:{emailid}`: An email address that represents a Google group. For
* example, `admins@example.com`. * `domain:{domain}`: The G Suite domain
* (primary) that represents all the users of that domain. For example,
* `google.com` or `example.com`.
*/
members?: string[];
/**
* Role that is assigned to `members`. For example, `roles/viewer`,
* `roles/editor`, or `roles/owner`.
*/
role?: string;
}
/**
* A Cardinality condition for the Waiter resource. A cardinality condition is
* met when the number of variables under a specified path prefix reaches a
* predefined number. For example, if you set a Cardinality condition where
* the `path` is set to `/foo` and the number of paths is set to `2`, the
* following variables would meet the condition in a RuntimeConfig resource:
* + `/foo/variable1 = "value1"` + `/foo/variable2 =
* "value2"` + `/bar/variable3 = "value3"` It would not
* satisfy the same condition with the `number` set to `3`, however, because
* there is only 2 paths that start with `/foo`. Cardinality conditions are
* recursive; all subtrees under the specific path prefix are counted.
*/
interface Schema$Cardinality {
/**
* The number variables under the `path` that must exist to meet this
* condition. Defaults to 1 if not specified.
*/
number?: number;
/**
* The root of the variable subtree to monitor. For example, `/foo`.
*/
path?: string;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated
* empty messages in your APIs. A typical example is to use it as the request
* or the response type of an API method. For instance: service Foo { rpc
* Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
* representation for `Empty` is empty JSON object `{}`.
*/
interface Schema$Empty {
}
/**
* The condition that a Waiter resource is waiting for.
*/
interface Schema$EndCondition {
/**
* The cardinality of the `EndCondition`.
*/
cardinality?: Schema$Cardinality;
}
/**
* Represents an expression text. Example: title: "User account
* presence" description: "Determines whether the request has a
* user account" expression: "size(request.user) > 0"
*/
interface Schema$Expr {
/**
* An optional description of the expression. This is a longer text which
* describes the expression, e.g. when hovered over it in a UI.
*/
description?: string;
/**
* Textual representation of an expression in Common Expression Language
* syntax. The application context of the containing message determines
* which well-known feature set of CEL is supported.
*/
expression?: string;
/**
* An optional string indicating the location of the expression for error
* reporting, e.g. a file name and a position in the file.
*/
location?: string;
/**
* An optional title for the expression, i.e. a short string describing its
* purpose. This can be used e.g. in UIs which allow to enter the
* expression.
*/
title?: string;
}
/**
* `ListConfigs()` returns the following response. The order of returned
* objects is arbitrary; that is, it is not ordered in any particular way.
*/
interface Schema$ListConfigsResponse {
/**
* A list of the configurations in the project. The order of returned
* objects is arbitrary; that is, it is not ordered in any particular way.
*/
configs?: Schema$RuntimeConfig[];
/**
* This token allows you to get the next page of results for list requests.
* If the number of results is larger than `pageSize`, use the
* `nextPageToken` as a value for the query parameter `pageToken` in the
* next list request. Subsequent list requests will have their own
* `nextPageToken` to continue paging through the results
*/
nextPageToken?: string;
}
/**
* Response for the `ListVariables()` method.
*/
interface Schema$ListVariablesResponse {
/**
* This token allows you to get the next page of results for list requests.
* If the number of results is larger than `pageSize`, use the
* `nextPageToken` as a value for the query parameter `pageToken` in the
* next list request. Subsequent list requests will have their own
* `nextPageToken` to continue paging through the results
*/
nextPageToken?: string;
/**
* A list of variables and their values. The order of returned variable
* objects is arbitrary.
*/
variables?: Schema$Variable[];
}
/**
* Response for the `ListWaiters()` method. Order of returned waiter objects
* is arbitrary.
*/
interface Schema$ListWaitersResponse {
/**
* This token allows you to get the next page of results for list requests.
* If the number of results is larger than `pageSize`, use the
* `nextPageToken` as a value for the query parameter `pageToken` in the
* next list request. Subsequent list requests will have their own
* `nextPageToken` to continue paging through the results
*/
nextPageToken?: string;
/**
* Found waiters in the project.
*/
waiters?: Schema$Waiter[];
}
/**
* This resource represents a long-running operation that is the result of a
* network API call.
*/
interface Schema$Operation {
/**
* 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.
*/
done?: boolean;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* 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.
*/
metadata?: {
[key: string]: any;
};
/**
* 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 have the format of `operations/some/unique/name`.
*/
name?: string;
/**
* The normal response of the operation in case of success. If the original
* method returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx` is
* the original method name. For example, if the original method name is
* `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {
[key: string]: any;
};
}
/**
* Defines an Identity and Access Management (IAM) policy. It is used to
* specify access control policies for Cloud Platform resources. A `Policy`
* consists of a list of `bindings`. A `binding` binds a list of `members` to
* a `role`, where the members can be user accounts, Google groups, Google
* domains, and service accounts. A `role` is a named list of permissions
* defined by IAM. **JSON Example** { "bindings": [ {
* "role": "roles/owner", "members": [
* "user:mike@example.com", "group:admins@example.com",
* "domain:google.com",
* "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, {
* "role": "roles/viewer", "members":
* ["user:sean@example.com"] } ] } **YAML
* Example** bindings: - members: - user:mike@example.com -
* group:admins@example.com - domain:google.com -
* serviceAccount:my-other-app@appspot.gserviceaccount.com role:
* roles/owner - members: - user:sean@example.com role:
* roles/viewer For a description of IAM and its features, see the [IAM
* developer's guide](https://cloud.google.com/iam/docs).
*/
interface Schema$Policy {
/**
* Associates a list of `members` to a `role`. `bindings` with no members
* will result in an error.
*/
bindings?: Schema$Binding[];
/**
* `etag` is used for optimistic concurrency control as a way to help
* prevent simultaneous updates of a policy from overwriting each other. It
* is strongly suggested that systems make use of the `etag` in the
* read-modify-write cycle to perform policy updates in order to avoid race
* conditions: An `etag` is returned in the response to `getIamPolicy`, and
* systems are expected to put that etag in the request to `setIamPolicy` to
* ensure that their change will be applied to the same version of the
* policy. If no `etag` is provided in the call to `setIamPolicy`, then the
* existing policy is overwritten blindly.
*/
etag?: string;
/**
* Deprecated.
*/
version?: number;
}
/**
* A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
* service. A RuntimeConfig resource consists of metadata and a hierarchy of
* variables.
*/
interface Schema$RuntimeConfig {
/**
* An optional description of the RuntimeConfig object.
*/
description?: string;
/**
* The resource name of a runtime config. The name must have the format:
* projects/[PROJECT_ID]/configs/[CONFIG_NAME] The `[PROJECT_ID]` must be a
* valid project ID, and `[CONFIG_NAME]` is an arbitrary name that matches
* the `[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])?` regular
* expression. The length of `[CONFIG_NAME]` must be less than 64
* characters. You pick the RuntimeConfig resource name, but the server
* will validate that the name adheres to this format. After you create the
* resource, you cannot change the resource's name.
*/
name?: string;
}
/**
* Request message for `SetIamPolicy` method.
*/
interface Schema$SetIamPolicyRequest {
/**
* REQUIRED: The complete policy to be applied to the `resource`. The size
* of the policy is limited to a few 10s of KB. An empty policy is a valid
* policy but certain Cloud Platform services (such as Projects) might
* reject them.
*/
policy?: Schema$Policy;
}
/**
* 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). The error model is designed to be:
* - Simple to use and understand for most users - Flexible enough to meet
* unexpected needs # Overview The `Status` message contains three pieces of
* data: error code, error message, and error details. The error code should
* be an enum value of google.rpc.Code, but it may accept additional error
* codes if needed. The error message should be a developer-facing English
* message that helps developers *understand* and *resolve* the error. If a
* localized user-facing error message is needed, put the localized message in
* the error details or localize it in the client. The optional error details
* may contain arbitrary information about the error. There is a predefined
* set of error detail types in the package `google.rpc` that can be used for
* common error conditions. # Language mapping The `Status` message is the
* logical representation of the error model, but it is not necessarily the
* actual wire format. When the `Status` message is exposed in different
* client libraries and different wire protocols, it can be mapped
* differently. For example, it will likely be mapped to some exceptions in
* Java, but more likely mapped to some error codes in C. # Other uses The
* error model and the `Status` message can be used in a variety of
* environments, either with or without APIs, to provide a consistent
* developer experience across different environments. Example uses of this
* error model include: - Partial errors. If a service needs to return
* partial errors to the client, it may embed the `Status` in the normal
* response to indicate the partial errors. - Workflow errors. A typical
* workflow has multiple steps. Each step may have a `Status` message for
* error reporting. - Batch operations. If a client uses batch request and
* batch response, the `Status` message should be used directly inside
* batch response, one for each error sub-response. - Asynchronous
* operations. If an API call embeds asynchronous operation results in its
* response, the status of those operations should be represented directly
* using the `Status` message. - Logging. If some API errors are stored in
* logs, the message `Status` could be used directly after any stripping
* needed for security/privacy reasons.
*/
interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number;
/**
* A list of messages that carry the error details. There is a common set
* of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}>;
/**
* 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.
*/
message?: string;
}
/**
* Request message for `TestIamPermissions` method.
*/
interface Schema$TestIamPermissionsRequest {
/**
* The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed.
* For more information see [IAM
* Overview](https://cloud.google.com/iam/docs/overview#permissions).
*/
permissions?: string[];
}
/**
* Response message for `TestIamPermissions` method.
*/
interface Schema$TestIamPermissionsResponse {
/**
* A subset of `TestPermissionsRequest.permissions` that the caller is
* allowed.
*/
permissions?: string[];
}
/**
* Describes a single variable within a RuntimeConfig resource. The name
* denotes the hierarchical variable name. For example, `ports/serving_port`
* is a valid variable name. The variable value is an opaque string and only
* leaf variables can have values (that is, variables that do not have any
* child variables).
*/
interface Schema$Variable {
/**
* The name of the variable resource, in the format:
* projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME] The
* `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
* valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file
* system file path naming. The `[VARIABLE_NAME]` can contain ASCII
* letters, numbers, slashes and dashes. Slashes are used as path element
* separators and are not part of the `[VARIABLE_NAME]` itself, so
* `[VARIABLE_NAME]` must contain at least one non-slash character. Multiple
* slashes are coalesced into single slash character. Each path segment
* should match [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular
* expression. The length of a `[VARIABLE_NAME]` must be less than 256
* characters. Once you create a variable, you cannot change the variable
* name.
*/
name?: string;
/**
* Output only. The current state of the variable. The variable state
* indicates the outcome of the `variables().watch` call and is visible
* through the `get` and `list` calls.
*/
state?: string;
/**
* The string value of the variable. The length of the value must be less
* than 4096 bytes. Empty values are also accepted. For example, `text:
* "my text value"`. The string must be valid UTF-8.
*/
text?: string;
/**
* Output only. The time of the last variable update. Timestamp will be UTC
* timestamp.
*/
updateTime?: string;
/**
* The binary value of the variable. The length of the value must be less
* than 4096 bytes. Empty values are also accepted. The value must be base64
* encoded, and must comply with IETF RFC4648
* (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text` can
* be set.
*/
value?: string;
}
/**
* A Waiter resource waits for some end condition within a RuntimeConfig
* resource to be met before it returns. For example, assume you have a
* distributed system where each node writes to a Variable resource indicating
* the node's readiness as part of the startup process. You then
* configure a Waiter resource with the success condition set to wait until
* some number of nodes have checked in. Afterwards, your application runs
* some arbitrary code after the condition has been met and the waiter returns
* successfully. Once created, a Waiter resource is immutable. To learn more
* about using waiters, read the [Creating a
* Waiter](/deployment-manager/runtime-configurator/creating-a-waiter)
* documentation.
*/
interface Schema$Waiter {
/**
* Output only. The instant at which this Waiter resource was created.
* Adding the value of `timeout` to this instant yields the timeout deadline
* for the waiter.
*/
createTime?: string;
/**
* Output only. If the value is `false`, it means the waiter is still
* waiting for one of its conditions to be met. If true, the waiter has
* finished. If the waiter finished due to a timeout or failure, `error`
* will be set.
*/
done?: boolean;
/**
* Output only. If the waiter ended due to a failure or timeout, this value
* will be set.
*/
error?: Schema$Status;
/**
* [Optional] The failure condition of this waiter. If this condition is
* met, `done` will be set to `true` and the `error` code will be set to
* `ABORTED`. The failure condition takes precedence over the success
* condition. If both conditions are met, a failure will be indicated. This
* value is optional; if no failure condition is set, the only failure
* scenario will be a timeout.
*/
failure?: Schema$EndCondition;
/**
* The name of the Waiter resource, in the format:
* projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME] The
* `[PROJECT_ID]` must be a valid Google Cloud project ID, the
* `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the
* `[WAITER_NAME]` must match RFC 1035 segment specification, and the length
* of `[WAITER_NAME]` must be less than 64 bytes. After you create a Waiter
* resource, you cannot change the resource name.
*/
name?: string;
/**
* [Required] The success condition. If this condition is met, `done` will
* be set to `true` and the `error` value will remain unset. The failure
* condition takes precedence over the success condition. If both conditions
* are met, a failure will be indicated.
*/
success?: Schema$EndCondition;
/**
* [Required] Specifies the timeout of the waiter in seconds, beginning from
* the instant that `waiters().create` method is called. If this time
* elapses before the success or failure conditions are met, the waiter
* fails and sets the `error` code to `DEADLINE_EXCEEDED`.
*/
timeout?: string;
}
/**
* Request for the `WatchVariable()` method.
*/
interface Schema$WatchVariableRequest {
/**
* If specified, checks the current timestamp of the variable and if the
* current timestamp is newer than `newerThan` timestamp, the method returns
* immediately. If not specified or the variable has an older timestamp,
* the watcher waits for a the value to change before returning.
*/
newerThan?: string;
}
class Resource$Projects {
context: APIRequestContext;
configs: Resource$Projects$Configs;
constructor(context: APIRequestContext);
}
class Resource$Projects$Configs {
context: APIRequestContext;
operations: Resource$Projects$Configs$Operations;
variables: Resource$Projects$Configs$Variables;
waiters: Resource$Projects$Configs$Waiters;
constructor(context: APIRequestContext);
/**
* runtimeconfig.projects.configs.create
* @desc Creates a new RuntimeConfig resource. The configuration name must
* be unique within project.
* @alias runtimeconfig.projects.configs.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848) for this request, in the format `projects/[PROJECT_ID]`.
* @param {string=} params.requestId An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters.
* @param {().RuntimeConfig} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Configs$Create, options?: MethodOptions): GaxiosPromise<Schema$RuntimeConfig>;
create(params: Params$Resource$Projects$Configs$Create, options: MethodOptions | BodyResponseCallback<Schema$RuntimeConfig>, callback: BodyResponseCallback<Schema$RuntimeConfig>): void;
create(params: Params$Resource$Projects$Configs$Create, callback: BodyResponseCallback<Schema$RuntimeConfig>): void;
create(callback: BodyResponseCallback<Schema$RuntimeConfig>): void;
/**
* runtimeconfig.projects.configs.delete
* @desc Deletes a RuntimeConfig resource.
* @alias runtimeconfig.projects.configs.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The RuntimeConfig resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Configs$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Configs$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Configs$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* runtimeconfig.projects.configs.get
* @desc Gets information about a RuntimeConfig resource.
* @alias runtimeconfig.projects.configs.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the RuntimeConfig resource to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Configs$Get, options?: MethodOptions): GaxiosPromise<Schema$RuntimeConfig>;
get(params: Params$Resource$Projects$Configs$Get, options: MethodOptions | BodyResponseCallback<Schema$RuntimeConfig>, callback: BodyResponseCallback<Schema$RuntimeConfig>): void;
get(params: Params$Resource$Projects$Configs$Get, callback: BodyResponseCallback<Schema$RuntimeConfig>): void;
get(callback: BodyResponseCallback<Schema$RuntimeConfig>): void;
/**
* runtimeconfig.projects.configs.getIamPolicy
* @desc Gets the access control policy for a resource. Returns an empty
* policy if the resource exists and does not have a policy set.
* @alias runtimeconfig.projects.configs.getIamPolicy
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
getIamPolicy(params?: Params$Resource$Projects$Configs$Getiampolicy, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
getIamPolicy(params: Params$Resource$Projects$Configs$Getiampolicy, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
getIamPolicy(params: Params$Resource$Projects$Configs$Getiampolicy, callback: BodyResponseCallback<Schema$Policy>): void;
getIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* runtimeconfig.projects.configs.list
* @desc Lists all the RuntimeConfig resources within project.
* @alias runtimeconfig.projects.configs.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements.
* @param {string=} params.pageToken Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results.
* @param {string} params.parent The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848) for this request, in the format `projects/[PROJECT_ID]`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Configs$List, options?: MethodOptions): GaxiosPromise<Schema$ListConfigsResponse>;
list(params: Params$Resource$Projects$Configs$List, options: MethodOptions | BodyResponseCallback<Schema$ListConfigsResponse>, callback: BodyResponseCallback<Schema$ListConfigsResponse>): void;
list(params: Params$Resource$Projects$Configs$List, callback: BodyResponseCallback<Schema$ListConfigsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListConfigsResponse>): void;
/**
* runtimeconfig.projects.configs.setIamPolicy
* @desc Sets the access control policy on the specified resource. Replaces
* any existing policy.
* @alias runtimeconfig.projects.configs.setIamPolicy
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
* @param {().SetIamPolicyRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
setIamPolicy(params?: Params$Resource$Projects$Configs$Setiampolicy, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
setIamPolicy(params: Params$Resource$Projects$Configs$Setiampolicy, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
setIamPolicy(params: Params$Resource$Projects$Configs$Setiampolicy, callback: BodyResponseCallback<Schema$Policy>): void;
setIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* runtimeconfig.projects.configs.testIamPermissions
* @desc Returns permissions that a caller has on the specified resource. If
* the resource does not exist, this will return an empty set of
* permissions, not a NOT_FOUND error. Note: This operation is designed to
* be used for building permission-aware UIs and command-line tools, not for
* authorization checking. This operation may "fail open" without warning.
* @alias runtimeconfig.projects.configs.testIamPermissions
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
* @param {().TestIamPermissionsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
testIamPermissions(params?: Params$Resource$Projects$Configs$Testiampermissions, options?: MethodOptions): GaxiosPromise<Schema$TestIamPermissionsResponse>;
testIamPermissions(params: Params$Resource$Projects$Configs$Testiampermissions, options: MethodOptions | BodyResponseCallback<Schema$TestIamPermissionsResponse>, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(params: Params$Resource$Projects$Configs$Testiampermissions, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
/**
* runtimeconfig.projects.configs.update
* @desc Updates a RuntimeConfig resource. The configuration must exist
* beforehand.
* @alias runtimeconfig.projects.configs.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the RuntimeConfig resource to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`
* @param {().RuntimeConfig} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Projects$Configs$Update, options?: MethodOptions): GaxiosPromise<Schema$RuntimeConfig>;
update(params: Params$Resource$Projects$Configs$Update, options: MethodOptions | BodyResponseCallback<Schema$RuntimeConfig>, callback: BodyResponseCallback<Schema$RuntimeConfig>): void;
update(params: Params$Resource$Projects$Configs$Update, callback: BodyResponseCallback<Schema$RuntimeConfig>): void;
update(callback: BodyResponseCallback<Schema$RuntimeConfig>): void;
}
interface Params$Resource$Projects$Configs$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The [project
* ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)
* for this request, in the format `projects/[PROJECT_ID]`.
*/
parent?: string;
/**
* An optional but recommended unique `request_id`. If the server receives
* two `create()` requests with the same `request_id`, then the second
* request will be ignored and the first resource created and stored in the
* backend is returned. Empty `request_id` fields are ignored. It is
* responsibility of the client to ensure uniqueness of the `request_id`
* strings. `request_id` strings are limited to 64 characters.
*/
requestId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RuntimeConfig;
}
interface Params$Resource$Projects$Configs$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The RuntimeConfig resource to delete, in the format:
* `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`
*/
name?: string;
}
interface Params$Resource$Projects$Configs$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the RuntimeConfig resource to retrieve, in the format:
* `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`
*/
name?: string;
}
interface Params$Resource$Projects$Configs$Getiampolicy extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* REQUIRED: The resource for which the policy is being requested. See the
* operation documentation for the appropriate value for this field.
*/
resource?: string;
}
interface Params$Resource$Projects$Configs$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Specifies the number of results to return per page. If there are fewer
* elements than the specified number, returns all elements.
*/
pageSize?: number;
/**
* Specifies a page token to use. Set `pageToken` to a `nextPageToken`
* returned by a previous list request to get the next page of results.
*/
pageToken?: string;
/**
* The [project
* ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)
* for this request, in the format `projects/[PROJECT_ID]`.
*/
parent?: string;
}
interface Params$Resource$Projects$Configs$Setiampolicy extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* REQUIRED: The resource for which the policy is being specified. See the
* operation documentation for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SetIamPolicyRequest;
}
interface Params$Resource$Projects$Configs$Testiampermissions extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* REQUIRED: The resource for which the policy detail is being requested.
* See the operation documentation for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TestIamPermissionsRequest;
}
interface Params$Resource$Projects$Configs$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the RuntimeConfig resource to update, in the format:
* `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RuntimeConfig;
}
class Resource$Projects$Configs$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* runtimeconfig.projects.configs.operations.get
* @desc Gets the latest state of a long-running operation. Clients can use
* this method to poll the operation result at intervals as recommended by
* the API service.
* @alias runtimeconfig.projects.configs.operations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Configs$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
get(params: Params$Resource$Projects$Configs$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
get(params: Params$Resource$Projects$Configs$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
get(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* runtimeconfig.projects.configs.operations.testIamPermissions
* @desc Returns permissions that a caller has on the specified resource. If
* the resource does not exist, this will return an empty set of
* permissions, not a NOT_FOUND error. Note: This operation is designed to
* be used for building permission-aware UIs and command-line tools, not for
* authorization checking. This operation may "fail open" without warning.
* @alias runtimeconfig.projects.configs.operations.testIamPermissions
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
* @param {().TestIamPermissionsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
testIamPermissions(params?: Params$Resource$Projects$Configs$Operations$Testiampermissions, options?: MethodOptions): GaxiosPromise<Schema$TestIamPermissionsResponse>;
testIamPermissions(params: Params$Resource$Projects$Configs$Operations$Testiampermissions, options: MethodOptions | BodyResponseCallback<Schema$TestIamPermissionsResponse>, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(params: Params$Resource$Projects$Configs$Operations$Testiampermissions, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
}
interface Params$Resource$Projects$Configs$Operations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource.
*/
name?: string;
}
interface Params$Resource$Projects$Configs$Operations$Testiampermissions extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* REQUIRED: The resource for which the policy detail is being requested.
* See the operation documentation for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TestIamPermissionsRequest;
}
class Resource$Projects$Configs$Variables {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* runtimeconfig.projects.configs.variables.create
* @desc Creates a variable within the given configuration. You cannot
* create a variable with a name that is a prefix of an existing variable
* name, or a name that has an existing variable name as a prefix. To learn
* more about creating a variable, read the [Setting and Getting
* Data](/deployment-manager/runtime-configurator/set-and-get-variables)
* documentation.
* @alias runtimeconfig.projects.configs.variables.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent The path to the RutimeConfig resource that this variable should belong to. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`
* @param {string=} params.requestId An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters.
* @param {().Variable} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Configs$Variables$Create, options?: MethodOptions): GaxiosPromise<Schema$Variable>;
create(params: Params$Resource$Projects$Configs$Variables$Create, options: MethodOptions | BodyResponseCallback<Schema$Variable>, callback: BodyResponseCallback<Schema$Variable>): void;
create(params: Params$Resource$Projects$Configs$Variables$Create, callback: BodyResponseCallback<Schema$Variable>): void;
create(callback: BodyResponseCallback<Schema$Variable>): void;
/**
* runtimeconfig.projects.configs.variables.delete
* @desc Deletes a variable or multiple variables. If you specify a
* variable name, then that variable is deleted. If you specify a prefix and
* `recursive` is true, then all variables with that prefix are deleted. You
* must set a `recursive` to true if you delete variables by prefix.
* @alias runtimeconfig.projects.configs.variables.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the variable to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`
* @param {boolean=} params.recursive Set to `true` to recursively delete multiple variables with the same prefix.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Configs$Variables$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Configs$Variables$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Configs$Variables$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* runtimeconfig.projects.configs.variables.get
* @desc Gets information about a single variable.
* @alias runtimeconfig.projects.configs.variables.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the variable to return, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Configs$Variables$Get, options?: MethodOptions): GaxiosPromise<Schema$Variable>;
get(params: Params$Resource$Projects$Configs$Variables$Get, options: MethodOptions | BodyResponseCallback<Schema$Variable>, callback: BodyResponseCallback<Schema$Variable>): void;
get(params: Params$Resource$Projects$Configs$Variables$Get, callback: BodyResponseCallback<Schema$Variable>): void;
get(callback: BodyResponseCallback<Schema$Variable>): void;
/**
* runtimeconfig.projects.configs.variables.list
* @desc Lists variables within given a configuration, matching any provided
* filters. This only lists variable names, not the values, unless
* `return_values` is true, in which case only variables that user has IAM
* permission to GetVariable will be returned.
* @alias runtimeconfig.projects.configs.variables.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter Filters variables by matching the specified filter. For example: `projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.
* @param {integer=} params.pageSize Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements.
* @param {string=} params.pageToken Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results.
* @param {string} params.parent The path to the RuntimeConfig resource for which you want to list variables. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`
* @param {boolean=} params.returnValues The flag indicates whether the user wants to return values of variables. If true, then only those variables that user has IAM GetVariable permission will be returned along with their values.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Configs$Variables$List, options?: MethodOptions): GaxiosPromise<Schema$ListVariablesResponse>;
list(params: Params$Resource$Projects$Configs$Variables$List, options: MethodOptions | BodyResponseCallback<Schema$ListVariablesResponse>, callback: BodyResponseCallback<Schema$ListVariablesResponse>): void;
list(params: Params$Resource$Projects$Configs$Variables$List, callback: BodyResponseCallback<Schema$ListVariablesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListVariablesResponse>): void;
/**
* runtimeconfig.projects.configs.variables.testIamPermissions
* @desc Returns permissions that a caller has on the specified resource. If
* the resource does not exist, this will return an empty set of
* permissions, not a NOT_FOUND error. Note: This operation is designed to
* be used for building permission-aware UIs and command-line tools, not for
* authorization checking. This operation may "fail open" without warning.
* @alias runtimeconfig.projects.configs.variables.testIamPermissions
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
* @param {().TestIamPermissionsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
testIamPermissions(params?: Params$Resource$Projects$Configs$Variables$Testiampermissions, options?: MethodOptions): GaxiosPromise<Schema$TestIamPermissionsResponse>;
testIamPermissions(params: Params$Resource$Projects$Configs$Variables$Testiampermissions, options: MethodOptions | BodyResponseCallback<Schema$TestIamPermissionsResponse>, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(params: Params$Resource$Projects$Configs$Variables$Testiampermissions, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
/**
* runtimeconfig.projects.configs.variables.update
* @desc Updates an existing variable with a new value.
* @alias runtimeconfig.projects.configs.variables.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the variable to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`
* @param {().Variable} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Projects$Configs$Variables$Update, options?: MethodOptions): GaxiosPromise<Schema$Variable>;
update(params: Params$Resource$Projects$Configs$Variables$Update, options: MethodOptions | BodyResponseCallback<Schema$Variable>, callback: BodyResponseCallback<Schema$Variable>): void;
update(params: Params$Resource$Projects$Configs$Variables$Update, callback: BodyResponseCallback<Schema$Variable>): void;
update(callback: BodyResponseCallback<Schema$Variable>): void;
/**
* runtimeconfig.projects.configs.variables.watch
* @desc Watches a specific variable and waits for a change in the
* variable's value. When there is a change, this method returns the new
* value or times out. If a variable is deleted while being watched, the
* `variableState` state is set to `DELETED` and the method returns the last
* known variable `value`. If you set the deadline for watching to a larger
* value than internal timeout (60 seconds), the current variable value is
* returned and the `variableState` will be `VARIABLE_STATE_UNSPECIFIED`. To
* learn more about creating a watcher, read the [Watching a Variable for
* Changes](/deployment-manager/runtime-configurator/watching-a-variable)
* documentation.
* @alias runtimeconfig.projects.configs.variables.watch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the variable to watch, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`
* @param {().WatchVariableRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
watch(params?: Params$Resource$Projects$Configs$Variables$Watch, options?: MethodOptions): GaxiosPromise<Schema$Variable>;
watch(params: Params$Resource$Projects$Configs$Variables$Watch, options: MethodOptions | BodyResponseCallback<Schema$Variable>, callback: BodyResponseCallback<Schema$Variable>): void;
watch(params: Params$Resource$Projects$Configs$Variables$Watch, callback: BodyResponseCallback<Schema$Variable>): void;
watch(callback: BodyResponseCallback<Schema$Variable>): void;
}
interface Params$Resource$Projects$Configs$Variables$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The path to the RutimeConfig resource that this variable should belong
* to. The configuration must exist beforehand; the path must be in the
* format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`
*/
parent?: string;
/**
* An optional but recommended unique `request_id`. If the server receives
* two `create()` requests with the same `request_id`, then the second
* request will be ignored and the first resource created and stored in the
* backend is returned. Empty `request_id` fields are ignored. It is
* responsibility of the client to ensure uniqueness of the `request_id`
* strings. `request_id` strings are limited to 64 characters.
*/
requestId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Variable;
}
interface Params$Resource$Projects$Configs$Variables$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the variable to delete, in the format:
* `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`
*/
name?: string;
/**
* Set to `true` to recursively delete multiple variables with the same
* prefix.
*/
recursive?: boolean;
}
interface Params$Resource$Projects$Configs$Variables$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the variable to return, in the format:
* `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`
*/
name?: string;
}
interface Params$Resource$Projects$Configs$Variables$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Filters variables by matching the specified filter. For example:
* `projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.
*/
filter?: string;
/**
* Specifies the number of results to return per page. If there are fewer
* elements than the specified number, returns all elements.
*/
pageSize?: number;
/**
* Specifies a page token to use. Set `pageToken` to a `nextPageToken`
* returned by a previous list request to get the next page of results.
*/
pageToken?: string;
/**
* The path to the RuntimeConfig resource for which you want to list
* variables. The configuration must exist beforehand; the path must be in
* the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`
*/
parent?: string;
/**
* The flag indicates whether the user wants to return values of variables.
* If true, then only those variables that user has IAM GetVariable
* permission will be returned along with their values.
*/
returnValues?: boolean;
}
interface Params$Resource$Projects$Configs$Variables$Testiampermissions extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* REQUIRED: The resource for which the policy detail is being requested.
* See the operation documentation for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TestIamPermissionsRequest;
}
interface Params$Resource$Projects$Configs$Variables$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the variable to update, in the format:
* `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Variable;
}
interface Params$Resource$Projects$Configs$Variables$Watch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the variable to watch, in the format:
* `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$WatchVariableRequest;
}
class Resource$Projects$Configs$Waiters {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* runtimeconfig.projects.configs.waiters.create
* @desc Creates a Waiter resource. This operation returns a long-running
* Operation resource which can be polled for completion. However, a waiter
* with the given name will exist (and can be retrieved) prior to the
* operation completing. If the operation fails, the failed Waiter resource
* will still exist and must be deleted prior to subsequent creation
* attempts.
* @alias runtimeconfig.projects.configs.waiters.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent The path to the configuration that will own the waiter. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.
* @param {string=} params.requestId An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters.
* @param {().Waiter} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Configs$Waiters$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Projects$Configs$Waiters$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Projects$Configs$Waiters$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* runtimeconfig.projects.configs.waiters.delete
* @desc Deletes the waiter with the specified name.
* @alias runtimeconfig.projects.configs.waiters.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The Waiter resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Configs$Waiters$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Configs$Waiters$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Configs$Waiters$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* runtimeconfig.projects.configs.waiters.get
* @desc Gets information about a single waiter.
* @alias runtimeconfig.projects.configs.waiters.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The fully-qualified name of the Waiter resource object to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Configs$Waiters$Get, options?: MethodOptions): GaxiosPromise<Schema$Waiter>;
get(params: Params$Resource$Projects$Configs$Waiters$Get, options: MethodOptions | BodyResponseCallback<Schema$Waiter>, callback: BodyResponseCallback<Schema$Waiter>): void;
get(params: Params$Resource$Projects$Configs$Waiters$Get, callback: BodyResponseCallback<Schema$Waiter>): void;
get(callback: BodyResponseCallback<Schema$Waiter>): void;
/**
* runtimeconfig.projects.configs.waiters.list
* @desc List waiters within the given configuration.
* @alias runtimeconfig.projects.configs.waiters.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements.
* @param {string=} params.pageToken Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results.
* @param {string} params.parent The path to the configuration for which you want to get a list of waiters. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Configs$Waiters$List, options?: MethodOptions): GaxiosPromise<Schema$ListWaitersResponse>;
list(params: Params$Resource$Projects$Configs$Waiters$List, options: MethodOptions | BodyResponseCallback<Schema$ListWaitersResponse>, callback: BodyResponseCallback<Schema$ListWaitersResponse>): void;
list(params: Params$Resource$Projects$Configs$Waiters$List, callback: BodyResponseCallback<Schema$ListWaitersResponse>): void;
list(callback: BodyResponseCallback<Schema$ListWaitersResponse>): void;
/**
* runtimeconfig.projects.configs.waiters.testIamPermissions
* @desc Returns permissions that a caller has on the specified resource. If
* the resource does not exist, this will return an empty set of
* permissions, not a NOT_FOUND error. Note: This operation is designed to
* be used for building permission-aware UIs and command-line tools, not for
* authorization checking. This operation may "fail open" without warning.
* @alias runtimeconfig.projects.configs.waiters.testIamPermissions
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
* @param {().TestIamPermissionsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
testIamPermissions(params?: Params$Resource$Projects$Configs$Waiters$Testiampermissions, options?: MethodOptions): GaxiosPromise<Schema$TestIamPermissionsResponse>;
testIamPermissions(params: Params$Resource$Projects$Configs$Waiters$Testiampermissions, options: MethodOptions | BodyResponseCallback<Schema$TestIamPermissionsResponse>, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(params: Params$Resource$Projects$Configs$Waiters$Testiampermissions, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
}
interface Params$Resource$Projects$Configs$Waiters$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The path to the configuration that will own the waiter. The configuration
* must exist beforehand; the path must be in the format:
* `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.
*/
parent?: string;
/**
* An optional but recommended unique `request_id`. If the server receives
* two `create()` requests with the same `request_id`, then the second
* request will be ignored and the first resource created and stored in the
* backend is returned. Empty `request_id` fields are ignored. It is
* responsibility of the client to ensure uniqueness of the `request_id`
* strings. `request_id` strings are limited to 64 characters.
*/
requestId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Waiter;
}
interface Params$Resource$Projects$Configs$Waiters$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The Waiter resource to delete, in the format:
* `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`
*/
name?: string;
}
interface Params$Resource$Projects$Configs$Waiters$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The fully-qualified name of the Waiter resource object to retrieve, in
* the format:
* `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`
*/
name?: string;
}
interface Params$Resource$Projects$Configs$Waiters$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Specifies the number of results to return per page. If there are fewer
* elements than the specified number, returns all elements.
*/
pageSize?: number;
/**
* Specifies a page token to use. Set `pageToken` to a `nextPageToken`
* returned by a previous list request to get the next page of results.
*/
pageToken?: string;
/**
* The path to the configuration for which you want to get a list of
* waiters. The configuration must exist beforehand; the path must be in the
* format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`
*/
parent?: string;
}
interface Params$Resource$Projects$Configs$Waiters$Testiampermissions extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* REQUIRED: The resource for which the policy detail is being requested.
* See the operation documentation for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TestIamPermissionsRequest;
}
}