google-cloud-pubsub 0.38.1 → 0.39.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f651d0f3a5709a23fe001543fdc0c362b1b125e9641cfb86464724e84318b744
-  data.tar.gz: 9d95824382157ffeb3e42148b6504c5915d6a92feea9882fde9cad7208cc53ce
+  metadata.gz: d0fd7553d4bbada28a7a6f4059d46e4251e822133d17cb083a04b227baf644f8
+  data.tar.gz: 5533102d2f2f9ed27165c194a611d80dfa33c434cdeb28b99a07aaeb715a3e23
 SHA512:
-  metadata.gz: 9ae5641b74e9ec7277645ca7ef401613c7a3347f590ecea6994a67ced0562bfd0b5dee1928acd2ecbeacbae937b7bc09419f6f5878f8157f884414411f0d52c4
-  data.tar.gz: 5d2f57bb4eb865e8f876b5e6ec5468550058de0a58a17c5bacbd392aee4f2200119758d26c26743dccadc9515d5cc069abca9796153c1b22e24baad011efca8b
+  metadata.gz: ce65f101dc44c8d4abb96a5c3762f55935d1bf47ad0171309f7109b66c4367e466eb0fbb7ef1341202520a1b7723b327a3764476d495976d6a644ad714679482
+  data.tar.gz: 40c1f20213de5af4108305b8cbdb6849bdeb3101f2cfad12a595ef9daae1297b529d318bf0bb3c7f2e898705b59c663374857fde9902e9558cd23d3b17611fc5

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release History
 
+### 0.39.0 / 2019-08-23
+
+#### Features
+
+* Add Dead Letter Policy to low-level API
+  * Add Google::Cloud::PubSub::V1::Subscription#dead_letter_policy
+  * Add Google::Cloud::PubSub::V1::DeadLetterPolicy class
+
+#### Documentation
+
+* Update documentation
+
 ### 0.38.1 / 2019-08-02
 
 * Add endpoint argument to constructor

data/lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb

@@ -19,12 +19,11 @@ module Google
     module V1
       # @!attribute [rw] allowed_persistence_regions
       #   @return [Array<String>]
-      #     The list of GCP region IDs where messages that are published to the topic
+      #     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 indicates a
-      #     misconfiguration at the project or organization level, which will result in
-      #     all Publish operations failing.
+      #     routed for storage in one of the allowed regions. An empty list means that
+      #     no regions are allowed, and is not a valid configuration.
       class MessageStoragePolicy; end
 
       # A topic resource.
@@ -42,21 +41,15 @@ module Google
       #     managing labels</a>.
       # @!attribute [rw] message_storage_policy
       #   @return [Google::Cloud::PubSub::V1::MessageStoragePolicy]
-      #     Policy constraining how messages published to the topic may be stored. It
-      #     is determined when the topic is created based on the policy configured at
-      #     the project level. It must not be set by the caller in the request to
-      #     CreateTopic or to UpdateTopic. This field will be populated in the
-      #     responses for GetTopic, CreateTopic, and UpdateTopic: if not present in the
-      #     response, then no constraints are in effect.
+      #     Policy constraining the set of Google Cloud Platform regions where messages
+      #     published to the topic may be stored. If not present, then no constraints
+      #     are in effect.
       # @!attribute [rw] kms_key_name
       #   @return [String]
       #     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/*`.
-      #     <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
-      #     API might be changed in backward-incompatible ways and is not recommended
-      #     for production use. It is not subject to any SLA or deprecation policy.
       class Topic; end
 
       # A message that is published by publishers and consumed by subscribers. The
@@ -298,8 +291,54 @@ module Google
       #     operations on the subscription. If `expiration_policy` is not set, a
       #     *default policy* with `ttl` of 31 days will be used. The minimum allowed
       #     value for `expiration_policy.ttl` is 1 day.
+      # @!attribute [rw] dead_letter_policy
+      #   @return [Google::Cloud::PubSub::V1::DeadLetterPolicy]
+      #     A policy that specifies the conditions for dead lettering messages in
+      #     this subscription. If dead_letter_policy is not set, dead lettering
+      #     is disabled.
+      #
+      #     The Cloud Pub/Sub service account associated with this subscriptions's
+      #     parent project (i.e.,
+      #     service-\\{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
+      #     permission to Acknowledge() messages on this subscription.
+      #     <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
+      #     API might be changed in backward-incompatible ways and is not recommended
+      #     for production use. It is not subject to any SLA or deprecation policy.
       class Subscription; end
 
+      # Dead lettering is done on a best effort basis. The same message might be
+      # dead lettered multiple times.
+      #
+      # If validation on any of the fields fails at subscription creation/updation,
+      # the create/update subscription request will fail.
+      # @!attribute [rw] dead_letter_topic
+      #   @return [String]
+      #     The name of the topic to which dead letter messages should be published.
+      #     Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service
+      #     account associated with the enclosing subscription's parent project (i.e.,
+      #     service-\\{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
+      #     permission to Publish() to this topic.
+      #
+      #     The operation will fail if the topic does not exist.
+      #     Users should ensure that there is a subscription attached to this topic
+      #     since messages published to a topic with no subscriptions are lost.
+      # @!attribute [rw] max_delivery_attempts
+      #   @return [Integer]
+      #     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.
+      class DeadLetterPolicy; end
+
       # A policy that specifies the conditions for resource expiration (i.e.,
       # automatic resource deletion).
       # @!attribute [rw] ttl
@@ -319,27 +358,27 @@ module Google
       #     For example, a Webhook endpoint might use "https://example.com/push".
       # @!attribute [rw] attributes
       #   @return [Hash{String => String}]
-      #     Endpoint configuration attributes.
+      #     Endpoint configuration attributes that can be used to control different
+      #     aspects of the message delivery.
       #
-      #     Every endpoint has a set of API supported attributes that can be used to
-      #     control different aspects of the message delivery.
-      #
-      #     The currently supported attribute is `x-goog-version`, which you can
+      #     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).
-      #     The endpoint version is based on the version of the Pub/Sub API.
       #
       #     If not present during the `CreateSubscription` call, it will default to
-      #     the version of the API used to make such call. If not present during a
+      #     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 possible values for this attribute are:
+      #     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:
+      #     <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
       # @!attribute [rw] oidc_token
       #   @return [Google::Cloud::PubSub::V1::PushConfig::OidcToken]
       #     If specified, Pub/Sub will generate and attach an OIDC JWT token as an
@@ -453,8 +492,9 @@ module Google
       #     least one message is available, rather than returning no messages.
       # @!attribute [rw] max_messages
       #   @return [Integer]
-      #     The maximum number of messages returned for this request. The Pub/Sub
-      #     system may return fewer than the number specified.
+      #     The maximum number of messages to return for this request. Must be a
+      #     positive integer. The Pub/Sub system may return fewer than the number
+      #     specified.
       class PullRequest; end
 
       # Response for the `Pull` method.

data/lib/google/cloud/pubsub/v1/publisher_client.rb

@@ -340,12 +340,9 @@ module Google
           #   See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
           #   managing labels</a>.
           # @param message_storage_policy [Google::Cloud::PubSub::V1::MessageStoragePolicy | Hash]
-          #   Policy constraining how messages published to the topic may be stored. It
-          #   is determined when the topic is created based on the policy configured at
-          #   the project level. It must not be set by the caller in the request to
-          #   CreateTopic or to UpdateTopic. This field will be populated in the
-          #   responses for GetTopic, CreateTopic, and UpdateTopic: if not present in the
-          #   response, then no constraints are in effect.
+          #   Policy constraining the set of Google Cloud Platform regions where messages
+          #   published to the topic may be stored. If not present, then no constraints
+          #   are in effect.
           #   A hash of the same form as `Google::Cloud::PubSub::V1::MessageStoragePolicy`
           #   can also be provided.
           # @param kms_key_name [String]
@@ -353,9 +350,6 @@ module Google
           #   to messages published on this topic.
           #
           #   The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
-          #   <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
-          #   API might be changed in backward-incompatible ways and is not recommended
-          #   for production use. It is not subject to any SLA or deprecation policy.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.

data/lib/google/cloud/pubsub/v1/subscriber_client.rb

@@ -499,6 +499,20 @@ module Google
           #   value for `expiration_policy.ttl` is 1 day.
           #   A hash of the same form as `Google::Cloud::PubSub::V1::ExpirationPolicy`
           #   can also be provided.
+          # @param dead_letter_policy [Google::Cloud::PubSub::V1::DeadLetterPolicy | Hash]
+          #   A policy that specifies the conditions for dead lettering messages in
+          #   this subscription. If dead_letter_policy is not set, dead lettering
+          #   is disabled.
+          #
+          #   The Cloud Pub/Sub service account associated with this subscriptions's
+          #   parent project (i.e.,
+          #   service-\\{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
+          #   permission to Acknowledge() messages on this subscription.
+          #   <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
+          #   API might be changed in backward-incompatible ways and is not recommended
+          #   for production use. It is not subject to any SLA or deprecation policy.
+          #   A hash of the same form as `Google::Cloud::PubSub::V1::DeadLetterPolicy`
+          #   can also be provided.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
@@ -525,6 +539,7 @@ module Google
               labels: nil,
               enable_message_ordering: nil,
               expiration_policy: nil,
+              dead_letter_policy: nil,
               options: nil,
               &block
             req = {
@@ -536,7 +551,8 @@ module Google
               message_retention_duration: message_retention_duration,
               labels: labels,
               enable_message_ordering: enable_message_ordering,
-              expiration_policy: expiration_policy
+              expiration_policy: expiration_policy,
+              dead_letter_policy: dead_letter_policy
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Cloud::PubSub::V1::Subscription)
             @create_subscription.call(req, options, &block)
@@ -816,8 +832,9 @@ module Google
           #   The subscription from which messages should be pulled.
           #   Format is `projects/{project}/subscriptions/{sub}`.
           # @param max_messages [Integer]
-          #   The maximum number of messages returned for this request. The Pub/Sub
-          #   system may return fewer than the number specified.
+          #   The maximum number of messages to return for this request. Must be a
+          #   positive integer. The Pub/Sub system may return fewer than the number
+          #   specified.
           # @param return_immediately [true, false]
           #   If this field set to true, the system will respond immediately even if
           #   it there are no messages available to return in the `Pull` response.

data/lib/google/cloud/pubsub/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module PubSub
-      VERSION = "0.38.1".freeze
+      VERSION = "0.39.0".freeze
     end
 
     Pubsub = PubSub unless const_defined? :Pubsub

data/lib/google/pubsub/v1/pubsub_pb.rb

@@ -5,7 +5,7 @@
 require 'google/protobuf'
 
 require 'google/api/annotations_pb'
-require 'google/api/resource_pb'
+require 'google/api/client_pb'
 require 'google/protobuf/duration_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
@@ -81,6 +81,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     map :labels, :string, :string, 9
     optional :enable_message_ordering, :bool, 10
     optional :expiration_policy, :message, 11, "google.pubsub.v1.ExpirationPolicy"
+    optional :dead_letter_policy, :message, 13, "google.pubsub.v1.DeadLetterPolicy"
+  end
+  add_message "google.pubsub.v1.DeadLetterPolicy" do
+    optional :dead_letter_topic, :string, 1
+    optional :max_delivery_attempts, :int32, 2
   end
   add_message "google.pubsub.v1.ExpirationPolicy" do
     optional :ttl, :message, 1, "google.protobuf.Duration"
@@ -214,6 +219,7 @@ module Google::Cloud::PubSub::V1
   ListTopicSnapshotsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.ListTopicSnapshotsResponse").msgclass
   DeleteTopicRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.DeleteTopicRequest").msgclass
   Subscription = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.Subscription").msgclass
+  DeadLetterPolicy = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.DeadLetterPolicy").msgclass
   ExpirationPolicy = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.ExpirationPolicy").msgclass
   PushConfig = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.PushConfig").msgclass
   PushConfig::OidcToken = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.PushConfig.OidcToken").msgclass

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-pubsub
 version: !ruby/object:Gem::Version
-  version: 0.38.1
+  version: 0.39.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-02 00:00:00.000000000 Z
+date: 2019-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core