/
pubsub-gen.go
10015 lines (9217 loc) · 381 KB
/
pubsub-gen.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2024 Google LLC.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Code generated file. DO NOT EDIT.
// Package pubsub provides access to the Cloud Pub/Sub API.
//
// This package is DEPRECATED. Use package cloud.google.com/go/pubsub instead.
//
// For product documentation, see: https://cloud.google.com/pubsub/docs
//
// # Library status
//
// These client libraries are officially supported by Google. However, this
// library is considered complete and is in maintenance mode. This means
// that we will address critical bugs and security issues but will not add
// any new features.
//
// When possible, we recommend using our newer
// [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)
// that are still actively being worked and iterated on.
//
// # Creating a client
//
// Usage example:
//
// import "google.golang.org/api/pubsub/v1"
// ...
// ctx := context.Background()
// pubsubService, err := pubsub.NewService(ctx)
//
// In this example, Google Application Default Credentials are used for
// authentication. For information on how to create and obtain Application
// Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
//
// # Other authentication options
//
// By default, all available scopes (see "Constants") are used to authenticate.
// To restrict scopes, use [google.golang.org/api/option.WithScopes]:
//
// pubsubService, err := pubsub.NewService(ctx, option.WithScopes(pubsub.PubsubScope))
//
// To use an API key for authentication (note: some APIs do not support API
// keys), use [google.golang.org/api/option.WithAPIKey]:
//
// pubsubService, err := pubsub.NewService(ctx, option.WithAPIKey("AIza..."))
//
// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth
// flow, use [google.golang.org/api/option.WithTokenSource]:
//
// config := &oauth2.Config{...}
// // ...
// token, err := config.Exchange(ctx, ...)
// pubsubService, err := pubsub.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See [google.golang.org/api/option.ClientOption] for details on options.
package pubsub // import "google.golang.org/api/pubsub/v1"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
googleapi "google.golang.org/api/googleapi"
internal "google.golang.org/api/internal"
gensupport "google.golang.org/api/internal/gensupport"
option "google.golang.org/api/option"
internaloption "google.golang.org/api/option/internaloption"
htransport "google.golang.org/api/transport/http"
)
// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes.NewBuffer
var _ = strconv.Itoa
var _ = fmt.Sprintf
var _ = json.NewDecoder
var _ = io.Copy
var _ = url.Parse
var _ = gensupport.MarshalJSON
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Canceled
var _ = internaloption.WithDefaultEndpoint
var _ = internal.Version
const apiId = "pubsub:v1"
const apiName = "pubsub"
const apiVersion = "v1"
const basePath = "https://pubsub.googleapis.com/"
const basePathTemplate = "https://pubsub.UNIVERSE_DOMAIN/"
const mtlsBasePath = "https://pubsub.mtls.googleapis.com/"
const defaultUniverseDomain = "googleapis.com"
// OAuth2 scopes used by this API.
const (
// See, edit, configure, and delete your Google Cloud data and see the
// email address for your Google Account.
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
// View and manage Pub/Sub topics and subscriptions
PubsubScope = "https://www.googleapis.com/auth/pubsub"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := internaloption.WithDefaultScopes(
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub",
)
// NOTE: prepend, so we don't override user-specified scopes.
opts = append([]option.ClientOption{scopesOption}, opts...)
opts = append(opts, internaloption.WithDefaultEndpoint(basePath))
opts = append(opts, internaloption.WithDefaultEndpointTemplate(basePathTemplate))
opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath))
opts = append(opts, internaloption.WithDefaultUniverseDomain(defaultUniverseDomain))
client, endpoint, err := htransport.NewClient(ctx, opts...)
if err != nil {
return nil, err
}
s, err := New(client)
if err != nil {
return nil, err
}
if endpoint != "" {
s.BasePath = endpoint
}
return s, nil
}
// New creates a new Service. It uses the provided http.Client for requests.
//
// Deprecated: please use NewService instead.
// To provide a custom HTTP client, use option.WithHTTPClient.
// If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
s.Projects = NewProjectsService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Projects *ProjectsService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewProjectsService(s *Service) *ProjectsService {
rs := &ProjectsService{s: s}
rs.Schemas = NewProjectsSchemasService(s)
rs.Snapshots = NewProjectsSnapshotsService(s)
rs.Subscriptions = NewProjectsSubscriptionsService(s)
rs.Topics = NewProjectsTopicsService(s)
return rs
}
type ProjectsService struct {
s *Service
Schemas *ProjectsSchemasService
Snapshots *ProjectsSnapshotsService
Subscriptions *ProjectsSubscriptionsService
Topics *ProjectsTopicsService
}
func NewProjectsSchemasService(s *Service) *ProjectsSchemasService {
rs := &ProjectsSchemasService{s: s}
return rs
}
type ProjectsSchemasService struct {
s *Service
}
func NewProjectsSnapshotsService(s *Service) *ProjectsSnapshotsService {
rs := &ProjectsSnapshotsService{s: s}
return rs
}
type ProjectsSnapshotsService struct {
s *Service
}
func NewProjectsSubscriptionsService(s *Service) *ProjectsSubscriptionsService {
rs := &ProjectsSubscriptionsService{s: s}
return rs
}
type ProjectsSubscriptionsService struct {
s *Service
}
func NewProjectsTopicsService(s *Service) *ProjectsTopicsService {
rs := &ProjectsTopicsService{s: s}
rs.Snapshots = NewProjectsTopicsSnapshotsService(s)
rs.Subscriptions = NewProjectsTopicsSubscriptionsService(s)
return rs
}
type ProjectsTopicsService struct {
s *Service
Snapshots *ProjectsTopicsSnapshotsService
Subscriptions *ProjectsTopicsSubscriptionsService
}
func NewProjectsTopicsSnapshotsService(s *Service) *ProjectsTopicsSnapshotsService {
rs := &ProjectsTopicsSnapshotsService{s: s}
return rs
}
type ProjectsTopicsSnapshotsService struct {
s *Service
}
func NewProjectsTopicsSubscriptionsService(s *Service) *ProjectsTopicsSubscriptionsService {
rs := &ProjectsTopicsSubscriptionsService{s: s}
return rs
}
type ProjectsTopicsSubscriptionsService struct {
s *Service
}
// AcknowledgeRequest: Request for the Acknowledge method.
type AcknowledgeRequest struct {
// AckIds: Required. 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 `json:"ackIds,omitempty"`
// ForceSendFields is a list of field names (e.g. "AckIds") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AckIds") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *AcknowledgeRequest) MarshalJSON() ([]byte, error) {
type NoMethod AcknowledgeRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AvroConfig: Configuration for writing message data in Avro format.
// Message payloads and metadata will be written to files as an Avro
// binary.
type AvroConfig struct {
// WriteMetadata: Optional. When true, write the subscription name,
// message_id, publish_time, attributes, and ordering_key as additional
// fields in the output. The subscription name, message_id, and
// publish_time fields are put in their own fields while all other
// message properties other than data (for example, an ordering_key, if
// present) are added as entries in the attributes map.
WriteMetadata bool `json:"writeMetadata,omitempty"`
// ForceSendFields is a list of field names (e.g. "WriteMetadata") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "WriteMetadata") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *AvroConfig) MarshalJSON() ([]byte, error) {
type NoMethod AvroConfig
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AwsKinesis: Ingestion settings for Amazon Kinesis Data Streams.
type AwsKinesis struct {
// AwsRoleArn: Required. AWS role ARN to be used for Federated Identity
// authentication with Kinesis. Check the Pub/Sub docs for how to set up
// this role and the required permissions that need to be attached to
// it.
AwsRoleArn string `json:"awsRoleArn,omitempty"`
// ConsumerArn: Required. The Kinesis consumer ARN to used for ingestion
// in Enhanced Fan-Out mode. The consumer must be already created and
// ready to be used.
ConsumerArn string `json:"consumerArn,omitempty"`
// GcpServiceAccount: Required. The GCP service account to be used for
// Federated Identity authentication with Kinesis (via a
// `AssumeRoleWithWebIdentity` call for the provided role). The
// `aws_role_arn` must be set up with `accounts.google.com:sub` equals
// to this service account number.
GcpServiceAccount string `json:"gcpServiceAccount,omitempty"`
// State: Output only. An output-only field that indicates the state of
// the Kinesis ingestion source.
//
// Possible values:
// "STATE_UNSPECIFIED" - Default value. This value is unused.
// "ACTIVE" - Ingestion is active.
// "KINESIS_PERMISSION_DENIED" - Permission denied encountered while
// consuming data from Kinesis. This can happen if: - The provided
// `aws_role_arn` does not exist or does not have the appropriate
// permissions attached. - The provided `aws_role_arn` is not set up
// properly for Identity Federation using `gcp_service_account`. - The
// Pub/Sub SA is not granted the `iam.serviceAccounts.getOpenIdToken`
// permission on `gcp_service_account`.
// "PUBLISH_PERMISSION_DENIED" - Permission denied encountered while
// publishing to the topic. This can happen if the Pub/Sub SA has not
// been granted the [appropriate publish
// permissions](https://cloud.google.com/pubsub/docs/access-control#pubsu
// b.publisher)
// "STREAM_NOT_FOUND" - The Kinesis stream does not exist.
// "CONSUMER_NOT_FOUND" - The Kinesis consumer does not exist.
State string `json:"state,omitempty"`
// StreamArn: Required. The Kinesis stream ARN to ingest data from.
StreamArn string `json:"streamArn,omitempty"`
// ForceSendFields is a list of field names (e.g. "AwsRoleArn") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AwsRoleArn") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *AwsKinesis) MarshalJSON() ([]byte, error) {
type NoMethod AwsKinesis
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BigQueryConfig: Configuration for a BigQuery subscription.
type BigQueryConfig struct {
// DropUnknownFields: Optional. When true and use_topic_schema is true,
// any fields that are a part of the topic schema that are not part of
// the BigQuery table schema are dropped when writing to BigQuery.
// Otherwise, the schemas must be kept in sync and any messages with
// extra fields are not written and remain in the subscription's
// backlog.
DropUnknownFields bool `json:"dropUnknownFields,omitempty"`
// ServiceAccountEmail: Optional. The service account to use to write to
// BigQuery. The subscription creator or updater that specifies this
// field must have `iam.serviceAccounts.actAs` permission on the service
// account. If not specified, the Pub/Sub service agent
// (https://cloud.google.com/iam/docs/service-agents),
// service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is
// used.
ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"`
// State: Output only. An output-only field that indicates whether or
// not the subscription can receive messages.
//
// Possible values:
// "STATE_UNSPECIFIED" - Default value. This value is unused.
// "ACTIVE" - The subscription can actively send messages to BigQuery
// "PERMISSION_DENIED" - Cannot write to the BigQuery table because of
// permission denied errors. This can happen if - Pub/Sub SA has not
// been granted the [appropriate BigQuery IAM
// permissions](https://cloud.google.com/pubsub/docs/create-subscription#
// assign_bigquery_service_account) - bigquery.googleapis.com API is not
// enabled for the project
// ([instructions](https://cloud.google.com/service-usage/docs/enable-dis
// able))
// "NOT_FOUND" - Cannot write to the BigQuery table because it does
// not exist.
// "SCHEMA_MISMATCH" - Cannot write to the BigQuery table due to a
// schema mismatch.
// "IN_TRANSIT_LOCATION_RESTRICTION" - Cannot write to the destination
// because enforce_in_transit is set to true and the destination
// locations are not in the allowed regions.
State string `json:"state,omitempty"`
// Table: Optional. The name of the table to which to write data, of the
// form {projectId}.{datasetId}.{tableId}
Table string `json:"table,omitempty"`
// UseTableSchema: Optional. When true, use the BigQuery table's schema
// as the columns to write to in BigQuery. `use_table_schema` and
// `use_topic_schema` cannot be enabled at the same time.
UseTableSchema bool `json:"useTableSchema,omitempty"`
// UseTopicSchema: Optional. When true, use the topic's schema as the
// columns to write to in BigQuery, if it exists. `use_topic_schema` and
// `use_table_schema` cannot be enabled at the same time.
UseTopicSchema bool `json:"useTopicSchema,omitempty"`
// WriteMetadata: Optional. When true, write the subscription name,
// message_id, publish_time, attributes, and ordering_key to additional
// columns in the table. The subscription name, message_id, and
// publish_time fields are put in their own columns while all other
// message properties (other than data) are written to a JSON object in
// the attributes column.
WriteMetadata bool `json:"writeMetadata,omitempty"`
// ForceSendFields is a list of field names (e.g. "DropUnknownFields")
// to unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DropUnknownFields") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *BigQueryConfig) MarshalJSON() ([]byte, error) {
type NoMethod BigQueryConfig
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Binding: Associates `members`, or principals, with a `role`.
type Binding struct {
// Condition: The condition that is associated with this binding. If the
// condition evaluates to `true`, then this binding applies to the
// current request. If the condition evaluates to `false`, then this
// binding does not apply to the current request. However, a different
// role binding might grant the same role to one or more of the
// principals in this binding. To learn which resources support
// conditions in their IAM policies, see the IAM documentation
// (https://cloud.google.com/iam/help/conditions/resource-policies).
Condition *Expr `json:"condition,omitempty"`
// Members: Specifies the principals requesting access for a Google
// Cloud 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. Does
// not include identities that come from external identity providers
// (IdPs) through identity federation. * `user:{emailid}`: An email
// address that represents a specific Google account. For example,
// `alice@example.com` . * `serviceAccount:{emailid}`: An email address
// that represents a Google service account. For example,
// `my-other-app@appspot.gserviceaccount.com`. *
// `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`:
// An identifier for a Kubernetes service account
// (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
// For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
// * `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`. *
// `principal://iam.googleapis.com/locations/global/workforcePools/{pool_
// id}/subject/{subject_attribute_value}`: A single identity in a
// workforce identity pool. *
// `principalSet://iam.googleapis.com/locations/global/workforcePools/{po
// ol_id}/group/{group_id}`: All workforce identities in a group. *
// `principalSet://iam.googleapis.com/locations/global/workforcePools/{po
// ol_id}/attribute.{attribute_name}/{attribute_value}`: All workforce
// identities with a specific attribute value. *
// `principalSet://iam.googleapis.com/locations/global/workforcePools/{po
// ol_id}/*`: All identities in a workforce identity pool. *
// `principal://iam.googleapis.com/projects/{project_number}/locations/gl
// obal/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}
// `: A single identity in a workload identity pool. *
// `principalSet://iam.googleapis.com/projects/{project_number}/locations
// /global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload
// identity pool group. *
// `principalSet://iam.googleapis.com/projects/{project_number}/locations
// /global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{at
// tribute_value}`: All identities in a workload identity pool with a
// certain attribute. *
// `principalSet://iam.googleapis.com/projects/{project_number}/locations
// /global/workloadIdentityPools/{pool_id}/*`: All identities in a
// workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An
// email address (plus unique identifier) representing a user that has
// been recently deleted. For example,
// `alice@example.com?uid=123456789012345678901`. If the user is
// recovered, this value reverts to `user:{emailid}` and the recovered
// user retains the role in the binding. *
// `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address
// (plus unique identifier) representing a service account that has been
// recently deleted. For example,
// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
// If the service account is undeleted, this value reverts to
// `serviceAccount:{emailid}` and the undeleted service account retains
// the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`:
// An email address (plus unique identifier) representing a Google group
// that has been recently deleted. For example,
// `admins@example.com?uid=123456789012345678901`. If the group is
// recovered, this value reverts to `group:{emailid}` and the recovered
// group retains the role in the binding. *
// `deleted:principal://iam.googleapis.com/locations/global/workforcePool
// s/{pool_id}/subject/{subject_attribute_value}`: Deleted single
// identity in a workforce identity pool. For example,
// `deleted:principal://iam.googleapis.com/locations/global/workforcePool
// s/my-pool-id/subject/my-subject-attribute-value`.
Members []string `json:"members,omitempty"`
// Role: Role that is assigned to the list of `members`, or principals.
// For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an
// overview of the IAM roles and permissions, see the IAM documentation
// (https://cloud.google.com/iam/docs/roles-overview). For a list of the
// available pre-defined roles, see here
// (https://cloud.google.com/iam/docs/understanding-roles).
Role string `json:"role,omitempty"`
// ForceSendFields is a list of field names (e.g. "Condition") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Condition") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Binding) MarshalJSON() ([]byte, error) {
type NoMethod Binding
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CloudStorageConfig: Configuration for a Cloud Storage subscription.
type CloudStorageConfig struct {
// AvroConfig: Optional. If set, message data will be written to Cloud
// Storage in Avro format.
AvroConfig *AvroConfig `json:"avroConfig,omitempty"`
// Bucket: Required. User-provided name for the Cloud Storage bucket.
// The bucket must be created by the user. The bucket name must be
// without any prefix like "gs://". See the [bucket naming requirements]
// (https://cloud.google.com/storage/docs/buckets#naming).
Bucket string `json:"bucket,omitempty"`
// FilenameDatetimeFormat: Optional. User-provided format string
// specifying how to represent datetimes in Cloud Storage filenames. See
// the datetime format guidance
// (https://cloud.google.com/pubsub/docs/create-cloudstorage-subscription#file_names).
FilenameDatetimeFormat string `json:"filenameDatetimeFormat,omitempty"`
// FilenamePrefix: Optional. User-provided prefix for Cloud Storage
// filename. See the object naming requirements
// (https://cloud.google.com/storage/docs/objects#naming).
FilenamePrefix string `json:"filenamePrefix,omitempty"`
// FilenameSuffix: Optional. User-provided suffix for Cloud Storage
// filename. See the object naming requirements
// (https://cloud.google.com/storage/docs/objects#naming). Must not end
// in "/".
FilenameSuffix string `json:"filenameSuffix,omitempty"`
// MaxBytes: Optional. The maximum bytes that can be written to a Cloud
// Storage file before a new file is created. Min 1 KB, max 10 GiB. The
// max_bytes limit may be exceeded in cases where messages are larger
// than the limit.
MaxBytes int64 `json:"maxBytes,omitempty,string"`
// MaxDuration: Optional. The maximum duration that can elapse before a
// new Cloud Storage file is created. Min 1 minute, max 10 minutes,
// default 5 minutes. May not exceed the subscription's acknowledgement
// deadline.
MaxDuration string `json:"maxDuration,omitempty"`
// ServiceAccountEmail: Optional. The service account to use to write to
// Cloud Storage. The subscription creator or updater that specifies
// this field must have `iam.serviceAccounts.actAs` permission on the
// service account. If not specified, the Pub/Sub service agent
// (https://cloud.google.com/iam/docs/service-agents),
// service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is
// used.
ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"`
// State: Output only. An output-only field that indicates whether or
// not the subscription can receive messages.
//
// Possible values:
// "STATE_UNSPECIFIED" - Default value. This value is unused.
// "ACTIVE" - The subscription can actively send messages to Cloud
// Storage.
// "PERMISSION_DENIED" - Cannot write to the Cloud Storage bucket
// because of permission denied errors.
// "NOT_FOUND" - Cannot write to the Cloud Storage bucket because it
// does not exist.
// "IN_TRANSIT_LOCATION_RESTRICTION" - Cannot write to the destination
// because enforce_in_transit is set to true and the destination
// locations are not in the allowed regions.
State string `json:"state,omitempty"`
// TextConfig: Optional. If set, message data will be written to Cloud
// Storage in text format.
TextConfig *TextConfig `json:"textConfig,omitempty"`
// ForceSendFields is a list of field names (e.g. "AvroConfig") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AvroConfig") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *CloudStorageConfig) MarshalJSON() ([]byte, error) {
type NoMethod CloudStorageConfig
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CommitSchemaRequest: Request for CommitSchema method.
type CommitSchemaRequest struct {
// Schema: Required. The schema revision to commit.
Schema *Schema `json:"schema,omitempty"`
// ForceSendFields is a list of field names (e.g. "Schema") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Schema") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *CommitSchemaRequest) MarshalJSON() ([]byte, error) {
type NoMethod CommitSchemaRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CreateSnapshotRequest: Request for the `CreateSnapshot` method.
type CreateSnapshotRequest struct {
// Labels: Optional. See Creating and managing labels
// (https://cloud.google.com/pubsub/docs/labels).
Labels map[string]string `json:"labels,omitempty"`
// Subscription: Required. The subscription whose backlog the snapshot
// retains. Specifically, the created snapshot is guaranteed to retain:
// (a) The existing backlog on the subscription. More precisely, this is
// defined as the messages in the subscription's backlog that are
// unacknowledged upon the successful completion of the `CreateSnapshot`
// request; as well as: (b) Any messages published to the subscription's
// topic following the successful completion of the CreateSnapshot
// request. Format is `projects/{project}/subscriptions/{sub}`.
Subscription string `json:"subscription,omitempty"`
// ForceSendFields is a list of field names (e.g. "Labels") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Labels") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *CreateSnapshotRequest) MarshalJSON() ([]byte, error) {
type NoMethod CreateSnapshotRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DeadLetterPolicy: Dead lettering is done on a best effort basis. The
// same message might be dead lettered multiple times. If validation on
// any of the fields fails at subscription creation/updation, the
// create/update subscription request will fail.
type DeadLetterPolicy struct {
// DeadLetterTopic: Optional. The name of the topic to which dead letter
// messages should be published. Format is
// `projects/{project}/topics/{topic}`.The Pub/Sub service account
// associated with the enclosing subscription's parent project (i.e.,
// service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must
// have permission to Publish() to this topic. The operation will fail
// if the topic does not exist. Users should ensure that there is a
// subscription attached to this topic since messages published to a
// topic with no subscriptions are lost.
DeadLetterTopic string `json:"deadLetterTopic,omitempty"`
// MaxDeliveryAttempts: Optional. The maximum number of delivery
// attempts for any message. The value must be between 5 and 100. The
// number of delivery attempts is defined as 1 + (the sum of number of
// NACKs and number of times the acknowledgement deadline has been
// exceeded for the message). A NACK is any call to ModifyAckDeadline
// with a 0 deadline. Note that client libraries may automatically
// extend ack_deadlines. This field will be honored on a best effort
// basis. If this parameter is 0, a default value of 5 is used.
MaxDeliveryAttempts int64 `json:"maxDeliveryAttempts,omitempty"`
// ForceSendFields is a list of field names (e.g. "DeadLetterTopic") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DeadLetterTopic") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *DeadLetterPolicy) MarshalJSON() ([]byte, error) {
type NoMethod DeadLetterPolicy
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DetachSubscriptionResponse: Response for the DetachSubscription
// method. Reserved for future use.
type DetachSubscriptionResponse struct {
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
}
// Empty: 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); }
type Empty struct {
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
}
// ExpirationPolicy: A policy that specifies the conditions for resource
// expiration (i.e., automatic resource deletion).
type ExpirationPolicy struct {
// Ttl: Optional. Specifies the "time-to-live" duration for an
// associated resource. The resource expires if it is not active for a
// period of `ttl`. The definition of "activity" depends on the type of
// the associated resource. The minimum and maximum allowed values for
// `ttl` depend on the type of the associated resource, as well. If
// `ttl` is not set, the associated resource never expires.
Ttl string `json:"ttl,omitempty"`
// ForceSendFields is a list of field names (e.g. "Ttl") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Ttl") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ExpirationPolicy) MarshalJSON() ([]byte, error) {
type NoMethod ExpirationPolicy
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Expr: Represents a textual expression in the Common Expression
// Language (CEL) syntax. CEL is a C-like expression language. The
// syntax and semantics of CEL are documented at
// https://github.com/google/cel-spec. Example (Comparison): title:
// "Summary size limit" description: "Determines if a summary is less
// than 100 chars" expression: "document.summary.size() < 100" Example
// (Equality): title: "Requestor is owner" description: "Determines if
// requestor is the document owner" expression: "document.owner ==
// request.auth.claims.email" Example (Logic): title: "Public documents"
// description: "Determine whether the document should be publicly
// visible" expression: "document.type != 'private' && document.type !=
// 'internal'" Example (Data Manipulation): title: "Notification string"
// description: "Create a notification string with a timestamp."
// expression: "'New message received at ' +
// string(document.create_time)" The exact variables and functions that
// may be referenced within an expression are determined by the service
// that evaluates it. See the service documentation for additional
// information.
type Expr struct {
// Description: 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 `json:"description,omitempty"`
// Expression: Textual representation of an expression in Common
// Expression Language syntax.
Expression string `json:"expression,omitempty"`
// Location: Optional. String indicating the location of the expression
// for error reporting, e.g. a file name and a position in the file.
Location string `json:"location,omitempty"`
// Title: 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 `json:"title,omitempty"`
// ForceSendFields is a list of field names (e.g. "Description") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Description") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Expr) MarshalJSON() ([]byte, error) {
type NoMethod Expr
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// IngestionDataSourceSettings: Settings for an ingestion data source on
// a topic.
type IngestionDataSourceSettings struct {
// AwsKinesis: Optional. Amazon Kinesis Data Streams.
AwsKinesis *AwsKinesis `json:"awsKinesis,omitempty"`
// ForceSendFields is a list of field names (e.g. "AwsKinesis") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AwsKinesis") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *IngestionDataSourceSettings) MarshalJSON() ([]byte, error) {
type NoMethod IngestionDataSourceSettings
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ListSchemaRevisionsResponse: Response for the `ListSchemaRevisions`
// method.
type ListSchemaRevisionsResponse struct {
// NextPageToken: A token that can be sent as `page_token` to retrieve
// the next page. If this field is empty, there are no subsequent pages.
NextPageToken string `json:"nextPageToken,omitempty"`
// Schemas: The revisions of the schema.
Schemas []*Schema `json:"schemas,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ListSchemaRevisionsResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListSchemaRevisionsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ListSchemasResponse: Response for the `ListSchemas` method.
type ListSchemasResponse struct {
// NextPageToken: If not empty, indicates that there may be more schemas
// that match the request; this value should be passed in a new
// `ListSchemasRequest`.
NextPageToken string `json:"nextPageToken,omitempty"`
// Schemas: The resulting schemas.
Schemas []*Schema `json:"schemas,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}