lib/google/cloud/pubsub/v1/subscriber_client.rb in google-cloud-pubsub-1.3.0 vs lib/google/cloud/pubsub/v1/subscriber_client.rb in google-cloud-pubsub-1.3.1

- old
+ new

@@ -422,18 +422,18 @@ # format](https://cloud.google.com/pubsub/docs/admin#resource_names). The # generated name is populated in the returned Subscription object. Note that # for REST API requests, you must specify a name in the request. # # @param name [String] - # The name of the subscription. It must have the format + # Required. The name of the subscription. It must have the format # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must # start with a letter, and contain only letters (`[A-Za-z]`), numbers # (`[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"` + # in length, and it must not start with `"goog"`. # @param topic [String] - # The name of the topic from which this subscription is receiving messages. + # Required. The name of the topic from which this subscription is receiving messages. # Format is `projects/{project}/topics/{topic}`. # The value of this field will be `_deleted-topic_` if the topic has been # deleted. # @param push_config [Google::Cloud::PubSub::V1::PushConfig | Hash] # If push delivery is used with this subscription, this field is @@ -559,11 +559,11 @@ end # Gets the configuration details of a subscription. # # @param subscription [String] - # The name of the subscription to get. + # Required. The name of the subscription to get. # Format is `projects/{project}/subscriptions/{sub}`. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @yield [result, operation] Access the result along with the RPC operation @@ -591,15 +591,15 @@ # Updates an existing subscription. Note that certain properties of a # subscription, such as its topic, are not modifiable. # # @param subscription [Google::Cloud::PubSub::V1::Subscription | Hash] - # The updated subscription object. + # Required. The updated subscription object. # A hash of the same form as `Google::Cloud::PubSub::V1::Subscription` # can also be provided. # @param update_mask [Google::Protobuf::FieldMask | Hash] - # Indicates which fields in the provided subscription to update. + # Required. Indicates which fields in the provided subscription to update. # Must be specified and non-empty. # A hash of the same form as `Google::Protobuf::FieldMask` # can also be provided. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, @@ -634,11 +634,11 @@ end # Lists matching subscriptions. # # @param project [String] - # The name of the project in which to list subscriptions. + # Required. The name of the project in which to list subscriptions. # Format is `projects/{project-id}`. # @param page_size [Integer] # The maximum number of resources contained in the underlying API # response. If page streaming is performed per-resource, this # parameter does not affect the return value. If page streaming is @@ -693,11 +693,11 @@ # `NOT_FOUND`. After a subscription is deleted, a new one may be created with # the same name, but the new one has no association with the old # subscription or its topic unless the same topic is specified. # # @param subscription [String] - # The subscription to delete. + # Required. The subscription to delete. # Format is `projects/{project}/subscriptions/{sub}`. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @yield [result, operation] Access the result along with the RPC operation @@ -728,16 +728,16 @@ # subscriber, or to make the message available for redelivery if the # processing was interrupted. Note that this does not modify the # subscription-level `ackDeadlineSeconds` used for subsequent messages. # # @param subscription [String] - # The name of the subscription. + # Required. The name of the subscription. # Format is `projects/{project}/subscriptions/{sub}`. # @param ack_ids [Array<String>] - # List of acknowledgment IDs. + # Required. List of acknowledgment IDs. # @param ack_deadline_seconds [Integer] - # The new ack deadline with respect to the time this request was sent to + # Required. The new ack deadline with respect to the time this request was sent to # the Pub/Sub system. For example, if the value is 10, the new # ack deadline will expire 10 seconds after the `ModifyAckDeadline` call # was made. Specifying zero might immediately make the message available for # delivery to another subscriber client. This typically results in an # increase in the rate of message redeliveries (that is, duplicates). @@ -786,14 +786,14 @@ # Acknowledging a message whose ack deadline has expired may succeed, # but such a message may be redelivered later. Acknowledging a message more # than once will not result in an error. # # @param subscription [String] - # The subscription whose message is being acknowledged. + # Required. The subscription whose message is being acknowledged. # Format is `projects/{project}/subscriptions/{sub}`. # @param ack_ids [Array<String>] - # The acknowledgment ID for the messages being acknowledged that was returned + # Required. The acknowledgment ID for the messages being acknowledged that was returned # by the Pub/Sub system in the `Pull` response. Must not be empty. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @yield [result, operation] Access the result along with the RPC operation @@ -827,14 +827,14 @@ # Pulls messages from the server. The server may return `UNAVAILABLE` if # there are too many concurrent pull requests pending for the given # subscription. # # @param subscription [String] - # The subscription from which messages should be pulled. + # Required. The subscription from which messages should be pulled. # Format is `projects/{project}/subscriptions/{sub}`. # @param max_messages [Integer] - # The maximum number of messages to return for this request. Must be a + # Required. 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. @@ -923,14 +923,14 @@ # an empty `PushConfig`) or vice versa, or change the endpoint URL and other # attributes of a push subscription. Messages will accumulate for delivery # continuously through the call regardless of changes to the `PushConfig`. # # @param subscription [String] - # The name of the subscription. + # Required. The name of the subscription. # Format is `projects/{project}/subscriptions/{sub}`. # @param push_config [Google::Cloud::PubSub::V1::PushConfig | Hash] - # The push configuration for future deliveries. + # Required. The push configuration for future deliveries. # # An empty `pushConfig` indicates that the Pub/Sub system should # stop pushing messages from the given subscription and allow # messages to be pulled and acknowledged - effectively pausing # the subscription if `Pull` or `StreamingPull` is not called. @@ -973,11 +973,11 @@ # you to manage 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 project [String] - # The name of the project in which to list snapshots. + # Required. The name of the project in which to list snapshots. # Format is `projects/{project-id}`. # @param page_size [Integer] # The maximum number of resources contained in the underlying API # response. If page streaming is performed per-resource, this # parameter does not affect the return value. If page streaming is @@ -1045,18 +1045,18 @@ # format](https://cloud.google.com/pubsub/docs/admin#resource_names). The # generated name is populated in the returned Snapshot object. Note that for # REST API requests, you must specify a name in the request. # # @param name [String] - # User-provided name for this snapshot. If the name is not provided in the + # Required. User-provided name for this snapshot. If the name is not provided in the # request, the server will assign a random name for this snapshot on the same # project as the subscription. Note that for REST API requests, you must # specify a name. See the <a # href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource # name rules</a>. Format is `projects/{project}/snapshots/{snap}`. # @param subscription [String] - # The subscription whose backlog the snapshot retains. + # Required. The subscription whose backlog the snapshot retains. # Specifically, the created snapshot is guaranteed to retain: # (a) The existing backlog on the subscription. More precisely, this is # defined as the messages in the subscription's backlog that are # unacknowledged upon the successful completion of the # `CreateSnapshot` request; as well as: @@ -1103,15 +1103,15 @@ # you to manage 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 snapshot [Google::Cloud::PubSub::V1::Snapshot | Hash] - # The updated snapshot object. + # Required. The updated snapshot object. # A hash of the same form as `Google::Cloud::PubSub::V1::Snapshot` # can also be provided. # @param update_mask [Google::Protobuf::FieldMask | Hash] - # Indicates which fields in the provided snapshot to update. + # Required. Indicates which fields in the provided snapshot to update. # Must be specified and non-empty. # A hash of the same form as `Google::Protobuf::FieldMask` # can also be provided. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, @@ -1156,11 +1156,11 @@ # are immediately dropped. After a snapshot is deleted, a new one may be # created with the same name, but the new one has no association with the old # snapshot or its subscription, unless the same subscription is specified. # # @param snapshot [String] - # The name of the snapshot to delete. + # Required. The name of the snapshot to delete. # Format is `projects/{project}/snapshots/{snap}`. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @yield [result, operation] Access the result along with the RPC operation @@ -1194,11 +1194,11 @@ # acknowledgment state of messages in an existing subscription to the state # captured by a snapshot. Note that both the subscription and the snapshot # must be on the same topic. # # @param subscription [String] - # The subscription to affect. + # Required. The subscription to affect. # @param time [Google::Protobuf::Timestamp | Hash] # 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 @@ -1243,13 +1243,16 @@ }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::PubSub::V1::SeekRequest) @seek.call(req, options, &block) end - # Sets the access control policy on the specified resource. Replaces any - # existing policy. + # Sets the access control policy on the specified resource. Replaces + # any existing policy. # + # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and + # PERMISSION_DENIED + # # @param resource [String] # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. # @param policy [Google::Iam::V1::Policy | Hash] # REQUIRED: The complete policy to be applied to the `resource`. The size of @@ -1287,13 +1290,12 @@ }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Iam::V1::SetIamPolicyRequest) @set_iam_policy.call(req, options, &block) end - # Gets the access control policy for a resource. - # Returns an empty policy if the resource exists and does not have a policy - # set. + # Gets the access control policy for a resource. Returns an empty policy + # if the resource exists and does not have a policy set. # # @param resource [String] # REQUIRED: The resource for which the policy is being requested. # See the operation documentation for the appropriate value for this field. # @param options_ [Google::Iam::V1::GetPolicyOptions | Hash] @@ -1327,16 +1329,16 @@ }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Iam::V1::GetIamPolicyRequest) @get_iam_policy.call(req, options, &block) end - # Returns permissions that a caller has on the specified resource. - # If the resource does not exist, this will return an empty set of + # Returns permissions that a caller has on the specified resource. If the + # resource does not exist, this will return an empty set of # permissions, not a NOT_FOUND error. # - # Note: This operation is designed to be used for building permission-aware - # UIs and command-line tools, not for authorization checking. This operation - # may "fail open" without warning. + # Note: This operation is designed to be used for building + # permission-aware UIs and command-line tools, not for authorization + # checking. This operation may "fail open" without warning. # # @param resource [String] # REQUIRED: The resource for which the policy detail is being requested. # See the operation documentation for the appropriate value for this field. # @param permissions [Array<String>]