RubyGems - google-apis-pubsub_v1 - Versions diffs - 0.38.0 → 0.39.0 - Mend

google-apis-pubsub_v1 0.38.0 → 0.39.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +4 -0
data/lib/google/apis/pubsub_v1/classes.rb +223 -217
data/lib/google/apis/pubsub_v1/gem_version.rb +2 -2
data/lib/google/apis/pubsub_v1/service.rb +21 -21
metadata +3 -3

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc53e8f7177d7b64729ee2706e490a94b8890a280c7b09545b33ceb7973f8217
-  data.tar.gz: 413c019559d65556122c8d9c864126430b485d38f1242a811d4bac5496adc2b5
+  metadata.gz: 77109bdd5e635331fb2de705ec7a58beb7213ef709207db93898b2433cf75891
+  data.tar.gz: cc6243f621c45856837d66454725d6692c61b9dfa8698b572ef70707696b51e3
 SHA512:
-  metadata.gz: 04465e695856d2d7fde0f0f90d9418c65a0eb2a5995652b38ba7d80c0d14e710e706bf06789a8a9c453e4a507698a2d888736bd4021120f32d7c16a345bdaad3
-  data.tar.gz: f867e709c0af85e9c676459bb7c76ca3610e6a8d37f51d9236a6235cef43306137fdfb4acea631b8cfbcf37feb6eabe3bf117fe6cd0e2bce2615fb767e46bde8
+  metadata.gz: a274b03ccc9a8dee740aed360c2796428af479a4fc686e1b2c5580f8ebb944959ceabd48f992454f4723489c73a8f8e633201a77e66e35aea6656f82db9a06d2
+  data.tar.gz: 866c06c3e606055674b0a5a753df5a4d181c74d0bb59686b82782c8dfb4eafffe7cfc2b0a87c6d1d2cf3fa3a201f9527092cb14e1d7b5f921eb94a9ff44532dd

data/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,9 @@
 # Release history for google-apis-pubsub_v1
+### v0.39.0 (2023-07-02)
+* Regenerated from discovery document revision 20230620
 ### v0.38.0 (2023-06-11)
 * Regenerated from discovery document revision 20230529

data/lib/google/apis/pubsub_v1/classes.rb CHANGED Viewed

@@ -47,8 +47,8 @@ module Google
       class AvroConfig
         include Google::Apis::Core::Hashable
-        # When true, write the subscription name, message_id, publish_time, attributes,
-        # and ordering_key as additional fields in the output.
+        # Optional. When true, write the subscription name, message_id, publish_time,
+        # attributes, and ordering_key as additional fields in the output.
         # Corresponds to the JSON property `writeMetadata`
         # @return [Boolean]
         attr_accessor :write_metadata
@@ -68,9 +68,9 @@ module Google
       class BigQueryConfig
         include Google::Apis::Core::Hashable
-        # 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
+        # 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.
         # Corresponds to the JSON property `dropUnknownFields`
@@ -84,24 +84,24 @@ module Google
         # @return [String]
         attr_accessor :state
-        # The name of the table to which to write data, of the form `projectId`.`
-        # datasetId`.`tableId`
+        # Optional. The name of the table to which to write data, of the form `projectId`
+        # .`datasetId`.`tableId`
         # Corresponds to the JSON property `table`
         # @return [String]
         attr_accessor :table
-        # When true, use the topic's schema as the columns to write to in BigQuery, if
-        # it exists.
+        # Optional. When true, use the topic's schema as the columns to write to in
+        # BigQuery, if it exists.
         # Corresponds to the JSON property `useTopicSchema`
         # @return [Boolean]
         attr_accessor :use_topic_schema
         alias_method :use_topic_schema?, :use_topic_schema
-        # 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.
+        # 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.
         # Corresponds to the JSON property `writeMetadata`
         # @return [Boolean]
         attr_accessor :write_metadata
@@ -215,28 +215,28 @@ module Google
         # @return [String]
         attr_accessor :bucket
-        # User-provided prefix for Cloud Storage filename. See the [object naming
-        # requirements](https://cloud.google.com/storage/docs/objects#naming).
+        # Optional. User-provided prefix for Cloud Storage filename. See the [object
+        # naming requirements](https://cloud.google.com/storage/docs/objects#naming).
         # Corresponds to the JSON property `filenamePrefix`
         # @return [String]
         attr_accessor :filename_prefix
-        # User-provided suffix for Cloud Storage filename. See the [object naming
-        # requirements](https://cloud.google.com/storage/docs/objects#naming).
+        # Optional. User-provided suffix for Cloud Storage filename. See the [object
+        # naming requirements](https://cloud.google.com/storage/docs/objects#naming).
         # Corresponds to the JSON property `filenameSuffix`
         # @return [String]
         attr_accessor :filename_suffix
-        # 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.
+        # 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.
         # Corresponds to the JSON property `maxBytes`
         # @return [Fixnum]
         attr_accessor :max_bytes
-        # 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.
+        # 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.
         # Corresponds to the JSON property `maxDuration`
         # @return [String]
         attr_accessor :max_duration
@@ -293,8 +293,8 @@ module Google
       class CreateSnapshotRequest
         include Google::Apis::Core::Hashable
-        # See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels)
-        # .
+        # Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/
+        # docs/labels).
         # Corresponds to the JSON property `labels`
         # @return [Hash<String,String>]
         attr_accessor :labels
@@ -328,8 +328,8 @@ module Google
       class DeadLetterPolicy
         include Google::Apis::Core::Hashable
-        # The name of the topic to which dead letter messages should be published.
-        # Format is `projects/`project`/topics/`topic``.The Cloud Pub/Sub service
+        # 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
@@ -339,13 +339,13 @@ module Google
         # @return [String]
         attr_accessor :dead_letter_topic
-        # 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.
+        # 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.
         # Corresponds to the JSON property `maxDeliveryAttempts`
         # @return [Fixnum]
         attr_accessor :max_delivery_attempts
@@ -395,11 +395,11 @@ module Google
       class ExpirationPolicy
         include Google::Apis::Core::Hashable
-        # 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.
+        # 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.
         # Corresponds to the JSON property `ttl`
         # @return [String]
         attr_accessor :ttl
@@ -524,13 +524,13 @@ module Google
       class ListSnapshotsResponse
         include Google::Apis::Core::Hashable
-        # If not empty, indicates that there may be more snapshot that match the request;
-        # this value should be passed in a new `ListSnapshotsRequest`.
+        # Optional. If not empty, indicates that there may be more snapshot that match
+        # the request; this value should be passed in a new `ListSnapshotsRequest`.
         # Corresponds to the JSON property `nextPageToken`
         # @return [String]
         attr_accessor :next_page_token
-        # The resulting snapshots.
+        # Optional. The resulting snapshots.
         # Corresponds to the JSON property `snapshots`
         # @return [Array<Google::Apis::PubsubV1::Snapshot>]
         attr_accessor :snapshots
@@ -550,14 +550,14 @@ module Google
       class ListSubscriptionsResponse
         include Google::Apis::Core::Hashable
-        # If not empty, indicates that there may be more subscriptions that match the
-        # request; this value should be passed in a new `ListSubscriptionsRequest` to
-        # get more subscriptions.
+        # Optional. If not empty, indicates that there may be more subscriptions that
+        # match the request; this value should be passed in a new `
+        # ListSubscriptionsRequest` to get more subscriptions.
         # Corresponds to the JSON property `nextPageToken`
         # @return [String]
         attr_accessor :next_page_token
-        # The subscriptions that match the request.
+        # Optional. The subscriptions that match the request.
         # Corresponds to the JSON property `subscriptions`
         # @return [Array<Google::Apis::PubsubV1::Subscription>]
         attr_accessor :subscriptions
@@ -577,14 +577,14 @@ module Google
       class ListTopicSnapshotsResponse
         include Google::Apis::Core::Hashable
-        # If not empty, indicates that there may be more snapshots that match the
-        # request; this value should be passed in a new `ListTopicSnapshotsRequest` to
-        # get more snapshots.
+        # Optional. If not empty, indicates that there may be more snapshots that match
+        # the request; this value should be passed in a new `ListTopicSnapshotsRequest`
+        # to get more snapshots.
         # Corresponds to the JSON property `nextPageToken`
         # @return [String]
         attr_accessor :next_page_token
-        # The names of the snapshots that match the request.
+        # Optional. The names of the snapshots that match the request.
         # Corresponds to the JSON property `snapshots`
         # @return [Array<String>]
         attr_accessor :snapshots
@@ -604,14 +604,15 @@ module Google
       class ListTopicSubscriptionsResponse
         include Google::Apis::Core::Hashable
-        # If not empty, indicates that there may be more subscriptions that match the
-        # request; this value should be passed in a new `ListTopicSubscriptionsRequest`
-        # to get more subscriptions.
+        # Optional. If not empty, indicates that there may be more subscriptions that
+        # match the request; this value should be passed in a new `
+        # ListTopicSubscriptionsRequest` to get more subscriptions.
         # Corresponds to the JSON property `nextPageToken`
         # @return [String]
         attr_accessor :next_page_token
-        # The names of subscriptions attached to the topic specified in the request.
+        # Optional. The names of subscriptions attached to the topic specified in the
+        # request.
         # Corresponds to the JSON property `subscriptions`
         # @return [Array<String>]
         attr_accessor :subscriptions
@@ -631,13 +632,13 @@ module Google
       class ListTopicsResponse
         include Google::Apis::Core::Hashable
-        # If not empty, indicates that there may be more topics that match the request;
-        # this value should be passed in a new `ListTopicsRequest`.
+        # Optional. If not empty, indicates that there may be more topics that match the
+        # request; this value should be passed in a new `ListTopicsRequest`.
         # Corresponds to the JSON property `nextPageToken`
         # @return [String]
         attr_accessor :next_page_token
-        # The resulting topics.
+        # Optional. The resulting topics.
         # Corresponds to the JSON property `topics`
         # @return [Array<Google::Apis::PubsubV1::Topic>]
         attr_accessor :topics
@@ -657,11 +658,11 @@ module Google
       class MessageStoragePolicy
         include Google::Apis::Core::Hashable
-        # A list of IDs of GCP regions where messages that are published to the topic
-        # may be persisted in storage. Messages published by publishers running in non-
-        # allowed GCP regions (or running outside of GCP altogether) will be routed for
-        # storage in one of the allowed regions. An empty list means that no regions are
-        # allowed, and is not a valid configuration.
+        # Optional. A list of IDs of GCP regions where messages that are published to
+        # the topic may be persisted in storage. Messages published by publishers
+        # running in non-allowed GCP regions (or running outside of GCP altogether) will
+        # be routed for storage in one of the allowed regions. An empty list means that
+        # no regions are allowed, and is not a valid configuration.
         # Corresponds to the JSON property `allowedPersistenceRegions`
         # @return [Array<String>]
         attr_accessor :allowed_persistence_regions
@@ -731,9 +732,9 @@ module Google
       class NoWrapper
         include Google::Apis::Core::Hashable
-        # When true, writes the Pub/Sub message metadata to `x-goog-pubsub-:` headers of
-        # the HTTP request. Writes the Pub/Sub message attributes to `:` headers of the
-        # HTTP request.
+        # Optional. When true, writes the Pub/Sub message metadata to `x-goog-pubsub-:`
+        # headers of the HTTP request. Writes the Pub/Sub message attributes to `:`
+        # headers of the HTTP request.
         # Corresponds to the JSON property `writeMetadata`
         # @return [Boolean]
         attr_accessor :write_metadata
@@ -754,20 +755,20 @@ module Google
       class OidcToken
         include Google::Apis::Core::Hashable
-        # Audience to be used when generating OIDC token. The audience claim identifies
-        # the recipients that the JWT is intended for. The audience value is a single
-        # case-sensitive string. Having multiple values (array) for the audience field
-        # is not supported. More info about the OIDC JWT token audience here: https://
-        # tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push
-        # endpoint URL will be used.
+        # Optional. Audience to be used when generating OIDC token. The audience claim
+        # identifies the recipients that the JWT is intended for. The audience value is
+        # a single case-sensitive string. Having multiple values (array) for the
+        # audience field is not supported. More info about the OIDC JWT token audience
+        # here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified,
+        # the Push endpoint URL will be used.
         # Corresponds to the JSON property `audience`
         # @return [String]
         attr_accessor :audience
-        # [Service account email](https://cloud.google.com/iam/docs/service-accounts)
-        # used for generating the OIDC token. For more information on setting up
-        # authentication, see [Push subscriptions](https://cloud.google.com/pubsub/docs/
-        # push).
+        # Optional. [Service account email](https://cloud.google.com/iam/docs/service-
+        # accounts) used for generating the OIDC token. For more information on setting
+        # up authentication, see [Push subscriptions](https://cloud.google.com/pubsub/
+        # docs/push).
         # Corresponds to the JSON property `serviceAccountEmail`
         # @return [String]
         attr_accessor :service_account_email
@@ -895,8 +896,9 @@ module Google
       class PublishResponse
         include Google::Apis::Core::Hashable
-        # The server-assigned ID of each published message, in the same order as the
-        # messages in the request. IDs are guaranteed to be unique within the topic.
+        # Optional. The server-assigned ID of each published message, in the same order
+        # as the messages in the request. IDs are guaranteed to be unique within the
+        # topic.
         # Corresponds to the JSON property `messageIds`
         # @return [Array<String>]
         attr_accessor :message_ids
@@ -921,30 +923,31 @@ module Google
       class Message
         include Google::Apis::Core::Hashable
-        # Attributes for this message. If this field is empty, the message must contain
-        # non-empty data. This can be used to filter messages on the subscription.
+        # Optional. Attributes for this message. If this field is empty, the message
+        # must contain non-empty data. This can be used to filter messages on the
+        # subscription.
         # Corresponds to the JSON property `attributes`
         # @return [Hash<String,String>]
         attr_accessor :attributes
-        # The message data field. If this field is empty, the message must contain at
-        # least one attribute.
+        # Optional. The message data field. If this field is empty, the message must
+        # contain at least one attribute.
         # Corresponds to the JSON property `data`
         # NOTE: Values are automatically base64 encoded/decoded in the client library.
         # @return [String]
         attr_accessor :data
-        # ID of this message, assigned by the server when the message is published.
-        # Guaranteed to be unique within the topic. This value may be read by a
-        # subscriber that receives a `PubsubMessage` via a `Pull` call or a push
+        # Optional. ID of this message, assigned by the server when the message is
+        # published. Guaranteed to be unique within the topic. This value may be read by
+        # a subscriber that receives a `PubsubMessage` via a `Pull` call or a push
         # delivery. It must not be populated by the publisher in a `Publish` call.
         # Corresponds to the JSON property `messageId`
         # @return [String]
         attr_accessor :message_id
-        # If non-empty, identifies related messages for which publish order should be
-        # respected. If a `Subscription` has `enable_message_ordering` set to `true`,
-        # messages published with the same non-empty `ordering_key` value will be
+        # Optional. If non-empty, identifies related messages for which publish order
+        # should be respected. If a `Subscription` has `enable_message_ordering` set to `
+        # true`, messages published with the same non-empty `ordering_key` value will be
         # delivered to subscribers in the order in which they are received by the Pub/
         # Sub system. All `PubsubMessage`s published in a given `PublishRequest` must
         # specify the same `ordering_key` value. For more information, see [ordering
@@ -953,9 +956,9 @@ module Google
         # @return [String]
         attr_accessor :ordering_key
-        # The time at which the message was published, populated by the server when it
-        # receives the `Publish` call. It must not be populated by the publisher in a `
-        # Publish` call.
+        # Optional. The time at which the message was published, populated by the server
+        # when it receives the `Publish` call. It must not be populated by the publisher
+        # in a `Publish` call.
         # Corresponds to the JSON property `publishTime`
         # @return [String]
         attr_accessor :publish_time
@@ -1027,11 +1030,11 @@ module Google
       class PullResponse
         include Google::Apis::Core::Hashable
-        # Received Pub/Sub messages. The list will be empty if there are no more
-        # messages available in the backlog, or if no messages could be returned before
-        # the request timeout. For JSON, the response can be entirely empty. The Pub/Sub
-        # system may return fewer than the `maxMessages` requested even if there are
-        # more messages available in the backlog.
+        # Optional. Received Pub/Sub messages. The list will be empty if there are no
+        # more messages available in the backlog, or if no messages could be returned
+        # before the request timeout. For JSON, the response can be entirely empty. The
+        # Pub/Sub system may return fewer than the `maxMessages` requested even if there
+        # are more messages available in the backlog.
         # Corresponds to the JSON property `receivedMessages`
         # @return [Array<Google::Apis::PubsubV1::ReceivedMessage>]
         attr_accessor :received_messages
@@ -1050,19 +1053,19 @@ module Google
       class PushConfig
         include Google::Apis::Core::Hashable
-        # Endpoint configuration attributes that can be used to control different
-        # aspects of the message delivery. The only currently supported attribute is `x-
-        # goog-version`, which you can use to change the format of the pushed message.
-        # This attribute indicates the version of the data expected by the endpoint.
-        # This controls the shape of the pushed message (i.e., its fields and metadata).
-        # If not present during the `CreateSubscription` call, it will default to the
-        # version of the Pub/Sub API used to make such call. If not present in a `
-        # ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls
-        # will always return a valid version, even if the subscription was created
-        # without this attribute. The only supported values for the `x-goog-version`
-        # attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/
-        # Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub
-        # API. For example: `attributes ` "x-goog-version": "v1" ``
+        # Optional. Endpoint configuration attributes that can be used to control
+        # different aspects of the message delivery. The only currently supported
+        # attribute is `x-goog-version`, which you can use to change the format of the
+        # pushed message. This attribute indicates the version of the data expected by
+        # the endpoint. This controls the shape of the pushed message (i.e., its fields
+        # and metadata). If not present during the `CreateSubscription` call, it will
+        # default to the version of the Pub/Sub API used to make such call. If not
+        # present in a `ModifyPushConfig` call, its value will not be changed. `
+        # GetSubscription` calls will always return a valid version, even if the
+        # subscription was created without this attribute. The only supported values for
+        # the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined
+        # in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined
+        # in the v1 Pub/Sub API. For example: `attributes ` "x-goog-version": "v1" ``
         # Corresponds to the JSON property `attributes`
         # @return [Hash<String,String>]
         attr_accessor :attributes
@@ -1085,8 +1088,8 @@ module Google
         # @return [Google::Apis::PubsubV1::PubsubWrapper]
         attr_accessor :pubsub_wrapper
-        # A URL locating the endpoint to which messages should be pushed. For example, a
-        # Webhook endpoint might use `https://example.com/push`.
+        # Optional. A URL locating the endpoint to which messages should be pushed. For
+        # example, a Webhook endpoint might use `https://example.com/push`.
         # Corresponds to the JSON property `pushEndpoint`
         # @return [String]
         attr_accessor :push_endpoint
@@ -1109,16 +1112,16 @@ module Google
       class ReceivedMessage
         include Google::Apis::Core::Hashable
-        # This ID can be used to acknowledge the received message.
+        # Optional. This ID can be used to acknowledge the received message.
         # Corresponds to the JSON property `ackId`
         # @return [String]
         attr_accessor :ack_id
-        # The approximate number of times that Cloud Pub/Sub has attempted to deliver
-        # the associated message to a subscriber. More precisely, this is 1 + (number of
-        # NACKs) + (number of ack_deadline exceeds) for this message. A NACK is any call
-        # to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is
-        # whenever a message is not acknowledged within ack_deadline. Note that
+        # Optional. The approximate number of times that Pub/Sub has attempted to
+        # deliver the associated message to a subscriber. More precisely, this is 1 + (
+        # number of NACKs) + (number of ack_deadline exceeds) for this message. A NACK
+        # is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds
+        # event is whenever a message is not acknowledged within ack_deadline. Note that
         # ack_deadline is initially Subscription.ackDeadlineSeconds, but may get
         # extended automatically by the client library. Upon the first delivery of a
         # given message, `delivery_attempt` will have a value of 1. The value is
@@ -1151,24 +1154,24 @@ module Google
         end
       end
-      # A policy that specifies how Cloud Pub/Sub retries message delivery. Retry
-      # delay will be exponential based on provided minimum and maximum backoffs.
-      # https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be
-      # triggered on NACKs or acknowledgement deadline exceeded events for a given
-      # message. Retry Policy is implemented on a best effort basis. At times, the
-      # delay between consecutive deliveries may not match the configuration. That is,
-      # delay can be more or less than configured backoff.
+      # A policy that specifies how Pub/Sub retries message delivery. Retry delay will
+      # be exponential based on provided minimum and maximum backoffs. https://en.
+      # wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs
+      # or acknowledgement deadline exceeded events for a given message. Retry Policy
+      # is implemented on a best effort basis. At times, the delay between consecutive
+      # deliveries may not match the configuration. That is, delay can be more or less
+      # than configured backoff.
       class RetryPolicy
         include Google::Apis::Core::Hashable
-        # The maximum delay between consecutive deliveries of a given message. Value
-        # should be between 0 and 600 seconds. Defaults to 600 seconds.
+        # Optional. The maximum delay between consecutive deliveries of a given message.
+        # Value should be between 0 and 600 seconds. Defaults to 600 seconds.
         # Corresponds to the JSON property `maximumBackoff`
         # @return [String]
         attr_accessor :maximum_backoff
-        # The minimum delay between consecutive deliveries of a given message. Value
-        # should be between 0 and 600 seconds. Defaults to 10 seconds.
+        # Optional. The minimum delay between consecutive deliveries of a given message.
+        # Value should be between 0 and 600 seconds. Defaults to 10 seconds.
         # Corresponds to the JSON property `minimumBackoff`
         # @return [String]
         attr_accessor :minimum_backoff
@@ -1253,21 +1256,21 @@ module Google
       class SchemaSettings
         include Google::Apis::Core::Hashable
-        # The encoding of messages validated against `schema`.
+        # Optional. The encoding of messages validated against `schema`.
         # Corresponds to the JSON property `encoding`
         # @return [String]
         attr_accessor :encoding
-        # The minimum (inclusive) revision allowed for validating messages. If empty or
-        # not present, allow any revision to be validated against last_revision or any
-        # revision created before.
+        # Optional. The minimum (inclusive) revision allowed for validating messages. If
+        # empty or not present, allow any revision to be validated against last_revision
+        # or any revision created before.
         # Corresponds to the JSON property `firstRevisionId`
         # @return [String]
         attr_accessor :first_revision_id
-        # The maximum (inclusive) revision allowed for validating messages. If empty or
-        # not present, allow any revision to be validated against first_revision or any
-        # revision created after.
+        # Optional. The maximum (inclusive) revision allowed for validating messages. If
+        # empty or not present, allow any revision to be validated against
+        # first_revision or any revision created after.
         # Corresponds to the JSON property `lastRevisionId`
         # @return [String]
         attr_accessor :last_revision_id
@@ -1296,21 +1299,23 @@ module Google
       class SeekRequest
         include Google::Apis::Core::Hashable
-        # The snapshot to seek to. The snapshot's topic must be the same as that of the
-        # provided subscription. Format is `projects/`project`/snapshots/`snap``.
+        # Optional. The snapshot to seek to. The snapshot's topic must be the same as
+        # that of the provided subscription. Format is `projects/`project`/snapshots/`
+        # snap``.
         # Corresponds to the JSON property `snapshot`
         # @return [String]
         attr_accessor :snapshot
-        # The time to seek to. Messages retained in the subscription that were published
-        # before this time are marked as acknowledged, and messages retained in the
-        # subscription that were published after this time are marked as unacknowledged.
-        # Note that this operation affects only those messages retained in the
-        # subscription (configured by the combination of `message_retention_duration`
-        # and `retain_acked_messages`). For example, if `time` corresponds to a point
-        # before the message retention window (or to a point before the system's notion
-        # of the subscription creation time), only retained messages will be marked as
-        # unacknowledged, and already-expunged messages will not be restored.
+        # Optional. The time to seek to. Messages retained in the subscription that were
+        # published before this time are marked as acknowledged, and messages retained
+        # in the subscription that were published after this time are marked as
+        # unacknowledged. Note that this operation affects only those messages retained
+        # in the subscription (configured by the combination of `
+        # message_retention_duration` and `retain_acked_messages`). For example, if `
+        # time` corresponds to a point before the message retention window (or to a
+        # point before the system's notion of the subscription creation time), only
+        # retained messages will be marked as unacknowledged, and already-expunged
+        # messages will not be restored.
         # Corresponds to the JSON property `time`
         # @return [String]
         attr_accessor :time
@@ -1391,11 +1396,11 @@ module Google
       class Snapshot
         include Google::Apis::Core::Hashable
-        # The snapshot is guaranteed to exist up until this time. A newly-created
-        # snapshot expires no later than 7 days from the time of its creation. Its exact
-        # lifetime is determined at creation by the existing backlog in the source
-        # subscription. Specifically, the lifetime of the snapshot is `7 days - (age of
-        # oldest unacked message in the subscription)`. For example, consider a
+        # Optional. The snapshot is guaranteed to exist up until this time. A newly-
+        # created snapshot expires no later than 7 days from the time of its creation.
+        # Its exact lifetime is determined at creation by the existing backlog in the
+        # source subscription. Specifically, the lifetime of the snapshot is `7 days - (
+        # age of oldest unacked message in the subscription)`. For example, consider a
         # subscription whose oldest unacked message is 3 days old. If a snapshot is
         # created from this subscription, the snapshot -- which will always capture this
         # 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The
@@ -1405,18 +1410,18 @@ module Google
         # @return [String]
         attr_accessor :expire_time
-        # See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/
-        # labels).
+        # Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/
+        # docs/labels).
         # Corresponds to the JSON property `labels`
         # @return [Hash<String,String>]
         attr_accessor :labels
-        # The name of the snapshot.
+        # Optional. The name of the snapshot.
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
-        # The name of the topic from which this snapshot is retaining messages.
+        # Optional. The name of the topic from which this snapshot is retaining messages.
         # Corresponds to the JSON property `topic`
         # @return [String]
         attr_accessor :topic
@@ -1440,14 +1445,14 @@ module Google
       class Subscription
         include Google::Apis::Core::Hashable
-        # The approximate amount of time (on a best-effort basis) Pub/Sub waits for the
-        # subscriber to acknowledge receipt before resending the message. In the
-        # interval after the message is delivered and before it is acknowledged, it is
-        # considered to be _outstanding_. During that time period, the message will not
-        # be redelivered (on a best-effort basis). For pull subscriptions, this value is
-        # used as the initial value for the ack deadline. To override this value for a
-        # given message, call `ModifyAckDeadline` with the corresponding `ack_id` if
-        # using non-streaming pull or send the `ack_id` in a `
+        # Optional. The approximate amount of time (on a best-effort basis) Pub/Sub
+        # waits for the subscriber to acknowledge receipt before resending the message.
+        # In the interval after the message is delivered and before it is acknowledged,
+        # it is considered to be _outstanding_. During that time period, the message
+        # will not be redelivered (on a best-effort basis). For pull subscriptions, this
+        # value is used as the initial value for the ack deadline. To override this
+        # value for a given message, call `ModifyAckDeadline` with the corresponding `
+        # ack_id` if using non-streaming pull or send the `ack_id` in a `
         # StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom
         # deadline you can specify is 10 seconds. The maximum custom deadline you can
         # specify is 600 seconds (10 minutes). If this parameter is 0, a default value
@@ -1477,32 +1482,33 @@ module Google
         # @return [Google::Apis::PubsubV1::DeadLetterPolicy]
         attr_accessor :dead_letter_policy
-        # Indicates whether the subscription is detached from its topic. Detached
-        # subscriptions don't receive messages from their topic and don't retain any
-        # backlog. `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION.
-        # If the subscription is a push subscription, pushes to the endpoint will not be
-        # made.
+        # Optional. Indicates whether the subscription is detached from its topic.
+        # Detached subscriptions don't receive messages from their topic and don't
+        # retain any backlog. `Pull` and `StreamingPull` requests will return
+        # FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the
+        # endpoint will not be made.
         # Corresponds to the JSON property `detached`
         # @return [Boolean]
         attr_accessor :detached
         alias_method :detached?, :detached
-        # If true, Pub/Sub provides the following guarantees for the delivery of a
-        # message with a given value of `message_id` on this subscription: * The message
-        # sent to a subscriber is guaranteed not to be resent before the message's
-        # acknowledgement deadline expires. * An acknowledged message will not be resent
-        # to a subscriber. Note that subscribers may still receive multiple copies of a
-        # message when `enable_exactly_once_delivery` is true if the message was
-        # published multiple times by a publisher client. These copies are considered
-        # distinct by Pub/Sub and have distinct `message_id` values.
+        # Optional. If true, Pub/Sub provides the following guarantees for the delivery
+        # of a message with a given value of `message_id` on this subscription: * The
+        # message sent to a subscriber is guaranteed not to be resent before the message'
+        # s acknowledgement deadline expires. * An acknowledged message will not be
+        # resent to a subscriber. Note that subscribers may still receive multiple
+        # copies of a message when `enable_exactly_once_delivery` is true if the message
+        # was published multiple times by a publisher client. These copies are
+        # considered distinct by Pub/Sub and have distinct `message_id` values.
         # Corresponds to the JSON property `enableExactlyOnceDelivery`
         # @return [Boolean]
         attr_accessor :enable_exactly_once_delivery
         alias_method :enable_exactly_once_delivery?, :enable_exactly_once_delivery
-        # If true, messages published with the same `ordering_key` in `PubsubMessage`
-        # will be delivered to the subscribers in the order in which they are received
-        # by the Pub/Sub system. Otherwise, they may be delivered in any order.
+        # Optional. If true, messages published with the same `ordering_key` in `
+        # PubsubMessage` will be delivered to the subscribers in the order in which they
+        # are received by the Pub/Sub system. Otherwise, they may be delivered in any
+        # order.
         # Corresponds to the JSON property `enableMessageOrdering`
         # @return [Boolean]
         attr_accessor :enable_message_ordering
@@ -1514,24 +1520,24 @@ module Google
         # @return [Google::Apis::PubsubV1::ExpirationPolicy]
         attr_accessor :expiration_policy
-        # An expression written in the Pub/Sub [filter language](https://cloud.google.
-        # com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s whose `
-        # attributes` field matches the filter are delivered on this subscription. If
-        # empty, then no messages are filtered out.
+        # Optional. An expression written in the Pub/Sub [filter language](https://cloud.
+        # google.com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s
+        # whose `attributes` field matches the filter are delivered on this subscription.
+        # If empty, then no messages are filtered out.
         # Corresponds to the JSON property `filter`
         # @return [String]
         attr_accessor :filter
-        # See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels)
-        # .
+        # Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/
+        # docs/labels).
         # Corresponds to the JSON property `labels`
         # @return [Hash<String,String>]
         attr_accessor :labels
-        # How long to retain unacknowledged messages in the subscription's backlog, from
-        # the moment a message is published. If `retain_acked_messages` is true, then
-        # this also configures the retention of acknowledged messages, and thus
-        # configures how far back in time a `Seek` can be done. Defaults to 7 days.
+        # Optional. How long to retain unacknowledged messages in the subscription's
+        # backlog, from the moment a message is published. If `retain_acked_messages` is
+        # true, then this also configures the retention of acknowledged messages, and
+        # thus configures how far back in time a `Seek` can be done. Defaults to 7 days.
         # Cannot be more than 7 days or less than 10 minutes.
         # Corresponds to the JSON property `messageRetentionDuration`
         # @return [String]
@@ -1552,24 +1558,24 @@ module Google
         # @return [Google::Apis::PubsubV1::PushConfig]
         attr_accessor :push_config
-        # Indicates whether to retain acknowledged messages. If true, then messages are
-        # not expunged from the subscription's backlog, even if they are acknowledged,
-        # until they fall out of the `message_retention_duration` window. This must be
-        # true if you would like to [`Seek` to a timestamp] (https://cloud.google.com/
-        # pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-
-        # acknowledged messages.
+        # Optional. Indicates whether to retain acknowledged messages. If true, then
+        # messages are not expunged from the subscription's backlog, even if they are
+        # acknowledged, until they fall out of the `message_retention_duration` window.
+        # This must be true if you would like to [`Seek` to a timestamp] (https://cloud.
+        # google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay
+        # previously-acknowledged messages.
         # Corresponds to the JSON property `retainAckedMessages`
         # @return [Boolean]
         attr_accessor :retain_acked_messages
         alias_method :retain_acked_messages?, :retain_acked_messages
-        # A policy that specifies how Cloud Pub/Sub retries message delivery. Retry
-        # delay will be exponential based on provided minimum and maximum backoffs.
-        # https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be
-        # triggered on NACKs or acknowledgement deadline exceeded events for a given
-        # message. Retry Policy is implemented on a best effort basis. At times, the
-        # delay between consecutive deliveries may not match the configuration. That is,
-        # delay can be more or less than configured backoff.
+        # A policy that specifies how Pub/Sub retries message delivery. Retry delay will
+        # be exponential based on provided minimum and maximum backoffs. https://en.
+        # wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs
+        # or acknowledgement deadline exceeded events for a given message. Retry Policy
+        # is implemented on a best effort basis. At times, the delay between consecutive
+        # deliveries may not match the configuration. That is, delay can be more or less
+        # than configured backoff.
         # Corresponds to the JSON property `retryPolicy`
         # @return [Google::Apis::PubsubV1::RetryPolicy]
         attr_accessor :retry_policy
@@ -1682,27 +1688,27 @@ module Google
       class Topic
         include Google::Apis::Core::Hashable
-        # The resource name of the Cloud KMS CryptoKey to be used to protect access to
-        # messages published on this topic. The expected format is `projects/*/locations/
-        # */keyRings/*/cryptoKeys/*`.
+        # Optional. The resource name of the Cloud KMS CryptoKey to be used to protect
+        # access to messages published on this topic. The expected format is `projects/*/
+        # locations/*/keyRings/*/cryptoKeys/*`.
         # Corresponds to the JSON property `kmsKeyName`
         # @return [String]
         attr_accessor :kms_key_name
-        # See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/
-        # labels).
+        # Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/
+        # docs/labels).
         # Corresponds to the JSON property `labels`
         # @return [Hash<String,String>]
         attr_accessor :labels
-        # Indicates the minimum duration to retain a message after it is published to
-        # the topic. If this field is set, messages published to the topic in the last `
-        # message_retention_duration` are always available to subscribers. For instance,
-        # it allows any attached subscription to [seek to a timestamp](https://cloud.
-        # google.com/pubsub/docs/replay-overview#seek_to_a_time) that is up to `
-        # message_retention_duration` in the past. If this field is not set, message
-        # retention is controlled by settings on individual subscriptions. Cannot be
-        # more than 31 days or less than 10 minutes.
+        # Optional. Indicates the minimum duration to retain a message after it is
+        # published to the topic. If this field is set, messages published to the topic
+        # in the last `message_retention_duration` are always available to subscribers.
+        # For instance, it allows any attached subscription to [seek to a timestamp](
+        # https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) that is
+        # up to `message_retention_duration` in the past. If this field is not set,
+        # message retention is controlled by settings on individual subscriptions.
+        # Cannot be more than 31 days or less than 10 minutes.
         # Corresponds to the JSON property `messageRetentionDuration`
         # @return [String]
         attr_accessor :message_retention_duration
@@ -1721,8 +1727,8 @@ module Google
         # @return [String]
         attr_accessor :name
-        # Reserved for future use. This field is set only in responses from the server;
-        # it is ignored if it is set in any requests.
+        # Optional. Reserved for future use. This field is set only in responses from
+        # the server; it is ignored if it is set in any requests.
         # Corresponds to the JSON property `satisfiesPzs`
         # @return [Boolean]
         attr_accessor :satisfies_pzs

data/lib/google/apis/pubsub_v1/gem_version.rb CHANGED Viewed

@@ -16,13 +16,13 @@ module Google
   module Apis
     module PubsubV1
       # Version of the google-apis-pubsub_v1 gem
-      GEM_VERSION = "0.38.0"
+      GEM_VERSION = "0.39.0"
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
       # Revision of the discovery document this client was generated from
-      REVISION = "20230529"
+      REVISION = "20230620"
     end
   end
 end

data/lib/google/apis/pubsub_v1/service.rb CHANGED Viewed

@@ -707,11 +707,11 @@ module Google
         #   Required. The name of the project in which to list snapshots. Format is `
         #   projects/`project-id``.
         # @param [Fixnum] page_size
-        #   Maximum number of snapshots to return.
+        #   Optional. Maximum number of snapshots to return.
         # @param [String] page_token
-        #   The value returned by the last `ListSnapshotsResponse`; indicates that this is
-        #   a continuation of a prior `ListSnapshots` call, and that the system should
-        #   return the next page of data.
+        #   Optional. The value returned by the last `ListSnapshotsResponse`; indicates
+        #   that this is a continuation of a prior `ListSnapshots` call, and that the
+        #   system should return the next page of data.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -746,7 +746,7 @@ module Google
         # message acknowledgments in bulk. That is, you can set the acknowledgment state
         # of messages in an existing subscription to the state captured by a snapshot.
         # @param [String] name
-        #   The name of the snapshot.
+        #   Optional. The name of the snapshot.
         # @param [Google::Apis::PubsubV1::UpdateSnapshotRequest] update_snapshot_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -1087,11 +1087,11 @@ module Google
         #   Required. The name of the project in which to list subscriptions. Format is `
         #   projects/`project-id``.
         # @param [Fixnum] page_size
-        #   Maximum number of subscriptions to return.
+        #   Optional. Maximum number of subscriptions to return.
         # @param [String] page_token
-        #   The value returned by the last `ListSubscriptionsResponse`; indicates that
-        #   this is a continuation of a prior `ListSubscriptions` call, and that the
-        #   system should return the next page of data.
+        #   Optional. The value returned by the last `ListSubscriptionsResponse`;
+        #   indicates that this is a continuation of a prior `ListSubscriptions` call, and
+        #   that the system should return the next page of data.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -1539,11 +1539,11 @@ module Google
         #   Required. The name of the project in which to list topics. Format is `projects/
         #   `project-id``.
         # @param [Fixnum] page_size
-        #   Maximum number of topics to return.
+        #   Optional. Maximum number of topics to return.
         # @param [String] page_token
-        #   The value returned by the last `ListTopicsResponse`; indicates that this is a
-        #   continuation of a prior `ListTopics` call, and that the system should return
-        #   the next page of data.
+        #   Optional. The value returned by the last `ListTopicsResponse`; indicates that
+        #   this is a continuation of a prior `ListTopics` call, and that the system
+        #   should return the next page of data.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -1731,11 +1731,11 @@ module Google
         #   Required. The name of the topic that snapshots are attached to. Format is `
         #   projects/`project`/topics/`topic``.
         # @param [Fixnum] page_size
-        #   Maximum number of snapshot names to return.
+        #   Optional. Maximum number of snapshot names to return.
         # @param [String] page_token
-        #   The value returned by the last `ListTopicSnapshotsResponse`; indicates that
-        #   this is a continuation of a prior `ListTopicSnapshots` call, and that the
-        #   system should return the next page of data.
+        #   Optional. The value returned by the last `ListTopicSnapshotsResponse`;
+        #   indicates that this is a continuation of a prior `ListTopicSnapshots` call,
+        #   and that the system should return the next page of data.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -1770,11 +1770,11 @@ module Google
         #   Required. The name of the topic that subscriptions are attached to. Format is `
         #   projects/`project`/topics/`topic``.
         # @param [Fixnum] page_size
-        #   Maximum number of subscription names to return.
+        #   Optional. Maximum number of subscription names to return.
         # @param [String] page_token
-        #   The value returned by the last `ListTopicSubscriptionsResponse`; indicates
-        #   that this is a continuation of a prior `ListTopicSubscriptions` call, and that
-        #   the system should return the next page of data.
+        #   Optional. The value returned by the last `ListTopicSubscriptionsResponse`;
+        #   indicates that this is a continuation of a prior `ListTopicSubscriptions` call,
+        #   and that the system should return the next page of data.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-pubsub_v1
 version: !ruby/object:Gem::Version
-  version: 0.38.0
+  version: 0.39.0
 platform: ruby
 authors:
 - Google LLC
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-11 00:00:00.000000000 Z
+date: 2023-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-pubsub_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-pubsub_v1/v0.38.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-pubsub_v1/v0.39.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-pubsub_v1
 post_install_message:
 rdoc_options: []