google-apis-pubsub_v1 0.37.0 → 0.39.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 61c7c14dd17915f5640bfd40b912933f693cda7705ecb94d6454f9ef20e12aa5
4
- data.tar.gz: 470522693f5176b65c1457eddbf433b90946dd7f9676c275e90955edcccec285
3
+ metadata.gz: 77109bdd5e635331fb2de705ec7a58beb7213ef709207db93898b2433cf75891
4
+ data.tar.gz: cc6243f621c45856837d66454725d6692c61b9dfa8698b572ef70707696b51e3
5
5
  SHA512:
6
- metadata.gz: a916595bd76402125717081064c124e1052affe84c8c2b7e666e8fb3f5db030de02c3019f74e94381d3ff43739eac0f626f8da7f82ee3616df0cc3e341f53d23
7
- data.tar.gz: 1cb19d7989ef51521ddc457110e2bba0c5bfbd3f4b19da41ddad040f9d75f5b374dcdeb05b153671b5859a6bced5cac716dbad6d9ebabcfa1182be786962b8da
6
+ metadata.gz: a274b03ccc9a8dee740aed360c2796428af479a4fc686e1b2c5580f8ebb944959ceabd48f992454f4723489c73a8f8e633201a77e66e35aea6656f82db9a06d2
7
+ data.tar.gz: 866c06c3e606055674b0a5a753df5a4d181c74d0bb59686b82782c8dfb4eafffe7cfc2b0a87c6d1d2cf3fa3a201f9527092cb14e1d7b5f921eb94a9ff44532dd
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-pubsub_v1
2
2
 
3
+ ### v0.39.0 (2023-07-02)
4
+
5
+ * Regenerated from discovery document revision 20230620
6
+
7
+ ### v0.38.0 (2023-06-11)
8
+
9
+ * Regenerated from discovery document revision 20230529
10
+
3
11
  ### v0.37.0 (2023-05-21)
4
12
 
5
13
  * Regenerated from discovery document revision 20230509
@@ -47,8 +47,8 @@ module Google
47
47
  class AvroConfig
48
48
  include Google::Apis::Core::Hashable
49
49
 
50
- # When true, write the subscription name, message_id, publish_time, attributes,
51
- # and ordering_key as additional fields in the output.
50
+ # Optional. When true, write the subscription name, message_id, publish_time,
51
+ # attributes, and ordering_key as additional fields in the output.
52
52
  # Corresponds to the JSON property `writeMetadata`
53
53
  # @return [Boolean]
54
54
  attr_accessor :write_metadata
@@ -68,9 +68,9 @@ module Google
68
68
  class BigQueryConfig
69
69
  include Google::Apis::Core::Hashable
70
70
 
71
- # When true and use_topic_schema is true, any fields that are a part of the
72
- # topic schema that are not part of the BigQuery table schema are dropped when
73
- # writing to BigQuery. Otherwise, the schemas must be kept in sync and any
71
+ # Optional. When true and use_topic_schema is true, any fields that are a part
72
+ # of the topic schema that are not part of the BigQuery table schema are dropped
73
+ # when writing to BigQuery. Otherwise, the schemas must be kept in sync and any
74
74
  # messages with extra fields are not written and remain in the subscription's
75
75
  # backlog.
76
76
  # Corresponds to the JSON property `dropUnknownFields`
@@ -84,24 +84,24 @@ module Google
84
84
  # @return [String]
85
85
  attr_accessor :state
86
86
 
87
- # The name of the table to which to write data, of the form `projectId`.`
88
- # datasetId`.`tableId`
87
+ # Optional. The name of the table to which to write data, of the form `projectId`
88
+ # .`datasetId`.`tableId`
89
89
  # Corresponds to the JSON property `table`
90
90
  # @return [String]
91
91
  attr_accessor :table
92
92
 
93
- # When true, use the topic's schema as the columns to write to in BigQuery, if
94
- # it exists.
93
+ # Optional. When true, use the topic's schema as the columns to write to in
94
+ # BigQuery, if it exists.
95
95
  # Corresponds to the JSON property `useTopicSchema`
96
96
  # @return [Boolean]
97
97
  attr_accessor :use_topic_schema
98
98
  alias_method :use_topic_schema?, :use_topic_schema
99
99
 
100
- # When true, write the subscription name, message_id, publish_time, attributes,
101
- # and ordering_key to additional columns in the table. The subscription name,
102
- # message_id, and publish_time fields are put in their own columns while all
103
- # other message properties (other than data) are written to a JSON object in the
104
- # attributes column.
100
+ # Optional. When true, write the subscription name, message_id, publish_time,
101
+ # attributes, and ordering_key to additional columns in the table. The
102
+ # subscription name, message_id, and publish_time fields are put in their own
103
+ # columns while all other message properties (other than data) are written to a
104
+ # JSON object in the attributes column.
105
105
  # Corresponds to the JSON property `writeMetadata`
106
106
  # @return [Boolean]
107
107
  attr_accessor :write_metadata
@@ -215,28 +215,28 @@ module Google
215
215
  # @return [String]
216
216
  attr_accessor :bucket
217
217
 
218
- # User-provided prefix for Cloud Storage filename. See the [object naming
219
- # requirements](https://cloud.google.com/storage/docs/objects#naming).
218
+ # Optional. User-provided prefix for Cloud Storage filename. See the [object
219
+ # naming requirements](https://cloud.google.com/storage/docs/objects#naming).
220
220
  # Corresponds to the JSON property `filenamePrefix`
221
221
  # @return [String]
222
222
  attr_accessor :filename_prefix
223
223
 
224
- # User-provided suffix for Cloud Storage filename. See the [object naming
225
- # requirements](https://cloud.google.com/storage/docs/objects#naming).
224
+ # Optional. User-provided suffix for Cloud Storage filename. See the [object
225
+ # naming requirements](https://cloud.google.com/storage/docs/objects#naming).
226
226
  # Corresponds to the JSON property `filenameSuffix`
227
227
  # @return [String]
228
228
  attr_accessor :filename_suffix
229
229
 
230
- # The maximum bytes that can be written to a Cloud Storage file before a new
231
- # file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in
232
- # cases where messages are larger than the limit.
230
+ # Optional. The maximum bytes that can be written to a Cloud Storage file before
231
+ # a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be
232
+ # exceeded in cases where messages are larger than the limit.
233
233
  # Corresponds to the JSON property `maxBytes`
234
234
  # @return [Fixnum]
235
235
  attr_accessor :max_bytes
236
236
 
237
- # The maximum duration that can elapse before a new Cloud Storage file is
238
- # created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the
239
- # subscription's acknowledgement deadline.
237
+ # Optional. The maximum duration that can elapse before a new Cloud Storage file
238
+ # is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed
239
+ # the subscription's acknowledgement deadline.
240
240
  # Corresponds to the JSON property `maxDuration`
241
241
  # @return [String]
242
242
  attr_accessor :max_duration
@@ -293,8 +293,8 @@ module Google
293
293
  class CreateSnapshotRequest
294
294
  include Google::Apis::Core::Hashable
295
295
 
296
- # See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels)
297
- # .
296
+ # Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/
297
+ # docs/labels).
298
298
  # Corresponds to the JSON property `labels`
299
299
  # @return [Hash<String,String>]
300
300
  attr_accessor :labels
@@ -328,8 +328,8 @@ module Google
328
328
  class DeadLetterPolicy
329
329
  include Google::Apis::Core::Hashable
330
330
 
331
- # The name of the topic to which dead letter messages should be published.
332
- # Format is `projects/`project`/topics/`topic``.The Cloud Pub/Sub service
331
+ # Optional. The name of the topic to which dead letter messages should be
332
+ # published. Format is `projects/`project`/topics/`topic``.The Pub/Sub service
333
333
  # account associated with the enclosing subscription's parent project (i.e.,
334
334
  # service-`project_number`@gcp-sa-pubsub.iam.gserviceaccount.com) must have
335
335
  # permission to Publish() to this topic. The operation will fail if the topic
@@ -339,13 +339,13 @@ module Google
339
339
  # @return [String]
340
340
  attr_accessor :dead_letter_topic
341
341
 
342
- # The maximum number of delivery attempts for any message. The value must be
343
- # between 5 and 100. The number of delivery attempts is defined as 1 + (the sum
344
- # of number of NACKs and number of times the acknowledgement deadline has been
345
- # exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0
346
- # deadline. Note that client libraries may automatically extend ack_deadlines.
347
- # This field will be honored on a best effort basis. If this parameter is 0, a
348
- # default value of 5 is used.
342
+ # Optional. The maximum number of delivery attempts for any message. The value
343
+ # must be between 5 and 100. The number of delivery attempts is defined as 1 + (
344
+ # the sum of number of NACKs and number of times the acknowledgement deadline
345
+ # has been exceeded for the message). A NACK is any call to ModifyAckDeadline
346
+ # with a 0 deadline. Note that client libraries may automatically extend
347
+ # ack_deadlines. This field will be honored on a best effort basis. If this
348
+ # parameter is 0, a default value of 5 is used.
349
349
  # Corresponds to the JSON property `maxDeliveryAttempts`
350
350
  # @return [Fixnum]
351
351
  attr_accessor :max_delivery_attempts
@@ -395,11 +395,11 @@ module Google
395
395
  class ExpirationPolicy
396
396
  include Google::Apis::Core::Hashable
397
397
 
398
- # Specifies the "time-to-live" duration for an associated resource. The resource
399
- # expires if it is not active for a period of `ttl`. The definition of "activity"
400
- # depends on the type of the associated resource. The minimum and maximum
401
- # allowed values for `ttl` depend on the type of the associated resource, as
402
- # well. If `ttl` is not set, the associated resource never expires.
398
+ # Optional. Specifies the "time-to-live" duration for an associated resource.
399
+ # The resource expires if it is not active for a period of `ttl`. The definition
400
+ # of "activity" depends on the type of the associated resource. The minimum and
401
+ # maximum allowed values for `ttl` depend on the type of the associated resource,
402
+ # as well. If `ttl` is not set, the associated resource never expires.
403
403
  # Corresponds to the JSON property `ttl`
404
404
  # @return [String]
405
405
  attr_accessor :ttl
@@ -524,13 +524,13 @@ module Google
524
524
  class ListSnapshotsResponse
525
525
  include Google::Apis::Core::Hashable
526
526
 
527
- # If not empty, indicates that there may be more snapshot that match the request;
528
- # this value should be passed in a new `ListSnapshotsRequest`.
527
+ # Optional. If not empty, indicates that there may be more snapshot that match
528
+ # the request; this value should be passed in a new `ListSnapshotsRequest`.
529
529
  # Corresponds to the JSON property `nextPageToken`
530
530
  # @return [String]
531
531
  attr_accessor :next_page_token
532
532
 
533
- # The resulting snapshots.
533
+ # Optional. The resulting snapshots.
534
534
  # Corresponds to the JSON property `snapshots`
535
535
  # @return [Array<Google::Apis::PubsubV1::Snapshot>]
536
536
  attr_accessor :snapshots
@@ -550,14 +550,14 @@ module Google
550
550
  class ListSubscriptionsResponse
551
551
  include Google::Apis::Core::Hashable
552
552
 
553
- # If not empty, indicates that there may be more subscriptions that match the
554
- # request; this value should be passed in a new `ListSubscriptionsRequest` to
555
- # get more subscriptions.
553
+ # Optional. If not empty, indicates that there may be more subscriptions that
554
+ # match the request; this value should be passed in a new `
555
+ # ListSubscriptionsRequest` to get more subscriptions.
556
556
  # Corresponds to the JSON property `nextPageToken`
557
557
  # @return [String]
558
558
  attr_accessor :next_page_token
559
559
 
560
- # The subscriptions that match the request.
560
+ # Optional. The subscriptions that match the request.
561
561
  # Corresponds to the JSON property `subscriptions`
562
562
  # @return [Array<Google::Apis::PubsubV1::Subscription>]
563
563
  attr_accessor :subscriptions
@@ -577,14 +577,14 @@ module Google
577
577
  class ListTopicSnapshotsResponse
578
578
  include Google::Apis::Core::Hashable
579
579
 
580
- # If not empty, indicates that there may be more snapshots that match the
581
- # request; this value should be passed in a new `ListTopicSnapshotsRequest` to
582
- # get more snapshots.
580
+ # Optional. If not empty, indicates that there may be more snapshots that match
581
+ # the request; this value should be passed in a new `ListTopicSnapshotsRequest`
582
+ # to get more snapshots.
583
583
  # Corresponds to the JSON property `nextPageToken`
584
584
  # @return [String]
585
585
  attr_accessor :next_page_token
586
586
 
587
- # The names of the snapshots that match the request.
587
+ # Optional. The names of the snapshots that match the request.
588
588
  # Corresponds to the JSON property `snapshots`
589
589
  # @return [Array<String>]
590
590
  attr_accessor :snapshots
@@ -604,14 +604,15 @@ module Google
604
604
  class ListTopicSubscriptionsResponse
605
605
  include Google::Apis::Core::Hashable
606
606
 
607
- # If not empty, indicates that there may be more subscriptions that match the
608
- # request; this value should be passed in a new `ListTopicSubscriptionsRequest`
609
- # to get more subscriptions.
607
+ # Optional. If not empty, indicates that there may be more subscriptions that
608
+ # match the request; this value should be passed in a new `
609
+ # ListTopicSubscriptionsRequest` to get more subscriptions.
610
610
  # Corresponds to the JSON property `nextPageToken`
611
611
  # @return [String]
612
612
  attr_accessor :next_page_token
613
613
 
614
- # The names of subscriptions attached to the topic specified in the request.
614
+ # Optional. The names of subscriptions attached to the topic specified in the
615
+ # request.
615
616
  # Corresponds to the JSON property `subscriptions`
616
617
  # @return [Array<String>]
617
618
  attr_accessor :subscriptions
@@ -631,13 +632,13 @@ module Google
631
632
  class ListTopicsResponse
632
633
  include Google::Apis::Core::Hashable
633
634
 
634
- # If not empty, indicates that there may be more topics that match the request;
635
- # this value should be passed in a new `ListTopicsRequest`.
635
+ # Optional. If not empty, indicates that there may be more topics that match the
636
+ # request; this value should be passed in a new `ListTopicsRequest`.
636
637
  # Corresponds to the JSON property `nextPageToken`
637
638
  # @return [String]
638
639
  attr_accessor :next_page_token
639
640
 
640
- # The resulting topics.
641
+ # Optional. The resulting topics.
641
642
  # Corresponds to the JSON property `topics`
642
643
  # @return [Array<Google::Apis::PubsubV1::Topic>]
643
644
  attr_accessor :topics
@@ -657,11 +658,11 @@ module Google
657
658
  class MessageStoragePolicy
658
659
  include Google::Apis::Core::Hashable
659
660
 
660
- # A list of IDs of GCP regions where messages that are published to the topic
661
- # may be persisted in storage. Messages published by publishers running in non-
662
- # allowed GCP regions (or running outside of GCP altogether) will be routed for
663
- # storage in one of the allowed regions. An empty list means that no regions are
664
- # allowed, and is not a valid configuration.
661
+ # Optional. A list of IDs of GCP regions where messages that are published to
662
+ # the topic may be persisted in storage. Messages published by publishers
663
+ # running in non-allowed GCP regions (or running outside of GCP altogether) will
664
+ # be routed for storage in one of the allowed regions. An empty list means that
665
+ # no regions are allowed, and is not a valid configuration.
665
666
  # Corresponds to the JSON property `allowedPersistenceRegions`
666
667
  # @return [Array<String>]
667
668
  attr_accessor :allowed_persistence_regions
@@ -727,25 +728,47 @@ module Google
727
728
  end
728
729
  end
729
730
 
731
+ # Sets the `data` field as the HTTP body for delivery.
732
+ class NoWrapper
733
+ include Google::Apis::Core::Hashable
734
+
735
+ # Optional. When true, writes the Pub/Sub message metadata to `x-goog-pubsub-:`
736
+ # headers of the HTTP request. Writes the Pub/Sub message attributes to `:`
737
+ # headers of the HTTP request.
738
+ # Corresponds to the JSON property `writeMetadata`
739
+ # @return [Boolean]
740
+ attr_accessor :write_metadata
741
+ alias_method :write_metadata?, :write_metadata
742
+
743
+ def initialize(**args)
744
+ update!(**args)
745
+ end
746
+
747
+ # Update properties of this object
748
+ def update!(**args)
749
+ @write_metadata = args[:write_metadata] if args.key?(:write_metadata)
750
+ end
751
+ end
752
+
730
753
  # Contains information needed for generating an [OpenID Connect token](https://
731
754
  # developers.google.com/identity/protocols/OpenIDConnect).
732
755
  class OidcToken
733
756
  include Google::Apis::Core::Hashable
734
757
 
735
- # Audience to be used when generating OIDC token. The audience claim identifies
736
- # the recipients that the JWT is intended for. The audience value is a single
737
- # case-sensitive string. Having multiple values (array) for the audience field
738
- # is not supported. More info about the OIDC JWT token audience here: https://
739
- # tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push
740
- # endpoint URL will be used.
758
+ # Optional. Audience to be used when generating OIDC token. The audience claim
759
+ # identifies the recipients that the JWT is intended for. The audience value is
760
+ # a single case-sensitive string. Having multiple values (array) for the
761
+ # audience field is not supported. More info about the OIDC JWT token audience
762
+ # here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified,
763
+ # the Push endpoint URL will be used.
741
764
  # Corresponds to the JSON property `audience`
742
765
  # @return [String]
743
766
  attr_accessor :audience
744
767
 
745
- # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
746
- # used for generating the OIDC token. For more information on setting up
747
- # authentication, see [Push subscriptions](https://cloud.google.com/pubsub/docs/
748
- # push).
768
+ # Optional. [Service account email](https://cloud.google.com/iam/docs/service-
769
+ # accounts) used for generating the OIDC token. For more information on setting
770
+ # up authentication, see [Push subscriptions](https://cloud.google.com/pubsub/
771
+ # docs/push).
749
772
  # Corresponds to the JSON property `serviceAccountEmail`
750
773
  # @return [String]
751
774
  attr_accessor :service_account_email
@@ -873,8 +896,9 @@ module Google
873
896
  class PublishResponse
874
897
  include Google::Apis::Core::Hashable
875
898
 
876
- # The server-assigned ID of each published message, in the same order as the
877
- # messages in the request. IDs are guaranteed to be unique within the topic.
899
+ # Optional. The server-assigned ID of each published message, in the same order
900
+ # as the messages in the request. IDs are guaranteed to be unique within the
901
+ # topic.
878
902
  # Corresponds to the JSON property `messageIds`
879
903
  # @return [Array<String>]
880
904
  attr_accessor :message_ids
@@ -899,30 +923,31 @@ module Google
899
923
  class Message
900
924
  include Google::Apis::Core::Hashable
901
925
 
902
- # Attributes for this message. If this field is empty, the message must contain
903
- # non-empty data. This can be used to filter messages on the subscription.
926
+ # Optional. Attributes for this message. If this field is empty, the message
927
+ # must contain non-empty data. This can be used to filter messages on the
928
+ # subscription.
904
929
  # Corresponds to the JSON property `attributes`
905
930
  # @return [Hash<String,String>]
906
931
  attr_accessor :attributes
907
932
 
908
- # The message data field. If this field is empty, the message must contain at
909
- # least one attribute.
933
+ # Optional. The message data field. If this field is empty, the message must
934
+ # contain at least one attribute.
910
935
  # Corresponds to the JSON property `data`
911
936
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
912
937
  # @return [String]
913
938
  attr_accessor :data
914
939
 
915
- # ID of this message, assigned by the server when the message is published.
916
- # Guaranteed to be unique within the topic. This value may be read by a
917
- # subscriber that receives a `PubsubMessage` via a `Pull` call or a push
940
+ # Optional. ID of this message, assigned by the server when the message is
941
+ # published. Guaranteed to be unique within the topic. This value may be read by
942
+ # a subscriber that receives a `PubsubMessage` via a `Pull` call or a push
918
943
  # delivery. It must not be populated by the publisher in a `Publish` call.
919
944
  # Corresponds to the JSON property `messageId`
920
945
  # @return [String]
921
946
  attr_accessor :message_id
922
947
 
923
- # If non-empty, identifies related messages for which publish order should be
924
- # respected. If a `Subscription` has `enable_message_ordering` set to `true`,
925
- # messages published with the same non-empty `ordering_key` value will be
948
+ # Optional. If non-empty, identifies related messages for which publish order
949
+ # should be respected. If a `Subscription` has `enable_message_ordering` set to `
950
+ # true`, messages published with the same non-empty `ordering_key` value will be
926
951
  # delivered to subscribers in the order in which they are received by the Pub/
927
952
  # Sub system. All `PubsubMessage`s published in a given `PublishRequest` must
928
953
  # specify the same `ordering_key` value. For more information, see [ordering
@@ -931,9 +956,9 @@ module Google
931
956
  # @return [String]
932
957
  attr_accessor :ordering_key
933
958
 
934
- # The time at which the message was published, populated by the server when it
935
- # receives the `Publish` call. It must not be populated by the publisher in a `
936
- # Publish` call.
959
+ # Optional. The time at which the message was published, populated by the server
960
+ # when it receives the `Publish` call. It must not be populated by the publisher
961
+ # in a `Publish` call.
937
962
  # Corresponds to the JSON property `publishTime`
938
963
  # @return [String]
939
964
  attr_accessor :publish_time
@@ -952,6 +977,21 @@ module Google
952
977
  end
953
978
  end
954
979
 
980
+ # The payload to the push endpoint is in the form of the JSON representation of
981
+ # a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.
982
+ # pubsub.v1#pubsubmessage).
983
+ class PubsubWrapper
984
+ include Google::Apis::Core::Hashable
985
+
986
+ def initialize(**args)
987
+ update!(**args)
988
+ end
989
+
990
+ # Update properties of this object
991
+ def update!(**args)
992
+ end
993
+ end
994
+
955
995
  # Request for the `Pull` method.
956
996
  class PullRequest
957
997
  include Google::Apis::Core::Hashable
@@ -990,11 +1030,11 @@ module Google
990
1030
  class PullResponse
991
1031
  include Google::Apis::Core::Hashable
992
1032
 
993
- # Received Pub/Sub messages. The list will be empty if there are no more
994
- # messages available in the backlog, or if no messages could be returned before
995
- # the request timeout. For JSON, the response can be entirely empty. The Pub/Sub
996
- # system may return fewer than the `maxMessages` requested even if there are
997
- # more messages available in the backlog.
1033
+ # Optional. Received Pub/Sub messages. The list will be empty if there are no
1034
+ # more messages available in the backlog, or if no messages could be returned
1035
+ # before the request timeout. For JSON, the response can be entirely empty. The
1036
+ # Pub/Sub system may return fewer than the `maxMessages` requested even if there
1037
+ # are more messages available in the backlog.
998
1038
  # Corresponds to the JSON property `receivedMessages`
999
1039
  # @return [Array<Google::Apis::PubsubV1::ReceivedMessage>]
1000
1040
  attr_accessor :received_messages
@@ -1013,31 +1053,43 @@ module Google
1013
1053
  class PushConfig
1014
1054
  include Google::Apis::Core::Hashable
1015
1055
 
1016
- # Endpoint configuration attributes that can be used to control different
1017
- # aspects of the message delivery. The only currently supported attribute is `x-
1018
- # goog-version`, which you can use to change the format of the pushed message.
1019
- # This attribute indicates the version of the data expected by the endpoint.
1020
- # This controls the shape of the pushed message (i.e., its fields and metadata).
1021
- # If not present during the `CreateSubscription` call, it will default to the
1022
- # version of the Pub/Sub API used to make such call. If not present in a `
1023
- # ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls
1024
- # will always return a valid version, even if the subscription was created
1025
- # without this attribute. The only supported values for the `x-goog-version`
1026
- # attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/
1027
- # Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub
1028
- # API. For example: `attributes ` "x-goog-version": "v1" ``
1056
+ # Optional. Endpoint configuration attributes that can be used to control
1057
+ # different aspects of the message delivery. The only currently supported
1058
+ # attribute is `x-goog-version`, which you can use to change the format of the
1059
+ # pushed message. This attribute indicates the version of the data expected by
1060
+ # the endpoint. This controls the shape of the pushed message (i.e., its fields
1061
+ # and metadata). If not present during the `CreateSubscription` call, it will
1062
+ # default to the version of the Pub/Sub API used to make such call. If not
1063
+ # present in a `ModifyPushConfig` call, its value will not be changed. `
1064
+ # GetSubscription` calls will always return a valid version, even if the
1065
+ # subscription was created without this attribute. The only supported values for
1066
+ # the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined
1067
+ # in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined
1068
+ # in the v1 Pub/Sub API. For example: `attributes ` "x-goog-version": "v1" ``
1029
1069
  # Corresponds to the JSON property `attributes`
1030
1070
  # @return [Hash<String,String>]
1031
1071
  attr_accessor :attributes
1032
1072
 
1073
+ # Sets the `data` field as the HTTP body for delivery.
1074
+ # Corresponds to the JSON property `noWrapper`
1075
+ # @return [Google::Apis::PubsubV1::NoWrapper]
1076
+ attr_accessor :no_wrapper
1077
+
1033
1078
  # Contains information needed for generating an [OpenID Connect token](https://
1034
1079
  # developers.google.com/identity/protocols/OpenIDConnect).
1035
1080
  # Corresponds to the JSON property `oidcToken`
1036
1081
  # @return [Google::Apis::PubsubV1::OidcToken]
1037
1082
  attr_accessor :oidc_token
1038
1083
 
1039
- # A URL locating the endpoint to which messages should be pushed. For example, a
1040
- # Webhook endpoint might use `https://example.com/push`.
1084
+ # The payload to the push endpoint is in the form of the JSON representation of
1085
+ # a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.
1086
+ # pubsub.v1#pubsubmessage).
1087
+ # Corresponds to the JSON property `pubsubWrapper`
1088
+ # @return [Google::Apis::PubsubV1::PubsubWrapper]
1089
+ attr_accessor :pubsub_wrapper
1090
+
1091
+ # Optional. A URL locating the endpoint to which messages should be pushed. For
1092
+ # example, a Webhook endpoint might use `https://example.com/push`.
1041
1093
  # Corresponds to the JSON property `pushEndpoint`
1042
1094
  # @return [String]
1043
1095
  attr_accessor :push_endpoint
@@ -1049,7 +1101,9 @@ module Google
1049
1101
  # Update properties of this object
1050
1102
  def update!(**args)
1051
1103
  @attributes = args[:attributes] if args.key?(:attributes)
1104
+ @no_wrapper = args[:no_wrapper] if args.key?(:no_wrapper)
1052
1105
  @oidc_token = args[:oidc_token] if args.key?(:oidc_token)
1106
+ @pubsub_wrapper = args[:pubsub_wrapper] if args.key?(:pubsub_wrapper)
1053
1107
  @push_endpoint = args[:push_endpoint] if args.key?(:push_endpoint)
1054
1108
  end
1055
1109
  end
@@ -1058,16 +1112,16 @@ module Google
1058
1112
  class ReceivedMessage
1059
1113
  include Google::Apis::Core::Hashable
1060
1114
 
1061
- # This ID can be used to acknowledge the received message.
1115
+ # Optional. This ID can be used to acknowledge the received message.
1062
1116
  # Corresponds to the JSON property `ackId`
1063
1117
  # @return [String]
1064
1118
  attr_accessor :ack_id
1065
1119
 
1066
- # The approximate number of times that Cloud Pub/Sub has attempted to deliver
1067
- # the associated message to a subscriber. More precisely, this is 1 + (number of
1068
- # NACKs) + (number of ack_deadline exceeds) for this message. A NACK is any call
1069
- # to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is
1070
- # whenever a message is not acknowledged within ack_deadline. Note that
1120
+ # Optional. The approximate number of times that Pub/Sub has attempted to
1121
+ # deliver the associated message to a subscriber. More precisely, this is 1 + (
1122
+ # number of NACKs) + (number of ack_deadline exceeds) for this message. A NACK
1123
+ # is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds
1124
+ # event is whenever a message is not acknowledged within ack_deadline. Note that
1071
1125
  # ack_deadline is initially Subscription.ackDeadlineSeconds, but may get
1072
1126
  # extended automatically by the client library. Upon the first delivery of a
1073
1127
  # given message, `delivery_attempt` will have a value of 1. The value is
@@ -1100,24 +1154,24 @@ module Google
1100
1154
  end
1101
1155
  end
1102
1156
 
1103
- # A policy that specifies how Cloud Pub/Sub retries message delivery. Retry
1104
- # delay will be exponential based on provided minimum and maximum backoffs.
1105
- # https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be
1106
- # triggered on NACKs or acknowledgement deadline exceeded events for a given
1107
- # message. Retry Policy is implemented on a best effort basis. At times, the
1108
- # delay between consecutive deliveries may not match the configuration. That is,
1109
- # delay can be more or less than configured backoff.
1157
+ # A policy that specifies how Pub/Sub retries message delivery. Retry delay will
1158
+ # be exponential based on provided minimum and maximum backoffs. https://en.
1159
+ # wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs
1160
+ # or acknowledgement deadline exceeded events for a given message. Retry Policy
1161
+ # is implemented on a best effort basis. At times, the delay between consecutive
1162
+ # deliveries may not match the configuration. That is, delay can be more or less
1163
+ # than configured backoff.
1110
1164
  class RetryPolicy
1111
1165
  include Google::Apis::Core::Hashable
1112
1166
 
1113
- # The maximum delay between consecutive deliveries of a given message. Value
1114
- # should be between 0 and 600 seconds. Defaults to 600 seconds.
1167
+ # Optional. The maximum delay between consecutive deliveries of a given message.
1168
+ # Value should be between 0 and 600 seconds. Defaults to 600 seconds.
1115
1169
  # Corresponds to the JSON property `maximumBackoff`
1116
1170
  # @return [String]
1117
1171
  attr_accessor :maximum_backoff
1118
1172
 
1119
- # The minimum delay between consecutive deliveries of a given message. Value
1120
- # should be between 0 and 600 seconds. Defaults to 10 seconds.
1173
+ # Optional. The minimum delay between consecutive deliveries of a given message.
1174
+ # Value should be between 0 and 600 seconds. Defaults to 10 seconds.
1121
1175
  # Corresponds to the JSON property `minimumBackoff`
1122
1176
  # @return [String]
1123
1177
  attr_accessor :minimum_backoff
@@ -1202,21 +1256,21 @@ module Google
1202
1256
  class SchemaSettings
1203
1257
  include Google::Apis::Core::Hashable
1204
1258
 
1205
- # The encoding of messages validated against `schema`.
1259
+ # Optional. The encoding of messages validated against `schema`.
1206
1260
  # Corresponds to the JSON property `encoding`
1207
1261
  # @return [String]
1208
1262
  attr_accessor :encoding
1209
1263
 
1210
- # The minimum (inclusive) revision allowed for validating messages. If empty or
1211
- # not present, allow any revision to be validated against last_revision or any
1212
- # revision created before.
1264
+ # Optional. The minimum (inclusive) revision allowed for validating messages. If
1265
+ # empty or not present, allow any revision to be validated against last_revision
1266
+ # or any revision created before.
1213
1267
  # Corresponds to the JSON property `firstRevisionId`
1214
1268
  # @return [String]
1215
1269
  attr_accessor :first_revision_id
1216
1270
 
1217
- # The maximum (inclusive) revision allowed for validating messages. If empty or
1218
- # not present, allow any revision to be validated against first_revision or any
1219
- # revision created after.
1271
+ # Optional. The maximum (inclusive) revision allowed for validating messages. If
1272
+ # empty or not present, allow any revision to be validated against
1273
+ # first_revision or any revision created after.
1220
1274
  # Corresponds to the JSON property `lastRevisionId`
1221
1275
  # @return [String]
1222
1276
  attr_accessor :last_revision_id
@@ -1245,21 +1299,23 @@ module Google
1245
1299
  class SeekRequest
1246
1300
  include Google::Apis::Core::Hashable
1247
1301
 
1248
- # The snapshot to seek to. The snapshot's topic must be the same as that of the
1249
- # provided subscription. Format is `projects/`project`/snapshots/`snap``.
1302
+ # Optional. The snapshot to seek to. The snapshot's topic must be the same as
1303
+ # that of the provided subscription. Format is `projects/`project`/snapshots/`
1304
+ # snap``.
1250
1305
  # Corresponds to the JSON property `snapshot`
1251
1306
  # @return [String]
1252
1307
  attr_accessor :snapshot
1253
1308
 
1254
- # The time to seek to. Messages retained in the subscription that were published
1255
- # before this time are marked as acknowledged, and messages retained in the
1256
- # subscription that were published after this time are marked as unacknowledged.
1257
- # Note that this operation affects only those messages retained in the
1258
- # subscription (configured by the combination of `message_retention_duration`
1259
- # and `retain_acked_messages`). For example, if `time` corresponds to a point
1260
- # before the message retention window (or to a point before the system's notion
1261
- # of the subscription creation time), only retained messages will be marked as
1262
- # unacknowledged, and already-expunged messages will not be restored.
1309
+ # Optional. The time to seek to. Messages retained in the subscription that were
1310
+ # published before this time are marked as acknowledged, and messages retained
1311
+ # in the subscription that were published after this time are marked as
1312
+ # unacknowledged. Note that this operation affects only those messages retained
1313
+ # in the subscription (configured by the combination of `
1314
+ # message_retention_duration` and `retain_acked_messages`). For example, if `
1315
+ # time` corresponds to a point before the message retention window (or to a
1316
+ # point before the system's notion of the subscription creation time), only
1317
+ # retained messages will be marked as unacknowledged, and already-expunged
1318
+ # messages will not be restored.
1263
1319
  # Corresponds to the JSON property `time`
1264
1320
  # @return [String]
1265
1321
  attr_accessor :time
@@ -1340,11 +1396,11 @@ module Google
1340
1396
  class Snapshot
1341
1397
  include Google::Apis::Core::Hashable
1342
1398
 
1343
- # The snapshot is guaranteed to exist up until this time. A newly-created
1344
- # snapshot expires no later than 7 days from the time of its creation. Its exact
1345
- # lifetime is determined at creation by the existing backlog in the source
1346
- # subscription. Specifically, the lifetime of the snapshot is `7 days - (age of
1347
- # oldest unacked message in the subscription)`. For example, consider a
1399
+ # Optional. The snapshot is guaranteed to exist up until this time. A newly-
1400
+ # created snapshot expires no later than 7 days from the time of its creation.
1401
+ # Its exact lifetime is determined at creation by the existing backlog in the
1402
+ # source subscription. Specifically, the lifetime of the snapshot is `7 days - (
1403
+ # age of oldest unacked message in the subscription)`. For example, consider a
1348
1404
  # subscription whose oldest unacked message is 3 days old. If a snapshot is
1349
1405
  # created from this subscription, the snapshot -- which will always capture this
1350
1406
  # 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The
@@ -1354,18 +1410,18 @@ module Google
1354
1410
  # @return [String]
1355
1411
  attr_accessor :expire_time
1356
1412
 
1357
- # See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/
1358
- # labels).
1413
+ # Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/
1414
+ # docs/labels).
1359
1415
  # Corresponds to the JSON property `labels`
1360
1416
  # @return [Hash<String,String>]
1361
1417
  attr_accessor :labels
1362
1418
 
1363
- # The name of the snapshot.
1419
+ # Optional. The name of the snapshot.
1364
1420
  # Corresponds to the JSON property `name`
1365
1421
  # @return [String]
1366
1422
  attr_accessor :name
1367
1423
 
1368
- # The name of the topic from which this snapshot is retaining messages.
1424
+ # Optional. The name of the topic from which this snapshot is retaining messages.
1369
1425
  # Corresponds to the JSON property `topic`
1370
1426
  # @return [String]
1371
1427
  attr_accessor :topic
@@ -1389,14 +1445,14 @@ module Google
1389
1445
  class Subscription
1390
1446
  include Google::Apis::Core::Hashable
1391
1447
 
1392
- # The approximate amount of time (on a best-effort basis) Pub/Sub waits for the
1393
- # subscriber to acknowledge receipt before resending the message. In the
1394
- # interval after the message is delivered and before it is acknowledged, it is
1395
- # considered to be _outstanding_. During that time period, the message will not
1396
- # be redelivered (on a best-effort basis). For pull subscriptions, this value is
1397
- # used as the initial value for the ack deadline. To override this value for a
1398
- # given message, call `ModifyAckDeadline` with the corresponding `ack_id` if
1399
- # using non-streaming pull or send the `ack_id` in a `
1448
+ # Optional. The approximate amount of time (on a best-effort basis) Pub/Sub
1449
+ # waits for the subscriber to acknowledge receipt before resending the message.
1450
+ # In the interval after the message is delivered and before it is acknowledged,
1451
+ # it is considered to be _outstanding_. During that time period, the message
1452
+ # will not be redelivered (on a best-effort basis). For pull subscriptions, this
1453
+ # value is used as the initial value for the ack deadline. To override this
1454
+ # value for a given message, call `ModifyAckDeadline` with the corresponding `
1455
+ # ack_id` if using non-streaming pull or send the `ack_id` in a `
1400
1456
  # StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom
1401
1457
  # deadline you can specify is 10 seconds. The maximum custom deadline you can
1402
1458
  # specify is 600 seconds (10 minutes). If this parameter is 0, a default value
@@ -1426,32 +1482,33 @@ module Google
1426
1482
  # @return [Google::Apis::PubsubV1::DeadLetterPolicy]
1427
1483
  attr_accessor :dead_letter_policy
1428
1484
 
1429
- # Indicates whether the subscription is detached from its topic. Detached
1430
- # subscriptions don't receive messages from their topic and don't retain any
1431
- # backlog. `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION.
1432
- # If the subscription is a push subscription, pushes to the endpoint will not be
1433
- # made.
1485
+ # Optional. Indicates whether the subscription is detached from its topic.
1486
+ # Detached subscriptions don't receive messages from their topic and don't
1487
+ # retain any backlog. `Pull` and `StreamingPull` requests will return
1488
+ # FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the
1489
+ # endpoint will not be made.
1434
1490
  # Corresponds to the JSON property `detached`
1435
1491
  # @return [Boolean]
1436
1492
  attr_accessor :detached
1437
1493
  alias_method :detached?, :detached
1438
1494
 
1439
- # If true, Pub/Sub provides the following guarantees for the delivery of a
1440
- # message with a given value of `message_id` on this subscription: * The message
1441
- # sent to a subscriber is guaranteed not to be resent before the message's
1442
- # acknowledgement deadline expires. * An acknowledged message will not be resent
1443
- # to a subscriber. Note that subscribers may still receive multiple copies of a
1444
- # message when `enable_exactly_once_delivery` is true if the message was
1445
- # published multiple times by a publisher client. These copies are considered
1446
- # distinct by Pub/Sub and have distinct `message_id` values.
1495
+ # Optional. If true, Pub/Sub provides the following guarantees for the delivery
1496
+ # of a message with a given value of `message_id` on this subscription: * The
1497
+ # message sent to a subscriber is guaranteed not to be resent before the message'
1498
+ # s acknowledgement deadline expires. * An acknowledged message will not be
1499
+ # resent to a subscriber. Note that subscribers may still receive multiple
1500
+ # copies of a message when `enable_exactly_once_delivery` is true if the message
1501
+ # was published multiple times by a publisher client. These copies are
1502
+ # considered distinct by Pub/Sub and have distinct `message_id` values.
1447
1503
  # Corresponds to the JSON property `enableExactlyOnceDelivery`
1448
1504
  # @return [Boolean]
1449
1505
  attr_accessor :enable_exactly_once_delivery
1450
1506
  alias_method :enable_exactly_once_delivery?, :enable_exactly_once_delivery
1451
1507
 
1452
- # If true, messages published with the same `ordering_key` in `PubsubMessage`
1453
- # will be delivered to the subscribers in the order in which they are received
1454
- # by the Pub/Sub system. Otherwise, they may be delivered in any order.
1508
+ # Optional. If true, messages published with the same `ordering_key` in `
1509
+ # PubsubMessage` will be delivered to the subscribers in the order in which they
1510
+ # are received by the Pub/Sub system. Otherwise, they may be delivered in any
1511
+ # order.
1455
1512
  # Corresponds to the JSON property `enableMessageOrdering`
1456
1513
  # @return [Boolean]
1457
1514
  attr_accessor :enable_message_ordering
@@ -1463,24 +1520,24 @@ module Google
1463
1520
  # @return [Google::Apis::PubsubV1::ExpirationPolicy]
1464
1521
  attr_accessor :expiration_policy
1465
1522
 
1466
- # An expression written in the Pub/Sub [filter language](https://cloud.google.
1467
- # com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s whose `
1468
- # attributes` field matches the filter are delivered on this subscription. If
1469
- # empty, then no messages are filtered out.
1523
+ # Optional. An expression written in the Pub/Sub [filter language](https://cloud.
1524
+ # google.com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s
1525
+ # whose `attributes` field matches the filter are delivered on this subscription.
1526
+ # If empty, then no messages are filtered out.
1470
1527
  # Corresponds to the JSON property `filter`
1471
1528
  # @return [String]
1472
1529
  attr_accessor :filter
1473
1530
 
1474
- # See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels)
1475
- # .
1531
+ # Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/
1532
+ # docs/labels).
1476
1533
  # Corresponds to the JSON property `labels`
1477
1534
  # @return [Hash<String,String>]
1478
1535
  attr_accessor :labels
1479
1536
 
1480
- # How long to retain unacknowledged messages in the subscription's backlog, from
1481
- # the moment a message is published. If `retain_acked_messages` is true, then
1482
- # this also configures the retention of acknowledged messages, and thus
1483
- # configures how far back in time a `Seek` can be done. Defaults to 7 days.
1537
+ # Optional. How long to retain unacknowledged messages in the subscription's
1538
+ # backlog, from the moment a message is published. If `retain_acked_messages` is
1539
+ # true, then this also configures the retention of acknowledged messages, and
1540
+ # thus configures how far back in time a `Seek` can be done. Defaults to 7 days.
1484
1541
  # Cannot be more than 7 days or less than 10 minutes.
1485
1542
  # Corresponds to the JSON property `messageRetentionDuration`
1486
1543
  # @return [String]
@@ -1501,24 +1558,24 @@ module Google
1501
1558
  # @return [Google::Apis::PubsubV1::PushConfig]
1502
1559
  attr_accessor :push_config
1503
1560
 
1504
- # Indicates whether to retain acknowledged messages. If true, then messages are
1505
- # not expunged from the subscription's backlog, even if they are acknowledged,
1506
- # until they fall out of the `message_retention_duration` window. This must be
1507
- # true if you would like to [`Seek` to a timestamp] (https://cloud.google.com/
1508
- # pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-
1509
- # acknowledged messages.
1561
+ # Optional. Indicates whether to retain acknowledged messages. If true, then
1562
+ # messages are not expunged from the subscription's backlog, even if they are
1563
+ # acknowledged, until they fall out of the `message_retention_duration` window.
1564
+ # This must be true if you would like to [`Seek` to a timestamp] (https://cloud.
1565
+ # google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay
1566
+ # previously-acknowledged messages.
1510
1567
  # Corresponds to the JSON property `retainAckedMessages`
1511
1568
  # @return [Boolean]
1512
1569
  attr_accessor :retain_acked_messages
1513
1570
  alias_method :retain_acked_messages?, :retain_acked_messages
1514
1571
 
1515
- # A policy that specifies how Cloud Pub/Sub retries message delivery. Retry
1516
- # delay will be exponential based on provided minimum and maximum backoffs.
1517
- # https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be
1518
- # triggered on NACKs or acknowledgement deadline exceeded events for a given
1519
- # message. Retry Policy is implemented on a best effort basis. At times, the
1520
- # delay between consecutive deliveries may not match the configuration. That is,
1521
- # delay can be more or less than configured backoff.
1572
+ # A policy that specifies how Pub/Sub retries message delivery. Retry delay will
1573
+ # be exponential based on provided minimum and maximum backoffs. https://en.
1574
+ # wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs
1575
+ # or acknowledgement deadline exceeded events for a given message. Retry Policy
1576
+ # is implemented on a best effort basis. At times, the delay between consecutive
1577
+ # deliveries may not match the configuration. That is, delay can be more or less
1578
+ # than configured backoff.
1522
1579
  # Corresponds to the JSON property `retryPolicy`
1523
1580
  # @return [Google::Apis::PubsubV1::RetryPolicy]
1524
1581
  attr_accessor :retry_policy
@@ -1631,27 +1688,27 @@ module Google
1631
1688
  class Topic
1632
1689
  include Google::Apis::Core::Hashable
1633
1690
 
1634
- # The resource name of the Cloud KMS CryptoKey to be used to protect access to
1635
- # messages published on this topic. The expected format is `projects/*/locations/
1636
- # */keyRings/*/cryptoKeys/*`.
1691
+ # Optional. The resource name of the Cloud KMS CryptoKey to be used to protect
1692
+ # access to messages published on this topic. The expected format is `projects/*/
1693
+ # locations/*/keyRings/*/cryptoKeys/*`.
1637
1694
  # Corresponds to the JSON property `kmsKeyName`
1638
1695
  # @return [String]
1639
1696
  attr_accessor :kms_key_name
1640
1697
 
1641
- # See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/
1642
- # labels).
1698
+ # Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/
1699
+ # docs/labels).
1643
1700
  # Corresponds to the JSON property `labels`
1644
1701
  # @return [Hash<String,String>]
1645
1702
  attr_accessor :labels
1646
1703
 
1647
- # Indicates the minimum duration to retain a message after it is published to
1648
- # the topic. If this field is set, messages published to the topic in the last `
1649
- # message_retention_duration` are always available to subscribers. For instance,
1650
- # it allows any attached subscription to [seek to a timestamp](https://cloud.
1651
- # google.com/pubsub/docs/replay-overview#seek_to_a_time) that is up to `
1652
- # message_retention_duration` in the past. If this field is not set, message
1653
- # retention is controlled by settings on individual subscriptions. Cannot be
1654
- # more than 31 days or less than 10 minutes.
1704
+ # Optional. Indicates the minimum duration to retain a message after it is
1705
+ # published to the topic. If this field is set, messages published to the topic
1706
+ # in the last `message_retention_duration` are always available to subscribers.
1707
+ # For instance, it allows any attached subscription to [seek to a timestamp](
1708
+ # https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) that is
1709
+ # up to `message_retention_duration` in the past. If this field is not set,
1710
+ # message retention is controlled by settings on individual subscriptions.
1711
+ # Cannot be more than 31 days or less than 10 minutes.
1655
1712
  # Corresponds to the JSON property `messageRetentionDuration`
1656
1713
  # @return [String]
1657
1714
  attr_accessor :message_retention_duration
@@ -1670,8 +1727,8 @@ module Google
1670
1727
  # @return [String]
1671
1728
  attr_accessor :name
1672
1729
 
1673
- # Reserved for future use. This field is set only in responses from the server;
1674
- # it is ignored if it is set in any requests.
1730
+ # Optional. Reserved for future use. This field is set only in responses from
1731
+ # the server; it is ignored if it is set in any requests.
1675
1732
  # Corresponds to the JSON property `satisfiesPzs`
1676
1733
  # @return [Boolean]
1677
1734
  attr_accessor :satisfies_pzs
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module PubsubV1
18
18
  # Version of the google-apis-pubsub_v1 gem
19
- GEM_VERSION = "0.37.0"
19
+ GEM_VERSION = "0.39.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.12.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20230509"
25
+ REVISION = "20230620"
26
26
  end
27
27
  end
28
28
  end
@@ -154,6 +154,12 @@ module Google
154
154
  include Google::Apis::Core::JsonObjectSupport
155
155
  end
156
156
 
157
+ class NoWrapper
158
+ class Representation < Google::Apis::Core::JsonRepresentation; end
159
+
160
+ include Google::Apis::Core::JsonObjectSupport
161
+ end
162
+
157
163
  class OidcToken
158
164
  class Representation < Google::Apis::Core::JsonRepresentation; end
159
165
 
@@ -184,6 +190,12 @@ module Google
184
190
  include Google::Apis::Core::JsonObjectSupport
185
191
  end
186
192
 
193
+ class PubsubWrapper
194
+ class Representation < Google::Apis::Core::JsonRepresentation; end
195
+
196
+ include Google::Apis::Core::JsonObjectSupport
197
+ end
198
+
187
199
  class PullRequest
188
200
  class Representation < Google::Apis::Core::JsonRepresentation; end
189
201
 
@@ -516,6 +528,13 @@ module Google
516
528
  end
517
529
  end
518
530
 
531
+ class NoWrapper
532
+ # @private
533
+ class Representation < Google::Apis::Core::JsonRepresentation
534
+ property :write_metadata, as: 'writeMetadata'
535
+ end
536
+ end
537
+
519
538
  class OidcToken
520
539
  # @private
521
540
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -560,6 +579,12 @@ module Google
560
579
  end
561
580
  end
562
581
 
582
+ class PubsubWrapper
583
+ # @private
584
+ class Representation < Google::Apis::Core::JsonRepresentation
585
+ end
586
+ end
587
+
563
588
  class PullRequest
564
589
  # @private
565
590
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -580,8 +605,12 @@ module Google
580
605
  # @private
581
606
  class Representation < Google::Apis::Core::JsonRepresentation
582
607
  hash :attributes, as: 'attributes'
608
+ property :no_wrapper, as: 'noWrapper', class: Google::Apis::PubsubV1::NoWrapper, decorator: Google::Apis::PubsubV1::NoWrapper::Representation
609
+
583
610
  property :oidc_token, as: 'oidcToken', class: Google::Apis::PubsubV1::OidcToken, decorator: Google::Apis::PubsubV1::OidcToken::Representation
584
611
 
612
+ property :pubsub_wrapper, as: 'pubsubWrapper', class: Google::Apis::PubsubV1::PubsubWrapper, decorator: Google::Apis::PubsubV1::PubsubWrapper::Representation
613
+
585
614
  property :push_endpoint, as: 'pushEndpoint'
586
615
  end
587
616
  end
@@ -707,11 +707,11 @@ module Google
707
707
  # Required. The name of the project in which to list snapshots. Format is `
708
708
  # projects/`project-id``.
709
709
  # @param [Fixnum] page_size
710
- # Maximum number of snapshots to return.
710
+ # Optional. Maximum number of snapshots to return.
711
711
  # @param [String] page_token
712
- # The value returned by the last `ListSnapshotsResponse`; indicates that this is
713
- # a continuation of a prior `ListSnapshots` call, and that the system should
714
- # return the next page of data.
712
+ # Optional. The value returned by the last `ListSnapshotsResponse`; indicates
713
+ # that this is a continuation of a prior `ListSnapshots` call, and that the
714
+ # system should return the next page of data.
715
715
  # @param [String] fields
716
716
  # Selector specifying which fields to include in a partial response.
717
717
  # @param [String] quota_user
@@ -746,7 +746,7 @@ module Google
746
746
  # message acknowledgments in bulk. That is, you can set the acknowledgment state
747
747
  # of messages in an existing subscription to the state captured by a snapshot.
748
748
  # @param [String] name
749
- # The name of the snapshot.
749
+ # Optional. The name of the snapshot.
750
750
  # @param [Google::Apis::PubsubV1::UpdateSnapshotRequest] update_snapshot_request_object
751
751
  # @param [String] fields
752
752
  # Selector specifying which fields to include in a partial response.
@@ -1087,11 +1087,11 @@ module Google
1087
1087
  # Required. The name of the project in which to list subscriptions. Format is `
1088
1088
  # projects/`project-id``.
1089
1089
  # @param [Fixnum] page_size
1090
- # Maximum number of subscriptions to return.
1090
+ # Optional. Maximum number of subscriptions to return.
1091
1091
  # @param [String] page_token
1092
- # The value returned by the last `ListSubscriptionsResponse`; indicates that
1093
- # this is a continuation of a prior `ListSubscriptions` call, and that the
1094
- # system should return the next page of data.
1092
+ # Optional. The value returned by the last `ListSubscriptionsResponse`;
1093
+ # indicates that this is a continuation of a prior `ListSubscriptions` call, and
1094
+ # that the system should return the next page of data.
1095
1095
  # @param [String] fields
1096
1096
  # Selector specifying which fields to include in a partial response.
1097
1097
  # @param [String] quota_user
@@ -1539,11 +1539,11 @@ module Google
1539
1539
  # Required. The name of the project in which to list topics. Format is `projects/
1540
1540
  # `project-id``.
1541
1541
  # @param [Fixnum] page_size
1542
- # Maximum number of topics to return.
1542
+ # Optional. Maximum number of topics to return.
1543
1543
  # @param [String] page_token
1544
- # The value returned by the last `ListTopicsResponse`; indicates that this is a
1545
- # continuation of a prior `ListTopics` call, and that the system should return
1546
- # the next page of data.
1544
+ # Optional. The value returned by the last `ListTopicsResponse`; indicates that
1545
+ # this is a continuation of a prior `ListTopics` call, and that the system
1546
+ # should return the next page of data.
1547
1547
  # @param [String] fields
1548
1548
  # Selector specifying which fields to include in a partial response.
1549
1549
  # @param [String] quota_user
@@ -1731,11 +1731,11 @@ module Google
1731
1731
  # Required. The name of the topic that snapshots are attached to. Format is `
1732
1732
  # projects/`project`/topics/`topic``.
1733
1733
  # @param [Fixnum] page_size
1734
- # Maximum number of snapshot names to return.
1734
+ # Optional. Maximum number of snapshot names to return.
1735
1735
  # @param [String] page_token
1736
- # The value returned by the last `ListTopicSnapshotsResponse`; indicates that
1737
- # this is a continuation of a prior `ListTopicSnapshots` call, and that the
1738
- # system should return the next page of data.
1736
+ # Optional. The value returned by the last `ListTopicSnapshotsResponse`;
1737
+ # indicates that this is a continuation of a prior `ListTopicSnapshots` call,
1738
+ # and that the system should return the next page of data.
1739
1739
  # @param [String] fields
1740
1740
  # Selector specifying which fields to include in a partial response.
1741
1741
  # @param [String] quota_user
@@ -1770,11 +1770,11 @@ module Google
1770
1770
  # Required. The name of the topic that subscriptions are attached to. Format is `
1771
1771
  # projects/`project`/topics/`topic``.
1772
1772
  # @param [Fixnum] page_size
1773
- # Maximum number of subscription names to return.
1773
+ # Optional. Maximum number of subscription names to return.
1774
1774
  # @param [String] page_token
1775
- # The value returned by the last `ListTopicSubscriptionsResponse`; indicates
1776
- # that this is a continuation of a prior `ListTopicSubscriptions` call, and that
1777
- # the system should return the next page of data.
1775
+ # Optional. The value returned by the last `ListTopicSubscriptionsResponse`;
1776
+ # indicates that this is a continuation of a prior `ListTopicSubscriptions` call,
1777
+ # and that the system should return the next page of data.
1778
1778
  # @param [String] fields
1779
1779
  # Selector specifying which fields to include in a partial response.
1780
1780
  # @param [String] quota_user
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-pubsub_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.37.0
4
+ version: 0.39.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-05-21 00:00:00.000000000 Z
11
+ date: 2023-07-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-pubsub_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-pubsub_v1/v0.37.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-pubsub_v1/v0.39.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-pubsub_v1
63
63
  post_install_message:
64
64
  rdoc_options: []