google-cloud-pubsub 0.32.2 → 0.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02df7490b94ade13d3c63495002c52b2d207eea1c607a3043b2610a0f4bc285f
-  data.tar.gz: 1386f2606152b290a445e1d7e9869da0d7cfc2d59bb3b9b2baf720a229a45e2a
+  metadata.gz: b01f6b6652fd9e503c9f9b515152ce1cc9aef8fc8516fc4831894b2fe3b74e98
+  data.tar.gz: b588531371dd2bfee17f06377a0c63496737d9ad803027d4ef6293c6366d685b
 SHA512:
-  metadata.gz: 99ff80e29fa39ae47633ab1dcfd82a141825833cbb38329ee8b827fdb17006fd80e988c71075cdcd563a04336283f8ba7b2e9dc6d3d50346abf36d217d6cc654
-  data.tar.gz: 891c467d54a0355228b3108d096b4e220702c1ec4bfb393f83b5e2c878c616d378999e442ba80948fed1af4cc91c64bd431e757cc1b415368901cbb6836c6208
+  metadata.gz: 2114333eba63efe69ef02805271651a8a02301df0512788358ef58ebf97eefc94d67eb09c6842e96c6a0568f3718093ba363ba5b0052bd4e5dc8d536a877a090
+  data.tar.gz: 22d09f6ff60fe999bab76b6fcb5ae621eccf491ee090a762d54bf20b2b2cb2832867a439ce4c2be473f2a14da87b0ad42f714fe9574da6b68f0aab1aa6d3edba

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Release History
 
+### 0.33.0 / 2018-09-20
+
+* Add support for user labels to Snapshot, Subscription and Topic.
+* Update documentation.
+  * Change documentation URL to googleapis GitHub org.
+* Fix circular require warning.
+
 ### 0.32.2 / 2018-09-12
 
 * Add missing documentation files to package.

data/LOGGING.md

@@ -5,7 +5,7 @@ To enable logging for this library, set the logger for the underlying
 that you set may be a Ruby stdlib
 [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as
 shown below, or a
-[`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/Google/Cloud/Logging/Logger)
+[`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/Google/Cloud/Logging/Logger)
 that will write logs to [Stackdriver
 Logging](https://cloud.google.com/logging/). See
 [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)

data/lib/google-cloud-pubsub.rb

@@ -20,7 +20,7 @@
 
 
 gem "google-cloud-core"
-require "google/cloud"
+require "google/cloud" unless defined? Google::Cloud.new
 require "google/cloud/config"
 require "googleauth"
 

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

@@ -163,6 +163,14 @@ module Google
         # Creates a new topic.
         #
         # @param [String] topic_name Name of a topic.
+        # @param [Hash] labels A hash of user-provided labels associated with
+        #   the topic. You can use these to organize and group your topics.
+        #   Label keys and values can be no longer than 63 characters, can only
+        #   contain lowercase letters, numeric characters, underscores and
+        #   dashes. International characters are allowed. Label values are
+        #   optional. Label keys must start with a letter and each label in the
+        #   list must have a different key. See [Creating and Managing
+        #   Labels](https://cloud.google.com/pubsub/docs/labels).
         # @param [Hash] async A hash of values to configure the topic's
         #   {AsyncPublisher} that is created when {Topic#publish_async}
         #   is called. Optional.
@@ -191,9 +199,9 @@ module Google
         #   pubsub = Google::Cloud::Pubsub.new
         #   topic = pubsub.create_topic "my-topic"
         #
-        def create_topic topic_name, async: nil
+        def create_topic topic_name, labels: nil, async: nil
           ensure_service!
-          grpc = service.create_topic topic_name
+          grpc = service.create_topic topic_name, labels: labels
           Topic.from_grpc grpc, service, async: async
         end
         alias new_topic create_topic

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

@@ -123,13 +123,22 @@ module Google
 
         ##
         # Creates the given topic with the given name.
-        def create_topic topic_name, options = {}
+        def create_topic topic_name, labels: nil, options: {}
           execute do
             publisher.create_topic topic_path(topic_name, options),
+                                   labels: labels,
                                    options: default_options
           end
         end
 
+        def update_topic topic_obj, *fields
+          mask = Google::Protobuf::FieldMask.new paths: fields.map(&:to_s)
+          execute do
+            publisher.update_topic \
+              topic_obj, mask, options: default_options
+          end
+        end
+
         ##
         # Deletes the topic with the given name. All subscriptions to this topic
         # are also deleted. Raises GRPC status code 5 if the topic does not
@@ -213,6 +222,7 @@ module Google
           deadline = options[:deadline]
           retain_acked = options[:retain_acked]
           mrd = Convert.number_to_duration options[:retention]
+          labels = options[:labels]
 
           execute do
             subscriber.create_subscription name,
@@ -221,6 +231,7 @@ module Google
                                            ack_deadline_seconds: deadline,
                                            retain_acked_messages: retain_acked,
                                            message_retention_duration: mrd,
+                                           labels: labels,
                                            options: default_options
           end
         end
@@ -320,15 +331,24 @@ module Google
 
         ##
         # Creates a snapshot on a given subscription.
-        def create_snapshot subscription, snapshot_name
+        def create_snapshot subscription, snapshot_name, labels: nil
           name = snapshot_path snapshot_name
           execute do
             subscriber.create_snapshot name,
                                        subscription_path(subscription),
+                                       labels: labels,
                                        options: default_options
           end
         end
 
+        def update_snapshot snapshot_obj, *fields
+          mask = Google::Protobuf::FieldMask.new paths: fields.map(&:to_s)
+          execute do
+            subscriber.update_snapshot \
+              snapshot_obj, mask, options: default_options
+          end
+        end
+
         ##
         # Deletes an existing snapshot.
         # All pending messages in the snapshot are immediately dropped.

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

@@ -110,6 +110,41 @@ module Google
           self.class.timestamp_from_grpc @grpc.expire_time
         end
 
+        ##
+        # A hash of user-provided labels associated with this snapshot.
+        # Labels can be used to organize and group snapshots.See [Creating and
+        # Managing Labels](https://cloud.google.com/pubsub/docs/labels).
+        #
+        # The returned hash is frozen and changes are not allowed. Use
+        # {#labels=} to update the labels for this snapshot.
+        #
+        # @return [Hash] The frozen labels hash.
+        #
+        def labels
+          @grpc.labels.to_h.freeze
+        end
+
+        ##
+        # Sets the hash of user-provided labels associated with this
+        # snapshot. Labels can be used to organize and group snapshots.
+        # Label keys and values can be no longer than 63 characters, can only
+        # contain lowercase letters, numeric characters, underscores and dashes.
+        # International characters are allowed. Label values are optional. Label
+        # keys must start with a letter and each label in the list must have a
+        # different key. See [Creating and Managing
+        # Labels](https://cloud.google.com/pubsub/docs/labels).
+        #
+        # @param [Hash] new_labels The new labels hash.
+        #
+        def labels= new_labels
+          raise ArgumentError, "Value must be a Hash" if new_labels.nil?
+          labels_map = Google::Protobuf::Map.new(:string, :string)
+          Hash(new_labels).each { |k, v| labels_map[String(k)] = String(v) }
+          update_grpc = @grpc.dup
+          update_grpc.labels = labels_map
+          @grpc = service.update_snapshot update_grpc, :labels
+        end
+
         ##
         # Removes an existing snapshot. All messages retained in the snapshot
         # are immediately dropped. After a snapshot is deleted, a new one may be

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

@@ -174,6 +174,42 @@ module Google
           )
         end
 
+        ##
+        # A hash of user-provided labels associated with this subscription.
+        # Labels can be used to organize and group subscriptions.See [Creating
+        # and Managing Labels](https://cloud.google.com/pubsub/docs/labels).
+        #
+        # The returned hash is frozen and changes are not allowed. Use
+        # {#labels=} to update the labels for this subscription.
+        #
+        # @return [Hash] The frozen labels hash.
+        #
+        def labels
+          @grpc.labels.to_h.freeze
+        end
+
+        ##
+        # Sets the hash of user-provided labels associated with this
+        # subscription. Labels can be used to organize and group subscriptions.
+        # Label keys and values can be no longer than 63 characters, can only
+        # contain lowercase letters, numeric characters, underscores and dashes.
+        # International characters are allowed. Label values are optional. Label
+        # keys must start with a letter and each label in the list must have a
+        # different key. See [Creating and Managing
+        # Labels](https://cloud.google.com/pubsub/docs/labels).
+        #
+        # @param [Hash] new_labels The new labels hash.
+        #
+        def labels= new_labels
+          raise ArgumentError, "Value must be a Hash" if new_labels.nil?
+          labels_map = Google::Protobuf::Map.new(:string, :string)
+          Hash(new_labels).each { |k, v| labels_map[String(k)] = String(v) }
+          update_grpc = @grpc.dup
+          update_grpc.labels = labels_map
+          @grpc = service.update_subscription update_grpc, :labels
+          @lazy = nil
+        end
+
         ##
         # Determines whether the subscription exists in the Pub/Sub service.
         #
@@ -484,6 +520,14 @@ module Google
         #   ([0-9], dashes (-), underscores (_), periods (.), tildes (~), plus
         #   (+) or percent signs (%). It must be between 3 and 255 characters in
         #   length, and it must not start with "goog". Optional.
+        # @param [Hash] labels A hash of user-provided labels associated with
+        #   the snapshot. You can use these to organize and group your
+        #   snapshots. Label keys and values can be no longer than 63
+        #   characters, can only contain lowercase letters, numeric characters,
+        #   underscores and dashes. International characters are allowed. Label
+        #   values are optional. Label keys must start with a letter and each
+        #   label in the list must have a different key. See [Creating and
+        #   Managing Labels](https://cloud.google.com/pubsub/docs/labels).
         #
         # @return [Google::Cloud::Pubsub::Snapshot]
         #
@@ -505,9 +549,9 @@ module Google
         #   snapshot = sub.create_snapshot
         #   snapshot.name #=> "projects/my-project/snapshots/gcr-analysis-..."
         #
-        def create_snapshot snapshot_name = nil
+        def create_snapshot snapshot_name = nil, labels: nil
           ensure_service!
-          grpc = service.create_snapshot name, snapshot_name
+          grpc = service.create_snapshot name, snapshot_name, labels: labels
           Snapshot.from_grpc grpc, service
         end
         alias new_snapshot create_snapshot

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

@@ -28,6 +28,8 @@ module Google
       #
       # A named resource to which messages are published.
       #
+      # See {Project#create_topic} and {Project#topic}.
+      #
       # @example
       #   require "google/cloud/pubsub"
       #
@@ -84,10 +86,49 @@ module Google
         ##
         # The name of the topic in the form of
         # "/projects/project-identifier/topics/topic-name".
+        #
+        # @return [String]
+        #
         def name
           @grpc.name
         end
 
+        ##
+        # A hash of user-provided labels associated with this topic. Labels can
+        # be used to organize and group topics. See [Creating and Managing
+        # Labels](https://cloud.google.com/pubsub/docs/labels).
+        #
+        # The returned hash is frozen and changes are not allowed. Use
+        # {#labels=} to update the labels for this topic.
+        #
+        # @return [Hash] The frozen labels hash.
+        #
+        def labels
+          @grpc.labels.to_h.freeze
+        end
+
+        ##
+        # Sets the hash of user-provided labels associated with this
+        # topic. Labels can be used to organize and group topics.
+        # Label keys and values can be no longer than 63 characters, can only
+        # contain lowercase letters, numeric characters, underscores and dashes.
+        # International characters are allowed. Label values are optional. Label
+        # keys must start with a letter and each label in the list must have a
+        # different key. See [Creating and Managing
+        # Labels](https://cloud.google.com/pubsub/docs/labels).
+        #
+        # @param [Hash] new_labels The new labels hash.
+        #
+        def labels= new_labels
+          raise ArgumentError, "Value must be a Hash" if new_labels.nil?
+          labels_map = Google::Protobuf::Map.new(:string, :string)
+          Hash(new_labels).each { |k, v| labels_map[String(k)] = String(v) }
+          update_grpc = @grpc.dup
+          update_grpc.labels = labels_map
+          @grpc = service.update_topic update_grpc, :labels
+          @lazy = nil
+        end
+
         ##
         # Permanently deletes the topic.
         #
@@ -131,6 +172,14 @@ module Google
         #   Default is 604,800 seconds (7 days).
         # @param [String] endpoint A URL locating the endpoint to which messages
         #   should be pushed.
+        # @param [Hash] labels A hash of user-provided labels associated with
+        #   the subscription. You can use these to organize and group your
+        #   subscriptions. Label keys and values can be no longer than 63
+        #   characters, can only contain lowercase letters, numeric characters,
+        #   underscores and dashes. International characters are allowed. Label
+        #   values are optional. Label keys must start with a letter and each
+        #   label in the list must have a different key. See [Creating and
+        #   Managing Labels](https://cloud.google.com/pubsub/docs/labels).
         #
         # @return [Google::Cloud::Pubsub::Subscription]
         #
@@ -154,10 +203,10 @@ module Google
         #                         endpoint: "https://example.com/push"
         #
         def subscribe subscription_name, deadline: nil, retain_acked: false,
-                      retention: nil, endpoint: nil
+                      retention: nil, endpoint: nil, labels: nil
           ensure_service!
           options = { deadline: deadline, retain_acked: retain_acked,
-                      retention: retention, endpoint: endpoint }
+                      retention: retention, endpoint: endpoint, labels: labels }
           grpc = service.create_subscription name, subscription_name, options
           Subscription.from_grpc grpc, service
         end

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

@@ -16,46 +16,46 @@
 module Google
   module Iam
     module V1
-      # Request message for +SetIamPolicy+ method.
+      # Request message for `SetIamPolicy` method.
       # @!attribute [rw] resource
       #   @return [String]
       #     REQUIRED: The resource for which the policy is being specified.
-      #     +resource+ is usually specified as a path. For example, a Project
-      #     resource is specified as +projects/\\{project}+.
+      #     `resource` is usually specified as a path. For example, a Project
+      #     resource is specified as `projects/{project}`.
       # @!attribute [rw] policy
       #   @return [Google::Iam::V1::Policy]
-      #     REQUIRED: The complete policy to be applied to the +resource+. The size of
+      #     REQUIRED: The complete policy to be applied to the `resource`. The size of
       #     the policy is limited to a few 10s of KB. An empty policy is a
       #     valid policy but certain Cloud Platform services (such as Projects)
       #     might reject them.
       class SetIamPolicyRequest; end
 
-      # Request message for +GetIamPolicy+ method.
+      # Request message for `GetIamPolicy` method.
       # @!attribute [rw] resource
       #   @return [String]
       #     REQUIRED: The resource for which the policy is being requested.
-      #     +resource+ is usually specified as a path. For example, a Project
-      #     resource is specified as +projects/\\{project}+.
+      #     `resource` is usually specified as a path. For example, a Project
+      #     resource is specified as `projects/{project}`.
       class GetIamPolicyRequest; end
 
-      # Request message for +TestIamPermissions+ method.
+      # Request message for `TestIamPermissions` method.
       # @!attribute [rw] resource
       #   @return [String]
       #     REQUIRED: The resource for which the policy detail is being requested.
-      #     +resource+ is usually specified as a path. For example, a Project
-      #     resource is specified as +projects/\\{project}+.
+      #     `resource` is usually specified as a path. For example, a Project
+      #     resource is specified as `projects/{project}`.
       # @!attribute [rw] permissions
       #   @return [Array<String>]
-      #     The set of permissions to check for the +resource+. Permissions with
+      #     The set of permissions to check for the `resource`. Permissions with
       #     wildcards (such as '*' or 'storage.*') are not allowed. For more
       #     information see
       #     [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
       class TestIamPermissionsRequest; end
 
-      # Response message for +TestIamPermissions+ method.
+      # Response message for `TestIamPermissions` method.
       # @!attribute [rw] permissions
       #   @return [Array<String>]
-      #     A subset of +TestPermissionsRequest.permissions+ that the caller is
+      #     A subset of `TestPermissionsRequest.permissions` that the caller is
       #     allowed.
       class TestIamPermissionsResponse; end
     end

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

@@ -20,9 +20,9 @@ module Google
       # specify access control policies for Cloud Platform resources.
       #
       #
-      # A +Policy+ consists of a list of +bindings+. A +Binding+ binds a list of
-      # +members+ to a +role+, where the members can be user accounts, Google groups,
-      # Google domains, and service accounts. A +role+ is a named list of permissions
+      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
+      # `members` to a `role`, where the members can be user accounts, Google groups,
+      # Google domains, and service accounts. A `role` is a named list of permissions
       # defined by IAM.
       #
       # **Example**
@@ -49,55 +49,55 @@ module Google
       # [IAM developer's guide](https://cloud.google.com/iam).
       # @!attribute [rw] version
       #   @return [Integer]
-      #     Version of the +Policy+. The default version is 0.
+      #     Version of the `Policy`. The default version is 0.
       # @!attribute [rw] bindings
       #   @return [Array<Google::Iam::V1::Binding>]
-      #     Associates a list of +members+ to a +role+.
-      #     Multiple +bindings+ must not be specified for the same +role+.
-      #     +bindings+ with no members will result in an error.
+      #     Associates a list of `members` to a `role`.
+      #     Multiple `bindings` must not be specified for the same `role`.
+      #     `bindings` with no members will result in an error.
       # @!attribute [rw] etag
       #   @return [String]
-      #     +etag+ is used for optimistic concurrency control as a way to help
+      #     `etag` is used for optimistic concurrency control as a way to help
       #     prevent simultaneous updates of a policy from overwriting each other.
-      #     It is strongly suggested that systems make use of the +etag+ in the
+      #     It is strongly suggested that systems make use of the `etag` in the
       #     read-modify-write cycle to perform policy updates in order to avoid race
-      #     conditions: An +etag+ is returned in the response to +getIamPolicy+, and
-      #     systems are expected to put that etag in the request to +setIamPolicy+ to
+      #     conditions: An `etag` is returned in the response to `getIamPolicy`, and
+      #     systems are expected to put that etag in the request to `setIamPolicy` to
       #     ensure that their change will be applied to the same version of the policy.
       #
-      #     If no +etag+ is provided in the call to +setIamPolicy+, then the existing
+      #     If no `etag` is provided in the call to `setIamPolicy`, then the existing
       #     policy is overwritten blindly.
       class Policy; end
 
-      # Associates +members+ with a +role+.
+      # Associates `members` with a `role`.
       # @!attribute [rw] role
       #   @return [String]
-      #     Role that is assigned to +members+.
-      #     For example, +roles/viewer+, +roles/editor+, or +roles/owner+.
+      #     Role that is assigned to `members`.
+      #     For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
       #     Required
       # @!attribute [rw] members
       #   @return [Array<String>]
       #     Specifies the identities requesting access for a Cloud Platform resource.
-      #     +members+ can have the following values:
+      #     `members` can have the following values:
       #
-      #     * +allUsers+: A special identifier that represents anyone who is
+      #     * `allUsers`: A special identifier that represents anyone who is
       #       on the internet; with or without a Google account.
       #
-      #     * +allAuthenticatedUsers+: A special identifier that represents anyone
+      #     * `allAuthenticatedUsers`: A special identifier that represents anyone
       #       who is authenticated with a Google account or a service account.
       #
-      #     * +user:\\{emailid}+: An email address that represents a specific Google
-      #       account. For example, +alice@gmail.com+ or +joe@example.com+.
+      #     * `user:{emailid}`: An email address that represents a specific Google
+      #       account. For example, `alice@gmail.com` or `joe@example.com`.
       #
       #
-      #     * +serviceAccount:\\{emailid}+: An email address that represents a service
-      #       account. For example, +my-other-app@appspot.gserviceaccount.com+.
+      #     * `serviceAccount:{emailid}`: An email address that represents a service
+      #       account. For example, `my-other-app@appspot.gserviceaccount.com`.
       #
-      #     * +group:\\{emailid}+: An email address that represents a Google group.
-      #       For example, +admins@example.com+.
+      #     * `group:{emailid}`: An email address that represents a Google group.
+      #       For example, `admins@example.com`.
       #
-      #     * +domain:\\{domain}+: A Google Apps domain name that represents all the
-      #       users of that domain. For example, +google.com+ or +example.com+.
+      #     * `domain:{domain}`: A Google Apps domain name that represents all the
+      #       users of that domain. For example, `google.com` or `example.com`.
       class Binding; end
 
       # The difference delta between two policies.
@@ -114,8 +114,8 @@ module Google
       #     Required
       # @!attribute [rw] role
       #   @return [String]
-      #     Role that is assigned to +members+.
-      #     For example, +roles/viewer+, +roles/editor+, or +roles/owner+.
+      #     Role that is assigned to `members`.
+      #     For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
       #     Required
       # @!attribute [rw] member
       #   @return [String]