v1beta2.d.ts
61.5 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
/**
* 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 pubsub_v1beta2 {
interface Options extends GlobalOptions {
version: 'v1beta2';
}
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 Pub/Sub API
*
* Provides reliable, many-to-many, asynchronous messaging between
* applications.
*
* @example
* const {google} = require('googleapis');
* const pubsub = google.pubsub('v1beta2');
*
* @namespace pubsub
* @type {Function}
* @version v1beta2
* @variation v1beta2
* @param {object=} options Options for Pubsub
*/
class Pubsub {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Request for the Acknowledge method.
*/
interface Schema$AcknowledgeRequest {
/**
* The acknowledgment ID for the messages being acknowledged that was
* returned by the Pub/Sub system in the `Pull` response. Must not be empty.
*/
ackIds?: string[];
}
/**
* Associates `members` with a `role`.
*/
interface Schema$Binding {
/**
* Unimplemented. 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 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 {
}
/**
* 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;
}
/**
* Response for the `ListSubscriptions` method.
*/
interface Schema$ListSubscriptionsResponse {
/**
* If not empty, indicates that there may be more subscriptions that match
* the request; this value should be passed in a new
* `ListSubscriptionsRequest` to get more subscriptions.
*/
nextPageToken?: string;
/**
* The subscriptions that match the request.
*/
subscriptions?: Schema$Subscription[];
}
/**
* Response for the `ListTopics` method.
*/
interface Schema$ListTopicsResponse {
/**
* If not empty, indicates that there may be more topics that match the
* request; this value should be passed in a new `ListTopicsRequest`.
*/
nextPageToken?: string;
/**
* The resulting topics.
*/
topics?: Schema$Topic[];
}
/**
* Response for the `ListTopicSubscriptions` method.
*/
interface Schema$ListTopicSubscriptionsResponse {
/**
* If not empty, indicates that there may be more subscriptions that match
* the request; this value should be passed in a new
* `ListTopicSubscriptionsRequest` to get more subscriptions.
*/
nextPageToken?: string;
/**
* The names of the subscriptions that match the request.
*/
subscriptions?: string[];
}
/**
* Request for the ModifyAckDeadline method.
*/
interface Schema$ModifyAckDeadlineRequest {
/**
* The new ack deadline with respect to the time this request was sent to
* the Pub/Sub system. Must be >= 0. For example, if the value is 10, the
* new ack deadline will expire 10 seconds after the `ModifyAckDeadline`
* call was made. Specifying zero may immediately make the message available
* for another pull request.
*/
ackDeadlineSeconds?: number;
/**
* The acknowledgment ID. Either this or ack_ids must be populated, but not
* both.
*/
ackId?: string;
/**
* List of acknowledgment IDs.
*/
ackIds?: string[];
}
/**
* Request for the ModifyPushConfig method.
*/
interface Schema$ModifyPushConfigRequest {
/**
* The push configuration for future deliveries. An empty `pushConfig`
* indicates that the Pub/Sub system should stop pushing messages from the
* given subscription and allow messages to be pulled and acknowledged -
* effectively pausing the subscription if `Pull` is not called.
*/
pushConfig?: Schema$PushConfig;
}
/**
* Contains information needed for generating an [OpenID Connect
* token](https://developers.google.com/identity/protocols/OpenIDConnect).
*/
interface Schema$OidcToken {
/**
* Audience to be used when generating OIDC token. The audience claim
* identifies the recipients that the JWT is intended for. The audience
* value is a single case-sensitive string. Having multiple values (array)
* for the audience field is not supported. More info about the OIDC JWT
* token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
* Note: if not specified, the Push endpoint URL will be used.
*/
audience?: string;
/**
* [Service account
* email](https://cloud.google.com/iam/docs/service-accounts) to be used for
* generating the OIDC token. The caller (for CreateSubscription,
* UpdateSubscription, and ModifyPushConfig RPCs) must have the
* iam.serviceAccounts.actAs permission for the service account.
*/
serviceAccountEmail?: string;
}
/**
* 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;
}
/**
* Request for the Publish method.
*/
interface Schema$PublishRequest {
/**
* The messages to publish.
*/
messages?: Schema$PubsubMessage[];
}
/**
* Response for the `Publish` method.
*/
interface Schema$PublishResponse {
/**
* The server-assigned ID of each published message, in the same order as
* the messages in the request. IDs are guaranteed to be unique within the
* topic.
*/
messageIds?: string[];
}
/**
* A message data and its attributes. The message payload must not be empty;
* it must contain either a non-empty data field, or at least one attribute.
*/
interface Schema$PubsubMessage {
/**
* Optional attributes for this message.
*/
attributes?: {
[key: string]: string;
};
/**
* The message payload. For JSON requests, the value of this field must be
* [base64-encoded](https://tools.ietf.org/html/rfc4648).
*/
data?: string;
/**
* ID of this message, assigned by the server when the message is published.
* Guaranteed to be unique within the topic. This value may be read by a
* subscriber that receives a `PubsubMessage` via a `Pull` call or a push
* delivery. It must not be populated by the publisher in a `Publish` call.
*/
messageId?: string;
/**
* The time at which the message was published, populated by the server when
* it receives the `Publish` call. It must not be populated by the publisher
* in a `Publish` call.
*/
publishTime?: string;
}
/**
* Request for the `Pull` method.
*/
interface Schema$PullRequest {
/**
* The maximum number of messages returned for this request. The Pub/Sub
* system may return fewer than the number specified.
*/
maxMessages?: number;
/**
* If this is specified as true the system will respond immediately even if
* it is not able to return a message in the `Pull` response. Otherwise the
* system is allowed to wait until at least one message is available rather
* than returning no messages. The client may cancel the request if it does
* not wish to wait any longer for the response.
*/
returnImmediately?: boolean;
}
/**
* Response for the `Pull` method.
*/
interface Schema$PullResponse {
/**
* Received Pub/Sub messages. The Pub/Sub system will return zero messages
* if there are no more available in the backlog. The Pub/Sub system may
* return fewer than the `maxMessages` requested even if there are more
* messages available in the backlog.
*/
receivedMessages?: Schema$ReceivedMessage[];
}
/**
* Configuration for a push delivery endpoint.
*/
interface Schema$PushConfig {
/**
* Endpoint configuration attributes. Every endpoint has a set of API
* supported attributes that can be used to control different aspects of the
* message delivery. The currently supported attribute is `x-goog-version`,
* which you can use to change the format of the push message. This
* attribute indicates the version of the data expected by the endpoint.
* This controls the shape of the envelope (i.e. its fields and metadata).
* The endpoint version is based on the version of the Pub/Sub API. If not
* present during the `CreateSubscription` call, it will default to the
* version of the API used to make such call. If not present during a
* `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
* calls will always return a valid version, even if the subscription was
* created without this attribute. The possible values for this attribute
* are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub
* API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub
* API.
*/
attributes?: {
[key: string]: string;
};
/**
* If specified, Pub/Sub will generate and attach an OIDC JWT token as an
* `Authorization` header in the HTTP request for every pushed message.
*/
oidcToken?: Schema$OidcToken;
/**
* A URL locating the endpoint to which messages should be pushed. For
* example, a Webhook endpoint might use
* "https://example.com/push".
*/
pushEndpoint?: string;
}
/**
* A message and its corresponding acknowledgment ID.
*/
interface Schema$ReceivedMessage {
/**
* This ID can be used to acknowledge the received message.
*/
ackId?: string;
/**
* The message.
*/
message?: Schema$PubsubMessage;
}
/**
* 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;
}
/**
* A subscription resource.
*/
interface Schema$Subscription {
/**
* This value is the maximum time after a subscriber receives a message
* before the subscriber should acknowledge the message. After message
* delivery but before the ack deadline expires and before the message is
* acknowledged, it is an outstanding message and will not be delivered
* again during that time (on a best-effort basis). For pull subscriptions,
* this value is used as the initial value for the ack deadline. To override
* this value for a given message, call `ModifyAckDeadline` with the
* corresponding `ack_id` if using pull. The maximum custom deadline you can
* specify is 600 seconds (10 minutes). For push delivery, this value is
* also used to set the request timeout for the call to the push endpoint.
* If the subscriber never acknowledges the message, the Pub/Sub system will
* eventually redeliver the message. If this parameter is 0, a default
* value of 10 seconds is used.
*/
ackDeadlineSeconds?: number;
/**
* The name of the subscription. It must have the format
* `"projects/{project}/subscriptions/{subscription}"`.
* `{subscription}` must start with a letter, and contain only letters
* (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods
* (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be
* between 3 and 255 characters in length, and it must not start with
* `"goog"`.
*/
name?: string;
/**
* If push delivery is used with this subscription, this field is used to
* configure it. An empty `pushConfig` signifies that the subscriber will
* pull and ack messages using API methods.
*/
pushConfig?: Schema$PushConfig;
/**
* The name of the topic from which this subscription is receiving messages.
* The value of this field will be `_deleted-topic_` if the topic has been
* deleted.
*/
topic?: 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[];
}
/**
* A topic resource.
*/
interface Schema$Topic {
/**
* The name of the topic. It must have the format
* `"projects/{project}/topics/{topic}"`. `{topic}` must start
* with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`),
* dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`)
* or percent signs (`%`). It must be between 3 and 255 characters in
* length, and it must not start with `"goog"`.
*/
name?: string;
}
class Resource$Projects {
context: APIRequestContext;
subscriptions: Resource$Projects$Subscriptions;
topics: Resource$Projects$Topics;
constructor(context: APIRequestContext);
}
class Resource$Projects$Subscriptions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* pubsub.projects.subscriptions.acknowledge
* @desc Acknowledges the messages associated with the `ack_ids` in the
* `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages
* from the subscription. Acknowledging a message whose ack deadline has
* expired may succeed, but such a message may be redelivered later.
* Acknowledging a message more than once will not result in an error.
* @alias pubsub.projects.subscriptions.acknowledge
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.subscription The subscription whose message is being acknowledged.
* @param {().AcknowledgeRequest} 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
*/
acknowledge(params?: Params$Resource$Projects$Subscriptions$Acknowledge, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
acknowledge(params: Params$Resource$Projects$Subscriptions$Acknowledge, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
acknowledge(params: Params$Resource$Projects$Subscriptions$Acknowledge, callback: BodyResponseCallback<Schema$Empty>): void;
acknowledge(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* pubsub.projects.subscriptions.create
* @desc Creates a subscription to a given topic. If the subscription
* already exists, returns `ALREADY_EXISTS`. If the corresponding topic
* doesn't exist, returns `NOT_FOUND`. If the name is not provided in the
* request, the server will assign a random name for this subscription on
* the same project as the topic. Note that for REST API requests, you must
* specify a name.
* @alias pubsub.projects.subscriptions.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
* @param {().Subscription} 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$Subscriptions$Create, options?: MethodOptions): GaxiosPromise<Schema$Subscription>;
create(params: Params$Resource$Projects$Subscriptions$Create, options: MethodOptions | BodyResponseCallback<Schema$Subscription>, callback: BodyResponseCallback<Schema$Subscription>): void;
create(params: Params$Resource$Projects$Subscriptions$Create, callback: BodyResponseCallback<Schema$Subscription>): void;
create(callback: BodyResponseCallback<Schema$Subscription>): void;
/**
* pubsub.projects.subscriptions.delete
* @desc Deletes an existing subscription. All pending messages in the
* subscription are immediately dropped. Calls to `Pull` after deletion will
* return `NOT_FOUND`. After a subscription is deleted, a new one may be
* created with the same name, but the new one has no association with the
* old subscription, or its topic unless the same topic is specified.
* @alias pubsub.projects.subscriptions.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.subscription The subscription 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$Subscriptions$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Subscriptions$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Subscriptions$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* pubsub.projects.subscriptions.get
* @desc Gets the configuration details of a subscription.
* @alias pubsub.projects.subscriptions.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.subscription The name of the subscription to get.
* @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$Subscriptions$Get, options?: MethodOptions): GaxiosPromise<Schema$Subscription>;
get(params: Params$Resource$Projects$Subscriptions$Get, options: MethodOptions | BodyResponseCallback<Schema$Subscription>, callback: BodyResponseCallback<Schema$Subscription>): void;
get(params: Params$Resource$Projects$Subscriptions$Get, callback: BodyResponseCallback<Schema$Subscription>): void;
get(callback: BodyResponseCallback<Schema$Subscription>): void;
/**
* pubsub.projects.subscriptions.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 pubsub.projects.subscriptions.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$Subscriptions$Getiampolicy, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
getIamPolicy(params: Params$Resource$Projects$Subscriptions$Getiampolicy, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
getIamPolicy(params: Params$Resource$Projects$Subscriptions$Getiampolicy, callback: BodyResponseCallback<Schema$Policy>): void;
getIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* pubsub.projects.subscriptions.list
* @desc Lists matching subscriptions.
* @alias pubsub.projects.subscriptions.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Maximum number of subscriptions to return.
* @param {string=} params.pageToken The value returned by the last `ListSubscriptionsResponse`; indicates that this is a continuation of a prior `ListSubscriptions` call, and that the system should return the next page of data.
* @param {string} params.project The name of the cloud project that subscriptions belong to.
* @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$Subscriptions$List, options?: MethodOptions): GaxiosPromise<Schema$ListSubscriptionsResponse>;
list(params: Params$Resource$Projects$Subscriptions$List, options: MethodOptions | BodyResponseCallback<Schema$ListSubscriptionsResponse>, callback: BodyResponseCallback<Schema$ListSubscriptionsResponse>): void;
list(params: Params$Resource$Projects$Subscriptions$List, callback: BodyResponseCallback<Schema$ListSubscriptionsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListSubscriptionsResponse>): void;
/**
* pubsub.projects.subscriptions.modifyAckDeadline
* @desc Modifies the ack deadline for a specific message. This method is
* useful to indicate that more time is needed to process a message by the
* subscriber, or to make the message available for redelivery if the
* processing was interrupted. Note that this does not modify the
* subscription-level `ackDeadlineSeconds` used for subsequent messages.
* @alias pubsub.projects.subscriptions.modifyAckDeadline
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.subscription The name of the subscription.
* @param {().ModifyAckDeadlineRequest} 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
*/
modifyAckDeadline(params?: Params$Resource$Projects$Subscriptions$Modifyackdeadline, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
modifyAckDeadline(params: Params$Resource$Projects$Subscriptions$Modifyackdeadline, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
modifyAckDeadline(params: Params$Resource$Projects$Subscriptions$Modifyackdeadline, callback: BodyResponseCallback<Schema$Empty>): void;
modifyAckDeadline(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* pubsub.projects.subscriptions.modifyPushConfig
* @desc Modifies the `PushConfig` for a specified subscription. This may
* be used to change a push subscription to a pull one (signified by an
* empty `PushConfig`) or vice versa, or change the endpoint URL and other
* attributes of a push subscription. Messages will accumulate for delivery
* continuously through the call regardless of changes to the `PushConfig`.
* @alias pubsub.projects.subscriptions.modifyPushConfig
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.subscription The name of the subscription.
* @param {().ModifyPushConfigRequest} 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
*/
modifyPushConfig(params?: Params$Resource$Projects$Subscriptions$Modifypushconfig, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
modifyPushConfig(params: Params$Resource$Projects$Subscriptions$Modifypushconfig, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
modifyPushConfig(params: Params$Resource$Projects$Subscriptions$Modifypushconfig, callback: BodyResponseCallback<Schema$Empty>): void;
modifyPushConfig(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* pubsub.projects.subscriptions.pull
* @desc Pulls messages from the server. Returns an empty list if there are
* no messages available in the backlog. The server may return `UNAVAILABLE`
* if there are too many concurrent pull requests pending for the given
* subscription.
* @alias pubsub.projects.subscriptions.pull
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.subscription The subscription from which messages should be pulled.
* @param {().PullRequest} 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
*/
pull(params?: Params$Resource$Projects$Subscriptions$Pull, options?: MethodOptions): GaxiosPromise<Schema$PullResponse>;
pull(params: Params$Resource$Projects$Subscriptions$Pull, options: MethodOptions | BodyResponseCallback<Schema$PullResponse>, callback: BodyResponseCallback<Schema$PullResponse>): void;
pull(params: Params$Resource$Projects$Subscriptions$Pull, callback: BodyResponseCallback<Schema$PullResponse>): void;
pull(callback: BodyResponseCallback<Schema$PullResponse>): void;
/**
* pubsub.projects.subscriptions.setIamPolicy
* @desc Sets the access control policy on the specified resource. Replaces
* any existing policy.
* @alias pubsub.projects.subscriptions.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$Subscriptions$Setiampolicy, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
setIamPolicy(params: Params$Resource$Projects$Subscriptions$Setiampolicy, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
setIamPolicy(params: Params$Resource$Projects$Subscriptions$Setiampolicy, callback: BodyResponseCallback<Schema$Policy>): void;
setIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* pubsub.projects.subscriptions.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 pubsub.projects.subscriptions.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$Subscriptions$Testiampermissions, options?: MethodOptions): GaxiosPromise<Schema$TestIamPermissionsResponse>;
testIamPermissions(params: Params$Resource$Projects$Subscriptions$Testiampermissions, options: MethodOptions | BodyResponseCallback<Schema$TestIamPermissionsResponse>, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(params: Params$Resource$Projects$Subscriptions$Testiampermissions, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
}
interface Params$Resource$Projects$Subscriptions$Acknowledge extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The subscription whose message is being acknowledged.
*/
subscription?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AcknowledgeRequest;
}
interface Params$Resource$Projects$Subscriptions$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the subscription. It must have the format
* `"projects/{project}/subscriptions/{subscription}"`. `{subscription}`
* must start with a letter, and contain only letters (`[A-Za-z]`), numbers
* (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
* plus (`+`) or percent signs (`%`). It must be between 3 and 255
* characters in length, and it must not start with `"goog"`.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Subscription;
}
interface Params$Resource$Projects$Subscriptions$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The subscription to delete.
*/
subscription?: string;
}
interface Params$Resource$Projects$Subscriptions$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the subscription to get.
*/
subscription?: string;
}
interface Params$Resource$Projects$Subscriptions$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$Subscriptions$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Maximum number of subscriptions to return.
*/
pageSize?: number;
/**
* The value returned by the last `ListSubscriptionsResponse`; indicates
* that this is a continuation of a prior `ListSubscriptions` call, and that
* the system should return the next page of data.
*/
pageToken?: string;
/**
* The name of the cloud project that subscriptions belong to.
*/
project?: string;
}
interface Params$Resource$Projects$Subscriptions$Modifyackdeadline extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the subscription.
*/
subscription?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ModifyAckDeadlineRequest;
}
interface Params$Resource$Projects$Subscriptions$Modifypushconfig extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the subscription.
*/
subscription?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ModifyPushConfigRequest;
}
interface Params$Resource$Projects$Subscriptions$Pull extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The subscription from which messages should be pulled.
*/
subscription?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PullRequest;
}
interface Params$Resource$Projects$Subscriptions$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$Subscriptions$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$Topics {
context: APIRequestContext;
subscriptions: Resource$Projects$Topics$Subscriptions;
constructor(context: APIRequestContext);
/**
* pubsub.projects.topics.create
* @desc Creates the given topic with the given name.
* @alias pubsub.projects.topics.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
* @param {().Topic} 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$Topics$Create, options?: MethodOptions): GaxiosPromise<Schema$Topic>;
create(params: Params$Resource$Projects$Topics$Create, options: MethodOptions | BodyResponseCallback<Schema$Topic>, callback: BodyResponseCallback<Schema$Topic>): void;
create(params: Params$Resource$Projects$Topics$Create, callback: BodyResponseCallback<Schema$Topic>): void;
create(callback: BodyResponseCallback<Schema$Topic>): void;
/**
* pubsub.projects.topics.delete
* @desc Deletes the topic with the given name. Returns `NOT_FOUND` if the
* topic does not exist. After a topic is deleted, a new topic may be
* created with the same name; this is an entirely new topic with none of
* the old configuration or subscriptions. Existing subscriptions to this
* topic are not deleted, but their `topic` field is set to
* `_deleted-topic_`.
* @alias pubsub.projects.topics.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.topic Name of the topic 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$Topics$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Topics$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Topics$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* pubsub.projects.topics.get
* @desc Gets the configuration of a topic.
* @alias pubsub.projects.topics.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.topic The name of the topic to get.
* @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$Topics$Get, options?: MethodOptions): GaxiosPromise<Schema$Topic>;
get(params: Params$Resource$Projects$Topics$Get, options: MethodOptions | BodyResponseCallback<Schema$Topic>, callback: BodyResponseCallback<Schema$Topic>): void;
get(params: Params$Resource$Projects$Topics$Get, callback: BodyResponseCallback<Schema$Topic>): void;
get(callback: BodyResponseCallback<Schema$Topic>): void;
/**
* pubsub.projects.topics.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 pubsub.projects.topics.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$Topics$Getiampolicy, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
getIamPolicy(params: Params$Resource$Projects$Topics$Getiampolicy, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
getIamPolicy(params: Params$Resource$Projects$Topics$Getiampolicy, callback: BodyResponseCallback<Schema$Policy>): void;
getIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* pubsub.projects.topics.list
* @desc Lists matching topics.
* @alias pubsub.projects.topics.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Maximum number of topics to return.
* @param {string=} params.pageToken The value returned by the last `ListTopicsResponse`; indicates that this is a continuation of a prior `ListTopics` call, and that the system should return the next page of data.
* @param {string} params.project The name of the cloud project that topics belong to.
* @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$Topics$List, options?: MethodOptions): GaxiosPromise<Schema$ListTopicsResponse>;
list(params: Params$Resource$Projects$Topics$List, options: MethodOptions | BodyResponseCallback<Schema$ListTopicsResponse>, callback: BodyResponseCallback<Schema$ListTopicsResponse>): void;
list(params: Params$Resource$Projects$Topics$List, callback: BodyResponseCallback<Schema$ListTopicsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListTopicsResponse>): void;
/**
* pubsub.projects.topics.publish
* @desc Adds one or more messages to the topic. Returns `NOT_FOUND` if the
* topic does not exist. The message payload must not be empty; it must
* contain either a non-empty data field, or at least one attribute.
* @alias pubsub.projects.topics.publish
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.topic The messages in the request will be published on this topic.
* @param {().PublishRequest} 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
*/
publish(params?: Params$Resource$Projects$Topics$Publish, options?: MethodOptions): GaxiosPromise<Schema$PublishResponse>;
publish(params: Params$Resource$Projects$Topics$Publish, options: MethodOptions | BodyResponseCallback<Schema$PublishResponse>, callback: BodyResponseCallback<Schema$PublishResponse>): void;
publish(params: Params$Resource$Projects$Topics$Publish, callback: BodyResponseCallback<Schema$PublishResponse>): void;
publish(callback: BodyResponseCallback<Schema$PublishResponse>): void;
/**
* pubsub.projects.topics.setIamPolicy
* @desc Sets the access control policy on the specified resource. Replaces
* any existing policy.
* @alias pubsub.projects.topics.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$Topics$Setiampolicy, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
setIamPolicy(params: Params$Resource$Projects$Topics$Setiampolicy, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
setIamPolicy(params: Params$Resource$Projects$Topics$Setiampolicy, callback: BodyResponseCallback<Schema$Policy>): void;
setIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* pubsub.projects.topics.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 pubsub.projects.topics.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$Topics$Testiampermissions, options?: MethodOptions): GaxiosPromise<Schema$TestIamPermissionsResponse>;
testIamPermissions(params: Params$Resource$Projects$Topics$Testiampermissions, options: MethodOptions | BodyResponseCallback<Schema$TestIamPermissionsResponse>, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(params: Params$Resource$Projects$Topics$Testiampermissions, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
}
interface Params$Resource$Projects$Topics$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the topic. It must have the format
* `"projects/{project}/topics/{topic}"`. `{topic}` must start with a
* letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes
* (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or
* percent signs (`%`). It must be between 3 and 255 characters in length,
* and it must not start with `"goog"`.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Topic;
}
interface Params$Resource$Projects$Topics$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the topic to delete.
*/
topic?: string;
}
interface Params$Resource$Projects$Topics$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the topic to get.
*/
topic?: string;
}
interface Params$Resource$Projects$Topics$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$Topics$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Maximum number of topics to return.
*/
pageSize?: number;
/**
* The value returned by the last `ListTopicsResponse`; indicates that this
* is a continuation of a prior `ListTopics` call, and that the system
* should return the next page of data.
*/
pageToken?: string;
/**
* The name of the cloud project that topics belong to.
*/
project?: string;
}
interface Params$Resource$Projects$Topics$Publish extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The messages in the request will be published on this topic.
*/
topic?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PublishRequest;
}
interface Params$Resource$Projects$Topics$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$Topics$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$Topics$Subscriptions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* pubsub.projects.topics.subscriptions.list
* @desc Lists the name of the subscriptions for this topic.
* @alias pubsub.projects.topics.subscriptions.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Maximum number of subscription names to return.
* @param {string=} params.pageToken The value returned by the last `ListTopicSubscriptionsResponse`; indicates that this is a continuation of a prior `ListTopicSubscriptions` call, and that the system should return the next page of data.
* @param {string} params.topic The name of the topic that subscriptions are attached to.
* @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$Topics$Subscriptions$List, options?: MethodOptions): GaxiosPromise<Schema$ListTopicSubscriptionsResponse>;
list(params: Params$Resource$Projects$Topics$Subscriptions$List, options: MethodOptions | BodyResponseCallback<Schema$ListTopicSubscriptionsResponse>, callback: BodyResponseCallback<Schema$ListTopicSubscriptionsResponse>): void;
list(params: Params$Resource$Projects$Topics$Subscriptions$List, callback: BodyResponseCallback<Schema$ListTopicSubscriptionsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListTopicSubscriptionsResponse>): void;
}
interface Params$Resource$Projects$Topics$Subscriptions$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Maximum number of subscription names to return.
*/
pageSize?: number;
/**
* The value returned by the last `ListTopicSubscriptionsResponse`;
* indicates that this is a continuation of a prior `ListTopicSubscriptions`
* call, and that the system should return the next page of data.
*/
pageToken?: string;
/**
* The name of the topic that subscriptions are attached to.
*/
topic?: string;
}
}