Class: Google::Apis::PubsubV1::PubsubService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::PubsubV1::PubsubService
- Defined in:
- generated/google/apis/pubsub_v1/service.rb
Overview
Cloud Pub/Sub API
Provides reliable, many-to-many, asynchronous messaging between applications.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#acknowledge_subscription(subscription, acknowledge_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Empty
Acknowledges the messages associated with the
ack_ids
in theAcknowledgeRequest
. -
#create_snapshot(name, create_snapshot_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Snapshot
Creates a snapshot from the requested subscription.
-
#create_subscription(name, subscription_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Subscription
Creates a subscription to a given topic.
-
#create_topic(name, topic_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Topic
Creates the given topic with the given name.
-
#delete_project_snapshot(snapshot, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Empty
Removes an existing snapshot.
-
#delete_subscription(subscription, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Empty
Deletes an existing subscription.
-
#delete_topic(topic, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Empty
Deletes the topic with the given name.
-
#get_project_snapshot(snapshot, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Snapshot
Gets the configuration details of a snapshot.
-
#get_project_snapshot_iam_policy(resource, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Policy
Gets the access control policy for a resource.
-
#get_project_subscription_iam_policy(resource, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Policy
Gets the access control policy for a resource.
-
#get_project_topic_iam_policy(resource, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Policy
Gets the access control policy for a resource.
-
#get_subscription(subscription, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Subscription
Gets the configuration details of a subscription.
-
#get_topic(topic, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Topic
Gets the configuration of a topic.
-
#initialize ⇒ PubsubService
constructor
A new instance of PubsubService.
-
#list_project_snapshots(project, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::ListSnapshotsResponse
Lists the existing snapshots.
-
#list_project_topic_snapshots(topic, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::ListTopicSnapshotsResponse
Lists the names of the snapshots on this topic.
-
#list_subscriptions(project, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::ListSubscriptionsResponse
Lists matching subscriptions.
-
#list_topic_subscriptions(topic, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::ListTopicSubscriptionsResponse
Lists the names of the subscriptions on this topic.
-
#list_topics(project, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::ListTopicsResponse
Lists matching topics.
-
#modify_subscription_ack_deadline(subscription, modify_ack_deadline_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Empty
Modifies the ack deadline for a specific message.
-
#modify_subscription_push_config(subscription, modify_push_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Empty
Modifies the
PushConfig
for a specified subscription. -
#patch_project_snapshot(name, update_snapshot_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Snapshot
Updates an existing snapshot.
-
#patch_project_subscription(name, update_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Subscription
Updates an existing subscription.
-
#patch_project_topic(name, update_topic_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Topic
Updates an existing topic.
-
#publish_topic(topic, publish_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::PublishResponse
Adds one or more messages to the topic.
-
#pull_subscription(subscription, pull_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::PullResponse
Pulls messages from the server.
-
#seek_subscription(subscription, seek_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::SeekResponse
Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request.
-
#set_snapshot_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Policy
Sets the access control policy on the specified resource.
-
#set_subscription_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Policy
Sets the access control policy on the specified resource.
-
#set_topic_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Policy
Sets the access control policy on the specified resource.
-
#test_snapshot_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::TestIamPermissionsResponse
Returns permissions that a caller has on the specified resource.
-
#test_subscription_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::TestIamPermissionsResponse
Returns permissions that a caller has on the specified resource.
-
#test_topic_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::TestIamPermissionsResponse
Returns permissions that a caller has on the specified resource.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ PubsubService
Returns a new instance of PubsubService
45 46 47 48 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 45 def initialize super('https://pubsub.googleapis.com/', '') @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns 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.
38 39 40 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 38 def key @key end |
#quota_user ⇒ String
Returns 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.
43 44 45 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 43 def quota_user @quota_user end |
Instance Method Details
#acknowledge_subscription(subscription, acknowledge_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Empty
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.
414 415 416 417 418 419 420 421 422 423 424 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 414 def acknowledge_subscription(subscription, acknowledge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+subscription}:acknowledge', ) command.request_representation = Google::Apis::PubsubV1::AcknowledgeRequest::Representation command.request_object = acknowledge_request_object command.response_representation = Google::Apis::PubsubV1::Empty::Representation command.response_class = Google::Apis::PubsubV1::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 |
#create_snapshot(name, create_snapshot_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Snapshot
Creates a snapshot from the requested subscription. Snapshots are used in
Seek
operations, which allow
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.
BETA: This feature is part of a beta 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.
If the snapshot already exists, returns ALREADY_EXISTS
.
If the requested subscription doesn't exist, returns NOT_FOUND
.
If the backlog in the subscription is too old -- and the resulting snapshot
would expire in less than 1 hour -- then FAILED_PRECONDITION
is returned.
See also the Snapshot.expire_time
field. 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, conforming
to the
resource name format.
The generated name is populated in the returned Snapshot object. Note that
for REST API requests, you must specify a name in the request.
98 99 100 101 102 103 104 105 106 107 108 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 98 def create_snapshot(name, create_snapshot_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1/{+name}', ) command.request_representation = Google::Apis::PubsubV1::CreateSnapshotRequest::Representation command.request_object = create_snapshot_request_object command.response_representation = Google::Apis::PubsubV1::Snapshot::Representation command.response_class = Google::Apis::PubsubV1::Snapshot 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 |
#create_subscription(name, subscription_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Subscription
Creates a subscription to a given topic. See the
resource name rules.
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, conforming
to the
resource name format.
The generated name is populated in the returned Subscription object.
Note that for REST API requests, you must specify a name in the request.
463 464 465 466 467 468 469 470 471 472 473 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 463 def create_subscription(name, subscription_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1/{+name}', ) command.request_representation = Google::Apis::PubsubV1::Subscription::Representation command.request_object = subscription_object command.response_representation = Google::Apis::PubsubV1::Subscription::Representation command.response_class = Google::Apis::PubsubV1::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 |
#create_topic(name, topic_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Topic
Creates the given topic with the given name. See the resource name rules.
909 910 911 912 913 914 915 916 917 918 919 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 909 def create_topic(name, topic_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1/{+name}', ) command.request_representation = Google::Apis::PubsubV1::Topic::Representation command.request_object = topic_object command.response_representation = Google::Apis::PubsubV1::Topic::Representation command.response_class = Google::Apis::PubsubV1::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 |
#delete_project_snapshot(snapshot, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Empty
Removes an existing snapshot. Snapshots are used in
Seek
operations, which allow
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.
BETA: This feature is part of a beta 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.
When the snapshot is deleted, all messages retained in the snapshot
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.
143 144 145 146 147 148 149 150 151 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 143 def delete_project_snapshot(snapshot, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+snapshot}', ) command.response_representation = Google::Apis::PubsubV1::Empty::Representation command.response_class = Google::Apis::PubsubV1::Empty command.params['snapshot'] = snapshot unless snapshot.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_subscription(subscription, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Empty
Deletes an existing subscription. All messages retained 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.
500 501 502 503 504 505 506 507 508 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 500 def delete_subscription(subscription, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+subscription}', ) command.response_representation = Google::Apis::PubsubV1::Empty::Representation command.response_class = Google::Apis::PubsubV1::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 |
#delete_topic(topic, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Empty
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_
.
946 947 948 949 950 951 952 953 954 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 946 def delete_topic(topic, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+topic}', ) command.response_representation = Google::Apis::PubsubV1::Empty::Representation command.response_class = Google::Apis::PubsubV1::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 |
#get_project_snapshot(snapshot, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Snapshot
Gets the configuration details of a snapshot. Snapshots are used in
Seek
operations, which allow 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.
BETA: This feature is part of a beta 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.
181 182 183 184 185 186 187 188 189 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 181 def get_project_snapshot(snapshot, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+snapshot}', ) command.response_representation = Google::Apis::PubsubV1::Snapshot::Representation command.response_class = Google::Apis::PubsubV1::Snapshot command.params['snapshot'] = snapshot unless snapshot.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_snapshot_iam_policy(resource, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Policy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
214 215 216 217 218 219 220 221 222 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 214 def get_project_snapshot_iam_policy(resource, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', ) command.response_representation = Google::Apis::PubsubV1::Policy::Representation command.response_class = Google::Apis::PubsubV1::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 |
#get_project_subscription_iam_policy(resource, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Policy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
564 565 566 567 568 569 570 571 572 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 564 def get_project_subscription_iam_policy(resource, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', ) command.response_representation = Google::Apis::PubsubV1::Policy::Representation command.response_class = Google::Apis::PubsubV1::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 |
#get_project_topic_iam_policy(resource, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Policy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
1010 1011 1012 1013 1014 1015 1016 1017 1018 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 1010 def get_project_topic_iam_policy(resource, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', ) command.response_representation = Google::Apis::PubsubV1::Policy::Representation command.response_class = Google::Apis::PubsubV1::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 |
#get_subscription(subscription, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Subscription
Gets the configuration details of a subscription.
531 532 533 534 535 536 537 538 539 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 531 def get_subscription(subscription, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+subscription}', ) command.response_representation = Google::Apis::PubsubV1::Subscription::Representation command.response_class = Google::Apis::PubsubV1::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 |
#get_topic(topic, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Topic
Gets the configuration of a topic.
977 978 979 980 981 982 983 984 985 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 977 def get_topic(topic, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+topic}', ) command.response_representation = Google::Apis::PubsubV1::Topic::Representation command.response_class = Google::Apis::PubsubV1::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 |
#list_project_snapshots(project, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::ListSnapshotsResponse
Lists the existing snapshots. Snapshots are used in
Seek
operations, which allow
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.
BETA: This feature is part of a beta 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.
259 260 261 262 263 264 265 266 267 268 269 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 259 def list_project_snapshots(project, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+project}/snapshots', ) command.response_representation = Google::Apis::PubsubV1::ListSnapshotsResponse::Representation command.response_class = Google::Apis::PubsubV1::ListSnapshotsResponse 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 |
#list_project_topic_snapshots(topic, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::ListTopicSnapshotsResponse
Lists the names of the snapshots on this topic. Snapshots are used in
Seek
operations, which allow
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.
BETA: This feature is part of a beta 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.
1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 1242 def list_project_topic_snapshots(topic, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+topic}/snapshots', ) command.response_representation = Google::Apis::PubsubV1::ListTopicSnapshotsResponse::Representation command.response_class = Google::Apis::PubsubV1::ListTopicSnapshotsResponse 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 |
#list_subscriptions(project, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::ListSubscriptionsResponse
Lists matching subscriptions.
601 602 603 604 605 606 607 608 609 610 611 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 601 def list_subscriptions(project, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+project}/subscriptions', ) command.response_representation = Google::Apis::PubsubV1::ListSubscriptionsResponse::Representation command.response_class = Google::Apis::PubsubV1::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 |
#list_topic_subscriptions(topic, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::ListTopicSubscriptionsResponse
Lists the names of the subscriptions on this topic.
1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 1281 def list_topic_subscriptions(topic, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+topic}/subscriptions', ) command.response_representation = Google::Apis::PubsubV1::ListTopicSubscriptionsResponse::Representation command.response_class = Google::Apis::PubsubV1::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 |
#list_topics(project, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::ListTopicsResponse
Lists matching topics.
1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 1047 def list_topics(project, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+project}/topics', ) command.response_representation = Google::Apis::PubsubV1::ListTopicsResponse::Representation command.response_class = Google::Apis::PubsubV1::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 |
#modify_subscription_ack_deadline(subscription, modify_ack_deadline_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Empty
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.
639 640 641 642 643 644 645 646 647 648 649 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 639 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, 'v1/{+subscription}:modifyAckDeadline', ) command.request_representation = Google::Apis::PubsubV1::ModifyAckDeadlineRequest::Representation command.request_object = modify_ack_deadline_request_object command.response_representation = Google::Apis::PubsubV1::Empty::Representation command.response_class = Google::Apis::PubsubV1::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 |
#modify_subscription_push_config(subscription, modify_push_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Empty
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
.
677 678 679 680 681 682 683 684 685 686 687 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 677 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, 'v1/{+subscription}:modifyPushConfig', ) command.request_representation = Google::Apis::PubsubV1::ModifyPushConfigRequest::Representation command.request_object = modify_push_config_request_object command.response_representation = Google::Apis::PubsubV1::Empty::Representation command.response_class = Google::Apis::PubsubV1::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 |
#patch_project_snapshot(name, update_snapshot_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Snapshot
Updates an existing snapshot. Snapshots are used in
Seek
operations, which allow
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.
BETA: This feature is part of a beta 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.
Note that certain properties of a snapshot are not modifiable.
301 302 303 304 305 306 307 308 309 310 311 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 301 def patch_project_snapshot(name, update_snapshot_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', ) command.request_representation = Google::Apis::PubsubV1::UpdateSnapshotRequest::Representation command.request_object = update_snapshot_request_object command.response_representation = Google::Apis::PubsubV1::Snapshot::Representation command.response_class = Google::Apis::PubsubV1::Snapshot 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 |
#patch_project_subscription(name, update_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Subscription
Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable.
716 717 718 719 720 721 722 723 724 725 726 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 716 def patch_project_subscription(name, update_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', ) command.request_representation = Google::Apis::PubsubV1::UpdateSubscriptionRequest::Representation command.request_object = update_subscription_request_object command.response_representation = Google::Apis::PubsubV1::Subscription::Representation command.response_class = Google::Apis::PubsubV1::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 |
#patch_project_topic(name, update_topic_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Topic
Updates an existing topic. Note that certain properties of a topic are not modifiable.
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 1086 def patch_project_topic(name, update_topic_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', ) command.request_representation = Google::Apis::PubsubV1::UpdateTopicRequest::Representation command.request_object = update_topic_request_object command.response_representation = Google::Apis::PubsubV1::Topic::Representation command.response_class = Google::Apis::PubsubV1::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 |
#publish_topic(topic, publish_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::PublishResponse
Adds one or more messages to the topic. Returns NOT_FOUND
if the topic
does not exist.
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 1121 def publish_topic(topic, publish_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+topic}:publish', ) command.request_representation = Google::Apis::PubsubV1::PublishRequest::Representation command.request_object = publish_request_object command.response_representation = Google::Apis::PubsubV1::PublishResponse::Representation command.response_class = Google::Apis::PubsubV1::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 |
#pull_subscription(subscription, pull_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::PullResponse
Pulls messages from the server. The server may return UNAVAILABLE
if
there are too many concurrent pull requests pending for the given
subscription.
752 753 754 755 756 757 758 759 760 761 762 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 752 def pull_subscription(subscription, pull_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+subscription}:pull', ) command.request_representation = Google::Apis::PubsubV1::PullRequest::Representation command.request_object = pull_request_object command.response_representation = Google::Apis::PubsubV1::PullResponse::Representation command.response_class = Google::Apis::PubsubV1::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 |
#seek_subscription(subscription, seek_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::SeekResponse
Seeks an existing subscription to a point in time or to a given snapshot,
whichever is provided in the request. Snapshots are used in
Seek
operations, which allow
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. Note that both the subscription and the snapshot
must be on the same topic.
BETA: This feature is part of a beta 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.
795 796 797 798 799 800 801 802 803 804 805 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 795 def seek_subscription(subscription, seek_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+subscription}:seek', ) command.request_representation = Google::Apis::PubsubV1::SeekRequest::Representation command.request_object = seek_request_object command.response_representation = Google::Apis::PubsubV1::SeekResponse::Representation command.response_class = Google::Apis::PubsubV1::SeekResponse 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 |
#set_snapshot_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Policy
Sets the access control policy on the specified resource. Replaces any existing policy.
336 337 338 339 340 341 342 343 344 345 346 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 336 def set_snapshot_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', ) command.request_representation = Google::Apis::PubsubV1::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::PubsubV1::Policy::Representation command.response_class = Google::Apis::PubsubV1::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 |
#set_subscription_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Policy
Sets the access control policy on the specified resource. Replaces any existing policy.
830 831 832 833 834 835 836 837 838 839 840 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 830 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, 'v1/{+resource}:setIamPolicy', ) command.request_representation = Google::Apis::PubsubV1::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::PubsubV1::Policy::Representation command.response_class = Google::Apis::PubsubV1::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 |
#set_topic_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::Policy
Sets the access control policy on the specified resource. Replaces any existing policy.
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 1156 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, 'v1/{+resource}:setIamPolicy', ) command.request_representation = Google::Apis::PubsubV1::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::PubsubV1::Policy::Representation command.response_class = Google::Apis::PubsubV1::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 |
#test_snapshot_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::TestIamPermissionsResponse
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.
375 376 377 378 379 380 381 382 383 384 385 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 375 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::PubsubV1::TestIamPermissionsRequest::Representation command.request_object = command.response_representation = Google::Apis::PubsubV1::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::PubsubV1::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 |
#test_subscription_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::TestIamPermissionsResponse
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.
869 870 871 872 873 874 875 876 877 878 879 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 869 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::PubsubV1::TestIamPermissionsRequest::Representation command.request_object = command.response_representation = Google::Apis::PubsubV1::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::PubsubV1::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 |
#test_topic_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1::TestIamPermissionsResponse
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.
1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 |
# File 'generated/google/apis/pubsub_v1/service.rb', line 1195 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::PubsubV1::TestIamPermissionsRequest::Representation command.request_object = command.response_representation = Google::Apis::PubsubV1::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::PubsubV1::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 |