class Google::Apis::PubsubV1beta2::PubsubService
Cloud Pub/Sub API
Provides reliable, many-to-many, asynchronous messaging between applications.
@example
require 'google/apis/pubsub_v1beta2' Pubsub = Google::Apis::PubsubV1beta2 # Alias the module service = Pubsub::PubsubService.new
Attributes
@return [String]
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
@return [String]
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
Public Class Methods
# File lib/google/apis/pubsub_v1beta2/service.rb, line 45 def initialize super('https://pubsub.googleapis.com/', '', client_name: 'google-apis-pubsub_v1beta2', client_version: Google::Apis::PubsubV1beta2::GEM_VERSION) @batch_path = 'batch' end
Public Instance Methods
Acknowledges the messages associated with the `ack_ids` in the ` AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. 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 [String] subscription
The subscription whose message is being acknowledged.
@param [Google::Apis::PubsubV1beta2::AcknowledgeRequest] acknowledge_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PubsubV1beta2::Empty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PubsubV1beta2::Empty]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/pubsub_v1beta2/service.rb, line 77 def acknowledge_subscription(subscription, acknowledge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+subscription}:acknowledge', options) command.request_representation = Google::Apis::PubsubV1beta2::AcknowledgeRequest::Representation command.request_object = acknowledge_request_object command.response_representation = Google::Apis::PubsubV1beta2::Empty::Representation command.response_class = Google::Apis::PubsubV1beta2::Empty command.params['subscription'] = subscription unless subscription.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns ` NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic. Note that for REST API requests, you must specify a name. @param [String] name
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"`.
@param [Google::Apis::PubsubV1beta2::Subscription] subscription_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PubsubV1beta2::Subscription] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PubsubV1beta2::Subscription]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/pubsub_v1beta2/service.rb, line 119 def create_project_subscription(name, subscription_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1beta2/{+name}', options) command.request_representation = Google::Apis::PubsubV1beta2::Subscription::Representation command.request_object = subscription_object command.response_representation = Google::Apis::PubsubV1beta2::Subscription::Representation command.response_class = Google::Apis::PubsubV1beta2::Subscription command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Creates the given topic with the given name. @param [String] name
The name of the topic. It must have the format `"projects/`project`/topics/` topic`"`. ``topic`` 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"`.
@param [Google::Apis::PubsubV1beta2::Topic] topic_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PubsubV1beta2::Topic] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PubsubV1beta2::Topic]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/pubsub_v1beta2/service.rb, line 482 def create_project_topic(name, topic_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1beta2/{+name}', options) command.request_representation = Google::Apis::PubsubV1beta2::Topic::Representation command.request_object = topic_object command.response_representation = Google::Apis::PubsubV1beta2::Topic::Representation command.response_class = Google::Apis::PubsubV1beta2::Topic command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to `Pull` after deletion will return `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 [String] subscription
The subscription to delete.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PubsubV1beta2::Empty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PubsubV1beta2::Empty]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/pubsub_v1beta2/service.rb, line 155 def delete_project_subscription(subscription, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta2/{+subscription}', options) command.response_representation = Google::Apis::PubsubV1beta2::Empty::Representation command.response_class = Google::Apis::PubsubV1beta2::Empty command.params['subscription'] = subscription unless subscription.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `deleted-topic`. @param [String] topic
Name of the topic to delete.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PubsubV1beta2::Empty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PubsubV1beta2::Empty]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/pubsub_v1beta2/service.rb, line 518 def delete_project_topic(topic, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta2/{+topic}', options) command.response_representation = Google::Apis::PubsubV1beta2::Empty::Representation command.response_class = Google::Apis::PubsubV1beta2::Empty command.params['topic'] = topic unless topic.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Gets the configuration details of a subscription. @param [String] subscription
The name of the subscription to get.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PubsubV1beta2::Subscription] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PubsubV1beta2::Subscription]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/pubsub_v1beta2/service.rb, line 185 def get_project_subscription(subscription, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+subscription}', options) command.response_representation = Google::Apis::PubsubV1beta2::Subscription::Representation command.response_class = Google::Apis::PubsubV1beta2::Subscription command.params['subscription'] = subscription unless subscription.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &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. @param [String] resource
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
@param [Fixnum] options_requested_policy_version
Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/ resource-policies).
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PubsubV1beta2::Policy] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PubsubV1beta2::Policy]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/pubsub_v1beta2/service.rb, line 225 def get_project_subscription_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+resource}:getIamPolicy', options) command.response_representation = Google::Apis::PubsubV1beta2::Policy::Representation command.response_class = Google::Apis::PubsubV1beta2::Policy command.params['resource'] = resource unless resource.nil? command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Gets the configuration of a topic. @param [String] topic
The name of the topic to get.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PubsubV1beta2::Topic] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PubsubV1beta2::Topic]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/pubsub_v1beta2/service.rb, line 548 def get_project_topic(topic, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+topic}', options) command.response_representation = Google::Apis::PubsubV1beta2::Topic::Representation command.response_class = Google::Apis::PubsubV1beta2::Topic command.params['topic'] = topic unless topic.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &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. @param [String] resource
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
@param [Fixnum] options_requested_policy_version
Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/ resource-policies).
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PubsubV1beta2::Policy] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PubsubV1beta2::Policy]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/pubsub_v1beta2/service.rb, line 588 def get_project_topic_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+resource}:getIamPolicy', options) command.response_representation = Google::Apis::PubsubV1beta2::Policy::Representation command.response_class = Google::Apis::PubsubV1beta2::Policy command.params['resource'] = resource unless resource.nil? command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Lists matching subscriptions. @param [String] project
The name of the cloud project that subscriptions belong to.
@param [Fixnum] page_size
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.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PubsubV1beta2::ListSubscriptionsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PubsubV1beta2::ListSubscriptionsResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/pubsub_v1beta2/service.rb, line 262 def list_project_subscriptions(project, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+project}/subscriptions', options) command.response_representation = Google::Apis::PubsubV1beta2::ListSubscriptionsResponse::Representation command.response_class = Google::Apis::PubsubV1beta2::ListSubscriptionsResponse command.params['project'] = project unless project.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Lists the name of the subscriptions for this topic. @param [String] topic
The name of the topic that subscriptions are attached to.
@param [Fixnum] page_size
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.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PubsubV1beta2::ListTopicSubscriptionsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PubsubV1beta2::ListTopicSubscriptionsResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/pubsub_v1beta2/service.rb, line 772 def list_project_topic_subscriptions(topic, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+topic}/subscriptions', options) command.response_representation = Google::Apis::PubsubV1beta2::ListTopicSubscriptionsResponse::Representation command.response_class = Google::Apis::PubsubV1beta2::ListTopicSubscriptionsResponse command.params['topic'] = topic unless topic.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Lists matching topics. @param [String] project
The name of the cloud project that topics belong to.
@param [Fixnum] page_size
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.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PubsubV1beta2::ListTopicsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PubsubV1beta2::ListTopicsResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/pubsub_v1beta2/service.rb, line 625 def list_project_topics(project, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta2/{+project}/topics', options) command.response_representation = Google::Apis::PubsubV1beta2::ListTopicsResponse::Representation command.response_class = Google::Apis::PubsubV1beta2::ListTopicsResponse command.params['project'] = project unless project.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the 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 [String] subscription
The name of the subscription.
@param [Google::Apis::PubsubV1beta2::ModifyAckDeadlineRequest] modify_ack_deadline_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PubsubV1beta2::Empty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PubsubV1beta2::Empty]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/pubsub_v1beta2/service.rb, line 299 def modify_subscription_ack_deadline(subscription, modify_ack_deadline_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+subscription}:modifyAckDeadline', options) command.request_representation = Google::Apis::PubsubV1beta2::ModifyAckDeadlineRequest::Representation command.request_object = modify_ack_deadline_request_object command.response_representation = Google::Apis::PubsubV1beta2::Empty::Representation command.response_class = Google::Apis::PubsubV1beta2::Empty command.params['subscription'] = subscription unless subscription.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by 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 [String] subscription
The name of the subscription.
@param [Google::Apis::PubsubV1beta2::ModifyPushConfigRequest] modify_push_config_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PubsubV1beta2::Empty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PubsubV1beta2::Empty]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/pubsub_v1beta2/service.rb, line 336 def modify_subscription_push_config(subscription, modify_push_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+subscription}:modifyPushConfig', options) command.request_representation = Google::Apis::PubsubV1beta2::ModifyPushConfigRequest::Representation command.request_object = modify_push_config_request_object command.response_representation = Google::Apis::PubsubV1beta2::Empty::Representation command.response_class = Google::Apis::PubsubV1beta2::Empty command.params['subscription'] = subscription unless subscription.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist. The message payload must not be empty; it must contain either a non- empty data field, or at least one attribute. @param [String] topic
The messages in the request will be published on this topic.
@param [Google::Apis::PubsubV1beta2::PublishRequest] publish_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PubsubV1beta2::PublishResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PubsubV1beta2::PublishResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/pubsub_v1beta2/service.rb, line 660 def publish_topic(topic, publish_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+topic}:publish', options) command.request_representation = Google::Apis::PubsubV1beta2::PublishRequest::Representation command.request_object = publish_request_object command.response_representation = Google::Apis::PubsubV1beta2::PublishResponse::Representation command.response_class = Google::Apis::PubsubV1beta2::PublishResponse command.params['topic'] = topic unless topic.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription. @param [String] subscription
The subscription from which messages should be pulled.
@param [Google::Apis::PubsubV1beta2::PullRequest] pull_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PubsubV1beta2::PullResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PubsubV1beta2::PullResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/pubsub_v1beta2/service.rb, line 371 def pull_subscription(subscription, pull_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+subscription}:pull', options) command.request_representation = Google::Apis::PubsubV1beta2::PullRequest::Representation command.request_object = pull_request_object command.response_representation = Google::Apis::PubsubV1beta2::PullResponse::Representation command.response_class = Google::Apis::PubsubV1beta2::PullResponse command.params['subscription'] = subscription unless subscription.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` PERMISSION_DENIED` errors. @param [String] resource
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
@param [Google::Apis::PubsubV1beta2::SetIamPolicyRequest] set_iam_policy_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PubsubV1beta2::Policy] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PubsubV1beta2::Policy]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/pubsub_v1beta2/service.rb, line 407 def set_subscription_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+resource}:setIamPolicy', options) command.request_representation = Google::Apis::PubsubV1beta2::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::PubsubV1beta2::Policy::Representation command.response_class = Google::Apis::PubsubV1beta2::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` PERMISSION_DENIED` errors. @param [String] resource
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
@param [Google::Apis::PubsubV1beta2::SetIamPolicyRequest] set_iam_policy_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PubsubV1beta2::Policy] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PubsubV1beta2::Policy]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/pubsub_v1beta2/service.rb, line 696 def set_topic_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+resource}:setIamPolicy', options) command.request_representation = Google::Apis::PubsubV1beta2::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::PubsubV1beta2::Policy::Representation command.response_class = Google::Apis::PubsubV1beta2::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &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 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. @param [String] resource
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
@param [Google::Apis::PubsubV1beta2::TestIamPermissionsRequest] test_iam_permissions_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PubsubV1beta2::TestIamPermissionsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PubsubV1beta2::TestIamPermissionsResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/pubsub_v1beta2/service.rb, line 445 def test_subscription_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+resource}:testIamPermissions', options) command.request_representation = Google::Apis::PubsubV1beta2::TestIamPermissionsRequest::Representation command.request_object = test_iam_permissions_request_object command.response_representation = Google::Apis::PubsubV1beta2::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::PubsubV1beta2::TestIamPermissionsResponse command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &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 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. @param [String] resource
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
@param [Google::Apis::PubsubV1beta2::TestIamPermissionsRequest] test_iam_permissions_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PubsubV1beta2::TestIamPermissionsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PubsubV1beta2::TestIamPermissionsResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/pubsub_v1beta2/service.rb, line 734 def test_topic_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta2/{+resource}:testIamPermissions', options) command.request_representation = Google::Apis::PubsubV1beta2::TestIamPermissionsRequest::Representation command.request_object = test_iam_permissions_request_object command.response_representation = Google::Apis::PubsubV1beta2::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::PubsubV1beta2::TestIamPermissionsResponse command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Protected Instance Methods
# File lib/google/apis/pubsub_v1beta2/service.rb, line 786 def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? end