notification.rb in google-cloud-storage-1.13.1

- old
+ new

@@ -76,30 +76,42 @@
         end
 
         ##
         # The kind of item this is.
         # For notifications, this is always storage#notification.
+        #
+        # @return [String]
+        #
         def kind
           @gapi.kind
         end
 
         ##
         # The ID of the notification.
+        #
+        # @return [String]
+        #
         def id
           @gapi.id
         end
 
         ##
         # A URL that can be used to access the notification using the REST API.
+        #
+        # @return [String]
+        #
         def api_url
           @gapi.self_link
         end
 
         ##
         # The custom attributes of this notification. An optional list of
         # additional attributes to attach to each Cloud Pub/Sub message
         # published for this notification subscription.
+        #
+        # @return [Hash(String => String)]
+        #
         def custom_attrs
           @gapi.custom_attributes
         end
 
         ##
@@ -131,19 +143,23 @@
         # Important: Additional event types may be released later. Client code
         # should either safely ignore unrecognized event types, or else
         # explicitly specify in their notification configuration which event
         # types they are prepared to accept.
         #
+        # @return [Array<String>]
+        #
         def event_types
           @gapi.event_types
         end
 
         ##
         # The file name prefix of this notification. If present, only apply
         # this notification configuration to file names that begin with this
         # prefix.
         #
+        # @return [String]
+        #
         def prefix
           @gapi.object_name_prefix
         end
 
         ##
@@ -154,17 +170,22 @@
         #   [resource
         #   representation](https://cloud.google.com/storage/docs/json_api/v1/objects#resource-representations)
         #   of the file's metadata.
         # * `NONE` - No payload is included with the notification.
         #
+        # @return [String]
+        #
         def payload
           @gapi.payload_format
         end
 
         ##
         # The Cloud Pub/Sub topic to which this subscription publishes.
         # Formatted as:
         # `//pubsub.googleapis.com/projects/{project-id}/topics/{my-topic}`
+        #
+        # @return [String]
+        #
         def topic
           @gapi.topic
         end
 
         ##