v1beta1.d.ts
83.6 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
1390
1391
1392
1393
1394
1395
1396
/**
* 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 { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace servicebroker_v1beta1 {
export 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;
}
/**
* Service Broker API
*
* The Google Cloud Platform Service Broker API provides Google hosted implementation of the Open Service Broker API (https://www.openservicebrokerapi.org/).
*
* @example
* const {google} = require('googleapis');
* const servicebroker = google.servicebroker('v1beta1');
*
* @namespace servicebroker
* @type {Function}
* @version v1beta1
* @variation v1beta1
* @param {object=} options Options for Servicebroker
*/
export class Servicebroker {
context: APIRequestContext;
projects: Resource$Projects;
v1beta1: Resource$V1beta1;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Describes the binding.
*/
export interface Schema$GoogleCloudServicebrokerV1beta1__Binding {
/**
* The id of the binding. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required.
*/
binding_id?: string | null;
/**
* A JSON object that contains data for platform resources associated with the binding to be created.
*/
bind_resource?: {
[key: string]: any;
} | null;
/**
* Output only. Timestamp for when the binding was created.
*/
createTime?: string | null;
/**
* Output only. String containing the Deployment Manager deployment name that was created for this binding,
*/
deploymentName?: string | null;
/**
* Configuration options for the service binding.
*/
parameters?: {
[key: string]: any;
} | null;
/**
* The ID of the plan. See `Service` and `Plan` resources for details. Maximum length is 64, GUID recommended. Required.
*/
plan_id?: string | null;
/**
* Output only. The resource name of the binding, e.g. projects/project_id/brokers/broker_id/service_instances/instance_id/bindings/binding_id.
*/
resourceName?: string | null;
/**
* The id of the service. Must be a valid identifier of a service contained in the list from a `ListServices()` call. Maximum length is 64, GUID recommended. Required.
*/
service_id?: string | null;
}
/**
* Broker represents a consumable collection of Service Registry catalogs exposed as an OSB Broker.
*/
export interface Schema$GoogleCloudServicebrokerV1beta1__Broker {
/**
* Output only. Timestamp for when the broker was created.
*/
createTime?: string | null;
/**
* Name of the broker in the format: <projects>/<project-id>/brokers/<broker>. This allows for multiple brokers per project which can be used to enable having custom brokers per GKE cluster, for example.
*/
name?: string | null;
/**
* User friendly title of the broker. Limited to 1024 characters. Requests with longer titles will be rejected.
*/
title?: string | null;
/**
* Output only. URL of the broker OSB-compliant endpoint, for example: https://servicebroker.googleapis.com/projects/<project>/brokers/<broker>
*/
url?: string | null;
}
/**
* Response for the `CreateBinding()` method.
*/
export interface Schema$GoogleCloudServicebrokerV1beta1__CreateBindingResponse {
/**
* Credentials to use the binding.
*/
credentials?: {
[key: string]: any;
} | null;
/**
* Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors
*/
description?: string | null;
/**
* If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. This broker always executes all create/delete operations asynchronously.
*/
operation?: string | null;
/**
* A URL to which the platform may proxy requests for the address sent with bind_resource.route
*/
route_service_url?: string | null;
/**
* From where to read system logs.
*/
syslog_drain_url?: string | null;
/**
* An array of configuration for mounting volumes.
*/
volume_mounts?: Array<{
[key: string]: any;
}> | null;
}
/**
* Response for the `CreateServiceInstance()` method.
*/
export interface Schema$GoogleCloudServicebrokerV1beta1__CreateServiceInstanceResponse {
/**
* Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors
*/
description?: string | null;
/**
* If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. This broker always will return a non-empty operation on success.
*/
operation?: string | null;
}
/**
* Message containing information required to activate Dashboard SSO feature.
*/
export interface Schema$GoogleCloudServicebrokerV1beta1__DashboardClient {
/**
* The id of the Oauth client that the dashboard will use.
*/
id?: string | null;
/**
* A URI for the service dashboard. Validated by the OAuth token server when the dashboard requests a token.
*/
redirect_uri?: string | null;
/**
* A secret for the dashboard client.
*/
secret?: string | null;
}
/**
* Response for the `DeleteBinding()` method.
*/
export interface Schema$GoogleCloudServicebrokerV1beta1__DeleteBindingResponse {
/**
* Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors
*/
description?: string | null;
/**
* If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation.
*/
operation?: string | null;
}
/**
* Response for the `DeleteServiceInstance()` method.
*/
export interface Schema$GoogleCloudServicebrokerV1beta1__DeleteServiceInstanceResponse {
/**
* Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors
*/
description?: string | null;
/**
* If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation.
*/
operation?: string | null;
}
/**
* Response for the `GetBinding()` method.
*/
export interface Schema$GoogleCloudServicebrokerV1beta1__GetBindingResponse {
/**
* Credentials to use the binding.
*/
credentials?: {
[key: string]: any;
} | null;
/**
* String containing the Deployment Manager deployment name that was created for this binding,
*/
deploymentName?: string | null;
/**
* Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors
*/
description?: string | null;
/**
* Output only. The resource name of the binding, e.g. projects/project_id/brokers/broker_id/service_instances/instance_id/bindings/binding_id.
*/
resourceName?: string | null;
/**
* A URL to which the platform may proxy requests for the address sent with bind_resource.route
*/
route_service_url?: string | null;
/**
* From where to read system logs.
*/
syslog_drain_url?: string | null;
/**
* An array of configurations for mounting volumes.
*/
volume_mounts?: Array<{
[key: string]: any;
}> | null;
}
/**
* The response for the `ListBindings()` method.
*/
export interface Schema$GoogleCloudServicebrokerV1beta1__ListBindingsResponse {
/**
* The list of bindings in the instance.
*/
bindings?: Schema$GoogleCloudServicebrokerV1beta1__Binding[];
/**
* Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors
*/
description?: string | null;
/**
* 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 | null;
}
/**
* The response for the `ListBrokers()` method.
*/
export interface Schema$GoogleCloudServicebrokerV1beta1__ListBrokersResponse {
/**
* The list of brokers in the container.
*/
brokers?: Schema$GoogleCloudServicebrokerV1beta1__Broker[];
/**
* 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 | null;
}
/**
* Response message for the `ListCatalog()` method.
*/
export interface Schema$GoogleCloudServicebrokerV1beta1__ListCatalogResponse {
/**
* Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors
*/
description?: string | null;
/**
* 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 | null;
/**
* The services available for the requested GCP project.
*/
services?: Schema$GoogleCloudServicebrokerV1beta1__Service[];
}
/**
* The response for the `ListServiceInstances()` method.
*/
export interface Schema$GoogleCloudServicebrokerV1beta1__ListServiceInstancesResponse {
/**
* Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors
*/
description?: string | null;
/**
* The list of instances in the broker.
*/
instances?: Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance[];
/**
* 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 | null;
}
/**
* Describes a long running operation, which conforms to OpenService API.
*/
export interface Schema$GoogleCloudServicebrokerV1beta1__Operation {
/**
* Optional description of the Operation state.
*/
description?: string | null;
/**
* The state of the operation. Valid values are: "in progress", "succeeded", and "failed".
*/
state?: string | null;
}
/**
* Plan message describes a Service Plan.
*/
export interface Schema$GoogleCloudServicebrokerV1beta1__Plan {
/**
* Specifies whether instances of the service can be bound to applications. If not specified, `Service.bindable` will be presumed.
*/
bindable?: boolean | null;
/**
* Textual description of the plan. Optional.
*/
description?: string | null;
/**
* Whether the service is free.
*/
free?: boolean | null;
/**
* ID is a globally unique identifier used to uniquely identify the plan. User must make no presumption about the format of this field.
*/
id?: string | null;
/**
* A list of metadata for a service offering. Metadata is an arbitrary JSON object.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* User friendly name of the plan. The name must be globally unique within GCP project. Note, which is different from ("This must be globally unique within a platform marketplace").
*/
name?: string | null;
/**
* Schema definitions for service instances and bindings for the plan.
*/
schemas?: {
[key: string]: any;
} | null;
}
/**
* The resource model mostly follows the Open Service Broker API, as described here: https://github.com/openservicebrokerapi/servicebroker/blob/master/_spec.md Though due to Google Specifics it has additional optional fields.
*/
export interface Schema$GoogleCloudServicebrokerV1beta1__Service {
/**
* Specifies whether instances of the service can be bound to applications. Required.
*/
bindable?: boolean | null;
/**
* Whether the service provides an endpoint to get service bindings.
*/
bindings_retrievable?: boolean | null;
/**
* Whether the service provides an endpoint to get service bindings.
*/
binding_retrievable?: boolean | null;
/**
* Information to activate Dashboard SSO feature.
*/
dashboard_client?: Schema$GoogleCloudServicebrokerV1beta1__DashboardClient;
/**
* Textual description of the service. Required.
*/
description?: string | null;
/**
* ID is a globally unique identifier used to uniquely identify the service. ID is an opaque string.
*/
id?: string | null;
/**
* Whether the service provides an endpoint to get service instances.
*/
instances_retrievable?: boolean | null;
/**
* A list of metadata for a service offering. Metadata is an arbitrary JSON object.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* User friendly service name. Name must match [a-z0-9]+ regexp. The name must be globally unique within GCP project. Note, which is different from ("This must be globally unique within a platform marketplace"). Required.
*/
name?: string | null;
/**
* A list of plans for this service. At least one plan is required.
*/
plans?: Schema$GoogleCloudServicebrokerV1beta1__Plan[];
/**
* Whether the service supports upgrade/downgrade for some plans.
*/
plan_updateable?: boolean | null;
/**
* Tags provide a flexible mechanism to expose a classification, attribute, or base technology of a service.
*/
tags?: string[] | null;
}
/**
* Message describing inputs to Provision and Update Service instance requests.
*/
export interface Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance {
/**
* Platform specific contextual information under which the service instance is to be provisioned. This replaces organization_guid and space_guid. But can also contain anything. Currently only used for logging context information.
*/
context?: {
[key: string]: any;
} | null;
/**
* Output only. Timestamp for when the instance was created.
*/
createTime?: string | null;
/**
* Output only. String containing the Deployment Manager deployment name that was created for this instance,
*/
deploymentName?: string | null;
/**
* To return errors when GetInstance call is done via HTTP to be unified with other methods.
*/
description?: string | null;
/**
* The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required.
*/
instance_id?: string | null;
/**
* The platform GUID for the organization under which the service is to be provisioned. Required.
*/
organization_guid?: string | null;
/**
* Configuration options for the service instance. Parameters is JSON object serialized to string.
*/
parameters?: {
[key: string]: any;
} | null;
/**
* The ID of the plan. See `Service` and `Plan` resources for details. Maximum length is 64, GUID recommended. Required.
*/
plan_id?: string | null;
/**
* Used only in UpdateServiceInstance request to optionally specify previous fields.
*/
previous_values?: {
[key: string]: any;
} | null;
/**
* Output only. The resource name of the instance, e.g. projects/project_id/brokers/broker_id/service_instances/instance_id
*/
resourceName?: string | null;
/**
* The id of the service. Must be a valid identifier of a service contained in the list from a `ListServices()` call. Maximum length is 64, GUID recommended. Required.
*/
service_id?: string | null;
/**
* The identifier for the project space within the platform organization. Required.
*/
space_guid?: string | null;
}
/**
* Response for the `UpdateServiceInstance()` method.
*/
export interface Schema$GoogleCloudServicebrokerV1beta1__UpdateServiceInstanceResponse {
/**
* Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors
*/
description?: string | null;
/**
* If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation.
*/
operation?: string | null;
}
/**
* Associates `members` with a `role`.
*/
export interface Schema$GoogleIamV1__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$GoogleType__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@example.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[] | null;
/**
* Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
*/
role?: string | null;
}
/**
* Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs).
*/
export interface Schema$GoogleIamV1__Policy {
/**
* Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error.
*/
bindings?: Schema$GoogleIamV1__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. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if either of incoming or stored policy does not meet the version requirements.
*/
etag?: string | null;
/**
* Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a conditional binding from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, any version compliance checks on the incoming and/or stored policy is skipped.
*/
version?: number | null;
}
/**
* Request message for `SetIamPolicy` method.
*/
export interface Schema$GoogleIamV1__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$GoogleIamV1__Policy;
}
/**
* Request message for `TestIamPermissions` method.
*/
export interface Schema$GoogleIamV1__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[] | null;
}
/**
* Response message for `TestIamPermissions` method.
*/
export interface Schema$GoogleIamV1__TestIamPermissionsResponse {
/**
* A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
*/
permissions?: string[] | null;
}
/**
* 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 `{}`.
*/
export interface Schema$GoogleProtobuf__Empty {
}
/**
* Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0"
*/
export interface Schema$GoogleType__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 | null;
/**
* 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 | null;
/**
* 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 | null;
/**
* 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 | null;
}
export class Resource$Projects {
context: APIRequestContext;
brokers: Resource$Projects$Brokers;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Brokers {
context: APIRequestContext;
instances: Resource$Projects$Brokers$Instances;
v2: Resource$Projects$Brokers$V2;
constructor(context: APIRequestContext);
/**
* servicebroker.projects.brokers.create
* @desc CreateBroker creates a Broker.
* @alias servicebroker.projects.brokers.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent The project in which to create broker.
* @param {().GoogleCloudServicebrokerV1beta1__Broker} 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$Brokers$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1beta1__Broker>;
create(params: Params$Resource$Projects$Brokers$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__Broker>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__Broker>): void;
create(params: Params$Resource$Projects$Brokers$Create, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__Broker>): void;
create(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__Broker>): void;
/**
* servicebroker.projects.brokers.delete
* @desc DeleteBroker deletes a Broker.
* @alias servicebroker.projects.brokers.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The broker to delete.
* @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$Brokers$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobuf__Empty>;
delete(params: Params$Resource$Projects$Brokers$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobuf__Empty>, callback: BodyResponseCallback<Schema$GoogleProtobuf__Empty>): void;
delete(params: Params$Resource$Projects$Brokers$Delete, callback: BodyResponseCallback<Schema$GoogleProtobuf__Empty>): void;
delete(callback: BodyResponseCallback<Schema$GoogleProtobuf__Empty>): void;
/**
* servicebroker.projects.brokers.list
* @desc ListBrokers lists brokers.
* @alias servicebroker.projects.brokers.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. Optional. Acceptable values are 0 to 200, inclusive. (Default: 100)
* @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 Parent must match `projects/[PROJECT_ID]/brokers`.
* @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$Brokers$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1beta1__ListBrokersResponse>;
list(params: Params$Resource$Projects$Brokers$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ListBrokersResponse>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ListBrokersResponse>): void;
list(params: Params$Resource$Projects$Brokers$List, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ListBrokersResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ListBrokersResponse>): void;
}
export interface Params$Resource$Projects$Brokers$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The project in which to create broker.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudServicebrokerV1beta1__Broker;
}
export interface Params$Resource$Projects$Brokers$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The broker to delete.
*/
name?: string;
}
export interface Params$Resource$Projects$Brokers$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. Optional. Acceptable values are 0 to 200, inclusive. (Default: 100)
*/
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;
/**
* Parent must match `projects/[PROJECT_ID]/brokers`.
*/
parent?: string;
}
export class Resource$Projects$Brokers$Instances {
context: APIRequestContext;
bindings: Resource$Projects$Brokers$Instances$Bindings;
constructor(context: APIRequestContext);
/**
* servicebroker.projects.brokers.instances.get
* @desc Gets the given service instance from the system. The API call accepts both OSB style API and standard google style API resource path. i.e. both `projects/x/brokers/x/instances/x` and `projects/x/brokers/x/v2/service_instances/x` are acceptable paths.
* @alias servicebroker.projects.brokers.instances.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The resource name of the instance to return. Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + `v2/service_instances/[INSTANCE_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_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
*/
get(params?: Params$Resource$Projects$Brokers$Instances$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance>;
get(params: Params$Resource$Projects$Brokers$Instances$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance>): void;
get(params: Params$Resource$Projects$Brokers$Instances$Get, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance>): void;
get(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance>): void;
/**
* servicebroker.projects.brokers.instances.getLast_operation
* @desc Returns the state of the last operation for the service instance. Only last (or current) operation can be polled.
* @alias servicebroker.projects.brokers.instances.getLast_operation
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/`+ `service_instances/[INSTANCE_ID]`.
* @param {string=} params.operation If `operation` was returned during mutation operation, this field must be populated with the provided value.
* @param {string=} params.planId Plan id.
* @param {string=} params.serviceId Service 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
*/
getLast_operation(params?: Params$Resource$Projects$Brokers$Instances$Getlast_operation, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1beta1__Operation>;
getLast_operation(params: Params$Resource$Projects$Brokers$Instances$Getlast_operation, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__Operation>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__Operation>): void;
getLast_operation(params: Params$Resource$Projects$Brokers$Instances$Getlast_operation, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__Operation>): void;
getLast_operation(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__Operation>): void;
/**
* servicebroker.projects.brokers.instances.list
* @desc Lists all the instances in the brokers This API is an extension and not part of the OSB spec. Hence the path is a standard Google API URL.
* @alias servicebroker.projects.brokers.instances.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. Optional. Acceptable values are 0 to 200, inclusive. (Default: 100)
* @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 Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_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$Brokers$Instances$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1beta1__ListServiceInstancesResponse>;
list(params: Params$Resource$Projects$Brokers$Instances$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ListServiceInstancesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ListServiceInstancesResponse>): void;
list(params: Params$Resource$Projects$Brokers$Instances$List, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ListServiceInstancesResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ListServiceInstancesResponse>): void;
}
export interface Params$Resource$Projects$Brokers$Instances$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource name of the instance to return. Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + `v2/service_instances/[INSTANCE_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`.
*/
name?: string;
}
export interface Params$Resource$Projects$Brokers$Instances$Getlast_operation extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/`+ `service_instances/[INSTANCE_ID]`.
*/
name?: string;
/**
* If `operation` was returned during mutation operation, this field must be populated with the provided value.
*/
operation?: string;
/**
* Plan id.
*/
planId?: string;
/**
* Service id.
*/
serviceId?: string;
}
export interface Params$Resource$Projects$Brokers$Instances$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. Optional. Acceptable values are 0 to 200, inclusive. (Default: 100)
*/
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;
/**
* Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`.
*/
parent?: string;
}
export class Resource$Projects$Brokers$Instances$Bindings {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* servicebroker.projects.brokers.instances.bindings.getLast_operation
* @desc Returns the state of the last operation for the binding. Only last (or current) operation can be polled.
* @alias servicebroker.projects.brokers.instances.bindings.getLast_operation
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/service_binding/[BINDING_ID]`.
* @param {string=} params.operation If `operation` was returned during mutation operation, this field must be populated with the provided value.
* @param {string=} params.planId Plan id.
* @param {string=} params.serviceId Service 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
*/
getLast_operation(params?: Params$Resource$Projects$Brokers$Instances$Bindings$Getlast_operation, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1beta1__Operation>;
getLast_operation(params: Params$Resource$Projects$Brokers$Instances$Bindings$Getlast_operation, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__Operation>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__Operation>): void;
getLast_operation(params: Params$Resource$Projects$Brokers$Instances$Bindings$Getlast_operation, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__Operation>): void;
getLast_operation(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__Operation>): void;
/**
* servicebroker.projects.brokers.instances.bindings.list
* @desc Lists all the bindings in the instance.
* @alias servicebroker.projects.brokers.instances.bindings.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. Optional. Acceptable values are 0 to 200, inclusive. (Default: 100)
* @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 Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + `v2/service_instances/[INSTANCE_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_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$Brokers$Instances$Bindings$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1beta1__ListBindingsResponse>;
list(params: Params$Resource$Projects$Brokers$Instances$Bindings$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ListBindingsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ListBindingsResponse>): void;
list(params: Params$Resource$Projects$Brokers$Instances$Bindings$List, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ListBindingsResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ListBindingsResponse>): void;
}
export interface Params$Resource$Projects$Brokers$Instances$Bindings$Getlast_operation extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/service_binding/[BINDING_ID]`.
*/
name?: string;
/**
* If `operation` was returned during mutation operation, this field must be populated with the provided value.
*/
operation?: string;
/**
* Plan id.
*/
planId?: string;
/**
* Service id.
*/
serviceId?: string;
}
export interface Params$Resource$Projects$Brokers$Instances$Bindings$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. Optional. Acceptable values are 0 to 200, inclusive. (Default: 100)
*/
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;
/**
* Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + `v2/service_instances/[INSTANCE_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`.
*/
parent?: string;
}
export class Resource$Projects$Brokers$V2 {
context: APIRequestContext;
catalog: Resource$Projects$Brokers$V2$Catalog;
service_instances: Resource$Projects$Brokers$V2$Service_instances;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Brokers$V2$Catalog {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* servicebroker.projects.brokers.v2.catalog.list
* @desc Lists all the Services registered with this broker for consumption for given service registry broker, which contains an set of services. Note, that Service producer API is separate from Broker API.
* @alias servicebroker.projects.brokers.v2.catalog.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. Optional. If unset or 0, all the results will be returned.
* @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 Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_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$Brokers$V2$Catalog$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1beta1__ListCatalogResponse>;
list(params: Params$Resource$Projects$Brokers$V2$Catalog$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ListCatalogResponse>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ListCatalogResponse>): void;
list(params: Params$Resource$Projects$Brokers$V2$Catalog$List, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ListCatalogResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ListCatalogResponse>): void;
}
export interface Params$Resource$Projects$Brokers$V2$Catalog$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. Optional. If unset or 0, all the results will be returned.
*/
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;
/**
* Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`.
*/
parent?: string;
}
export class Resource$Projects$Brokers$V2$Service_instances {
context: APIRequestContext;
service_bindings: Resource$Projects$Brokers$V2$Service_instances$Service_bindings;
constructor(context: APIRequestContext);
/**
* servicebroker.projects.brokers.v2.service_instances.create
* @desc Provisions a service instance. If `request.accepts_incomplete` is false and Broker cannot execute request synchronously HTTP 422 error will be returned along with FAILED_PRECONDITION status. If `request.accepts_incomplete` is true and the Broker decides to execute resource asynchronously then HTTP 202 response code will be returned and a valid polling operation in the response will be included. If Broker executes the request synchronously and it succeeds HTTP 201 response will be furnished. If identical instance exists, then HTTP 200 response will be returned. If an instance with identical ID but mismatching parameters exists, then HTTP 409 status code will be returned.
* @alias servicebroker.projects.brokers.v2.service_instances.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.acceptsIncomplete Value indicating that API client supports asynchronous operations. If Broker cannot execute the request synchronously HTTP 422 code will be returned to HTTP clients along with FAILED_PRECONDITION error. If true and broker will execute request asynchronously 202 HTTP code will be returned. This broker always requires this to be true as all mutator operations are asynchronous.
* @param {string} params.instance_id The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required.
* @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`.
* @param {().GoogleCloudServicebrokerV1beta1__ServiceInstance} 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$Brokers$V2$Service_instances$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1beta1__CreateServiceInstanceResponse>;
create(params: Params$Resource$Projects$Brokers$V2$Service_instances$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__CreateServiceInstanceResponse>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__CreateServiceInstanceResponse>): void;
create(params: Params$Resource$Projects$Brokers$V2$Service_instances$Create, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__CreateServiceInstanceResponse>): void;
create(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__CreateServiceInstanceResponse>): void;
/**
* servicebroker.projects.brokers.v2.service_instances.delete
* @desc Deprovisions a service instance. For synchronous/asynchronous request details see CreateServiceInstance method. If service instance does not exist HTTP 410 status will be returned.
* @alias servicebroker.projects.brokers.v2.service_instances.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.acceptsIncomplete See CreateServiceInstanceRequest for details.
* @param {string} params.name Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + `v2/service_instances/[INSTANCE_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`.
* @param {string=} params.planId The plan id of the service instance.
* @param {string=} params.serviceId The service id of the service instance.
* @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$Brokers$V2$Service_instances$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1beta1__DeleteServiceInstanceResponse>;
delete(params: Params$Resource$Projects$Brokers$V2$Service_instances$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__DeleteServiceInstanceResponse>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__DeleteServiceInstanceResponse>): void;
delete(params: Params$Resource$Projects$Brokers$V2$Service_instances$Delete, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__DeleteServiceInstanceResponse>): void;
delete(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__DeleteServiceInstanceResponse>): void;
/**
* servicebroker.projects.brokers.v2.service_instances.get
* @desc Gets the given service instance from the system. The API call accepts both OSB style API and standard google style API resource path. i.e. both `projects/x/brokers/x/instances/x` and `projects/x/brokers/x/v2/service_instances/x` are acceptable paths.
* @alias servicebroker.projects.brokers.v2.service_instances.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The resource name of the instance to return. Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + `v2/service_instances/[INSTANCE_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_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
*/
get(params?: Params$Resource$Projects$Brokers$V2$Service_instances$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance>;
get(params: Params$Resource$Projects$Brokers$V2$Service_instances$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance>): void;
get(params: Params$Resource$Projects$Brokers$V2$Service_instances$Get, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance>): void;
get(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance>): void;
/**
* servicebroker.projects.brokers.v2.service_instances.getLast_operation
* @desc Returns the state of the last operation for the service instance. Only last (or current) operation can be polled.
* @alias servicebroker.projects.brokers.v2.service_instances.getLast_operation
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/`+ `service_instances/[INSTANCE_ID]`.
* @param {string=} params.operation If `operation` was returned during mutation operation, this field must be populated with the provided value.
* @param {string=} params.planId Plan id.
* @param {string=} params.serviceId Service 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
*/
getLast_operation(params?: Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1beta1__Operation>;
getLast_operation(params: Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__Operation>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__Operation>): void;
getLast_operation(params: Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__Operation>): void;
getLast_operation(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__Operation>): void;
/**
* servicebroker.projects.brokers.v2.service_instances.patch
* @desc Updates an existing service instance. See CreateServiceInstance for possible response codes.
* @alias servicebroker.projects.brokers.v2.service_instances.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.acceptsIncomplete See CreateServiceInstanceRequest for details.
* @param {string} params.name Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]`.
* @param {().GoogleCloudServicebrokerV1beta1__ServiceInstance} 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
*/
patch(params?: Params$Resource$Projects$Brokers$V2$Service_instances$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1beta1__UpdateServiceInstanceResponse>;
patch(params: Params$Resource$Projects$Brokers$V2$Service_instances$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__UpdateServiceInstanceResponse>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__UpdateServiceInstanceResponse>): void;
patch(params: Params$Resource$Projects$Brokers$V2$Service_instances$Patch, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__UpdateServiceInstanceResponse>): void;
patch(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__UpdateServiceInstanceResponse>): void;
}
export interface Params$Resource$Projects$Brokers$V2$Service_instances$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Value indicating that API client supports asynchronous operations. If Broker cannot execute the request synchronously HTTP 422 code will be returned to HTTP clients along with FAILED_PRECONDITION error. If true and broker will execute request asynchronously 202 HTTP code will be returned. This broker always requires this to be true as all mutator operations are asynchronous.
*/
acceptsIncomplete?: boolean;
/**
* The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required.
*/
instance_id?: string;
/**
* Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance;
}
export interface Params$Resource$Projects$Brokers$V2$Service_instances$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* See CreateServiceInstanceRequest for details.
*/
acceptsIncomplete?: boolean;
/**
* Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + `v2/service_instances/[INSTANCE_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`.
*/
name?: string;
/**
* The plan id of the service instance.
*/
planId?: string;
/**
* The service id of the service instance.
*/
serviceId?: string;
}
export interface Params$Resource$Projects$Brokers$V2$Service_instances$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource name of the instance to return. Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + `v2/service_instances/[INSTANCE_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`.
*/
name?: string;
}
export interface Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/`+ `service_instances/[INSTANCE_ID]`.
*/
name?: string;
/**
* If `operation` was returned during mutation operation, this field must be populated with the provided value.
*/
operation?: string;
/**
* Plan id.
*/
planId?: string;
/**
* Service id.
*/
serviceId?: string;
}
export interface Params$Resource$Projects$Brokers$V2$Service_instances$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* See CreateServiceInstanceRequest for details.
*/
acceptsIncomplete?: boolean;
/**
* Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]`.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance;
}
export class Resource$Projects$Brokers$V2$Service_instances$Service_bindings {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* servicebroker.projects.brokers.v2.service_instances.service_bindings.create
* @desc CreateBinding generates a service binding to an existing service instance. See ProviServiceInstance for async operation details.
* @alias servicebroker.projects.brokers.v2.service_instances.service_bindings.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.acceptsIncomplete See CreateServiceInstanceRequest for details.
* @param {string} params.binding_id The id of the binding. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required.
* @param {string} params.parent The GCP container. Must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]`.
* @param {().GoogleCloudServicebrokerV1beta1__Binding} 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$Brokers$V2$Service_instances$Service_bindings$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1beta1__CreateBindingResponse>;
create(params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__CreateBindingResponse>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__CreateBindingResponse>): void;
create(params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Create, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__CreateBindingResponse>): void;
create(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__CreateBindingResponse>): void;
/**
* servicebroker.projects.brokers.v2.service_instances.service_bindings.delete
* @desc Unbinds from a service instance. For synchronous/asynchronous request details see CreateServiceInstance method. If binding does not exist HTTP 410 status will be returned.
* @alias servicebroker.projects.brokers.v2.service_instances.service_bindings.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.acceptsIncomplete See CreateServiceInstanceRequest for details.
* @param {string} params.name Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` `v2/service_instances/[INSTANCE_ID]/service_bindings/[BINDING_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` `/instances/[INSTANCE_ID]/bindings/[BINDING_ID]`.
* @param {string=} params.planId The plan id of the service instance.
* @param {string=} params.serviceId Additional query parameter hints. The service id of the service instance.
* @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$Brokers$V2$Service_instances$Service_bindings$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1beta1__DeleteBindingResponse>;
delete(params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__DeleteBindingResponse>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__DeleteBindingResponse>): void;
delete(params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Delete, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__DeleteBindingResponse>): void;
delete(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__DeleteBindingResponse>): void;
/**
* servicebroker.projects.brokers.v2.service_instances.service_bindings.get
* @desc GetBinding returns the binding information.
* @alias servicebroker.projects.brokers.v2.service_instances.service_bindings.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/service_bindings`.
* @param {string=} params.planId Plan id.
* @param {string=} params.serviceId Service 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
*/
get(params?: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1beta1__GetBindingResponse>;
get(params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__GetBindingResponse>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__GetBindingResponse>): void;
get(params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Get, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__GetBindingResponse>): void;
get(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__GetBindingResponse>): void;
/**
* servicebroker.projects.brokers.v2.service_instances.service_bindings.getLast_operation
* @desc Returns the state of the last operation for the binding. Only last (or current) operation can be polled.
* @alias servicebroker.projects.brokers.v2.service_instances.service_bindings.getLast_operation
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/service_binding/[BINDING_ID]`.
* @param {string=} params.operation If `operation` was returned during mutation operation, this field must be populated with the provided value.
* @param {string=} params.planId Plan id.
* @param {string=} params.serviceId Service 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
*/
getLast_operation(params?: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudServicebrokerV1beta1__Operation>;
getLast_operation(params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__Operation>, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__Operation>): void;
getLast_operation(params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation, callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__Operation>): void;
getLast_operation(callback: BodyResponseCallback<Schema$GoogleCloudServicebrokerV1beta1__Operation>): void;
}
export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* See CreateServiceInstanceRequest for details.
*/
acceptsIncomplete?: boolean;
/**
* The id of the binding. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required.
*/
binding_id?: string;
/**
* The GCP container. Must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudServicebrokerV1beta1__Binding;
}
export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* See CreateServiceInstanceRequest for details.
*/
acceptsIncomplete?: boolean;
/**
* Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` `v2/service_instances/[INSTANCE_ID]/service_bindings/[BINDING_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` `/instances/[INSTANCE_ID]/bindings/[BINDING_ID]`.
*/
name?: string;
/**
* The plan id of the service instance.
*/
planId?: string;
/**
* Additional query parameter hints. The service id of the service instance.
*/
serviceId?: string;
}
export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/service_bindings`.
*/
name?: string;
/**
* Plan id.
*/
planId?: string;
/**
* Service id.
*/
serviceId?: string;
}
export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/service_binding/[BINDING_ID]`.
*/
name?: string;
/**
* If `operation` was returned during mutation operation, this field must be populated with the provided value.
*/
operation?: string;
/**
* Plan id.
*/
planId?: string;
/**
* Service id.
*/
serviceId?: string;
}
export class Resource$V1beta1 {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* servicebroker.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 servicebroker.getIamPolicy
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.
* @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$V1beta1$Getiampolicy, options?: MethodOptions): GaxiosPromise<Schema$GoogleIamV1__Policy>;
getIamPolicy(params: Params$Resource$V1beta1$Getiampolicy, options: MethodOptions | BodyResponseCallback<Schema$GoogleIamV1__Policy>, callback: BodyResponseCallback<Schema$GoogleIamV1__Policy>): void;
getIamPolicy(params: Params$Resource$V1beta1$Getiampolicy, callback: BodyResponseCallback<Schema$GoogleIamV1__Policy>): void;
getIamPolicy(callback: BodyResponseCallback<Schema$GoogleIamV1__Policy>): void;
/**
* servicebroker.setIamPolicy
* @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
* @alias servicebroker.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 {().GoogleIamV1__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$V1beta1$Setiampolicy, options?: MethodOptions): GaxiosPromise<Schema$GoogleIamV1__Policy>;
setIamPolicy(params: Params$Resource$V1beta1$Setiampolicy, options: MethodOptions | BodyResponseCallback<Schema$GoogleIamV1__Policy>, callback: BodyResponseCallback<Schema$GoogleIamV1__Policy>): void;
setIamPolicy(params: Params$Resource$V1beta1$Setiampolicy, callback: BodyResponseCallback<Schema$GoogleIamV1__Policy>): void;
setIamPolicy(callback: BodyResponseCallback<Schema$GoogleIamV1__Policy>): void;
/**
* servicebroker.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 servicebroker.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 {().GoogleIamV1__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$V1beta1$Testiampermissions, options?: MethodOptions): GaxiosPromise<Schema$GoogleIamV1__TestIamPermissionsResponse>;
testIamPermissions(params: Params$Resource$V1beta1$Testiampermissions, options: MethodOptions | BodyResponseCallback<Schema$GoogleIamV1__TestIamPermissionsResponse>, callback: BodyResponseCallback<Schema$GoogleIamV1__TestIamPermissionsResponse>): void;
testIamPermissions(params: Params$Resource$V1beta1$Testiampermissions, callback: BodyResponseCallback<Schema$GoogleIamV1__TestIamPermissionsResponse>): void;
testIamPermissions(callback: BodyResponseCallback<Schema$GoogleIamV1__TestIamPermissionsResponse>): void;
}
export interface Params$Resource$V1beta1$Getiampolicy extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.
*/
'options.requestedPolicyVersion'?: number;
/**
* REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
*/
resource?: string;
}
export interface Params$Resource$V1beta1$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$GoogleIamV1__SetIamPolicyRequest;
}
export interface Params$Resource$V1beta1$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$GoogleIamV1__TestIamPermissionsRequest;
}
export {};
}