Class: Google::Apis::PubsubliteV1::PubsubLiteService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/pubsublite_v1/service.rb

Overview

Pub/Sub Lite API

Examples:

require 'google/apis/pubsublite_v1'

Pubsublite = Google::Apis::PubsubliteV1 # Alias the module
service = Pubsublite::PubsubLiteService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ PubsubLiteService

Returns a new instance of PubsubLiteService.



45
46
47
48
49
50
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 45

def initialize
  super('https://pubsublite.googleapis.com/', '',
        client_name: 'google-apis-pubsublite_v1',
        client_version: Google::Apis::PubsubliteV1::GEM_VERSION)
  @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.

Returns:

  • (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.



38
39
40
 
# File 'lib/google/apis/pubsublite_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.

Returns:

  • (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.



43
44
45
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#commit_subscription_cursor(subscription, commit_cursor_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::CommitCursorResponse

Updates the committed cursor.

Parameters:

  • subscription (String) —

    The subscription for which to update the cursor.

  • commit_cursor_request_object (Google::Apis::PubsubliteV1::CommitCursorRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 502

def commit_subscription_cursor(subscription, commit_cursor_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/cursor/{+subscription}:commitCursor', options)
  command.request_representation = Google::Apis::PubsubliteV1::CommitCursorRequest::Representation
  command.request_object = commit_cursor_request_object
  command.response_representation = Google::Apis::PubsubliteV1::CommitCursorResponse::Representation
  command.response_class = Google::Apis::PubsubliteV1::CommitCursorResponse
  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

#compute_topic_head_cursor(topic, compute_head_cursor_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::ComputeHeadCursorResponse

Compute the head cursor for the partition. The head cursor's offset is guaranteed to be less than or equal to all messages which have not yet been acknowledged as published, and greater than the offset of any message whose publish has already been acknowledged. It is zero if there have never been messages in the partition.

Parameters:

  • topic (String) —

    Required. The topic for which we should compute the head cursor.

  • compute_head_cursor_request_object (Google::Apis::PubsubliteV1::ComputeHeadCursorRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



581
582
583
584
585
586
587
588
589
590
591
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 581

def compute_topic_head_cursor(topic, compute_head_cursor_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/topicStats/{+topic}:computeHeadCursor', options)
  command.request_representation = Google::Apis::PubsubliteV1::ComputeHeadCursorRequest::Representation
  command.request_object = compute_head_cursor_request_object
  command.response_representation = Google::Apis::PubsubliteV1::ComputeHeadCursorResponse::Representation
  command.response_class = Google::Apis::PubsubliteV1::ComputeHeadCursorResponse
  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

#compute_topic_message_stats(topic, compute_message_stats_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::ComputeMessageStatsResponse

Compute statistics about a range of messages in a given topic and partition.

Parameters:

  • topic (String) —

    Required. The topic for which we should compute message stats.

  • compute_message_stats_request_object (Google::Apis::PubsubliteV1::ComputeMessageStatsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 614

def compute_topic_message_stats(topic, compute_message_stats_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/topicStats/{+topic}:computeMessageStats', options)
  command.request_representation = Google::Apis::PubsubliteV1::ComputeMessageStatsRequest::Representation
  command.request_object = compute_message_stats_request_object
  command.response_representation = Google::Apis::PubsubliteV1::ComputeMessageStatsResponse::Representation
  command.response_class = Google::Apis::PubsubliteV1::ComputeMessageStatsResponse
  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

#compute_topic_time_cursor(topic, compute_time_cursor_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::ComputeTimeCursorResponse

Compute the corresponding cursor for a publish or event time in a topic partition.

Parameters:

  • topic (String) —

    Required. The topic for which we should compute the cursor.

  • compute_time_cursor_request_object (Google::Apis::PubsubliteV1::ComputeTimeCursorRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



648
649
650
651
652
653
654
655
656
657
658
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 648

def compute_topic_time_cursor(topic, compute_time_cursor_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/topicStats/{+topic}:computeTimeCursor', options)
  command.request_representation = Google::Apis::PubsubliteV1::ComputeTimeCursorRequest::Representation
  command.request_object = compute_time_cursor_request_object
  command.response_representation = Google::Apis::PubsubliteV1::ComputeTimeCursorResponse::Representation
  command.response_class = Google::Apis::PubsubliteV1::ComputeTimeCursorResponse
  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

#create_admin_project_location_subscription(parent, subscription_object = nil, skip_backlog: nil, subscription_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::Subscription

Creates a new subscription.

Parameters:

  • parent (String) —

    Required. The parent location in which to create the subscription. Structured like projects/project_number/locations/location``.

  • subscription_object (Google::Apis::PubsubliteV1::Subscription) (defaults to: nil)
  • skip_backlog (Boolean) (defaults to: nil) —

    If true, the newly created subscription will only receive messages published after the subscription was created. Otherwise, the entire message backlog will be received on the subscription. Defaults to false.

  • subscription_id (String) (defaults to: nil) —

    Required. The ID to use for the subscription, which will become the final component of the subscription's name. This value is structured like: my-sub- name.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 82

def create_admin_project_location_subscription(parent, subscription_object = nil, skip_backlog: nil, subscription_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/admin/{+parent}/subscriptions', options)
  command.request_representation = Google::Apis::PubsubliteV1::Subscription::Representation
  command.request_object = subscription_object
  command.response_representation = Google::Apis::PubsubliteV1::Subscription::Representation
  command.response_class = Google::Apis::PubsubliteV1::Subscription
  command.params['parent'] = parent unless parent.nil?
  command.query['skipBacklog'] = skip_backlog unless skip_backlog.nil?
  command.query['subscriptionId'] = subscription_id unless subscription_id.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_admin_project_location_topic(parent, topic_object = nil, topic_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::Topic

Creates a new topic.

Parameters:

  • parent (String) —

    Required. The parent location in which to create the topic. Structured like projects/project_number/locations/location``.

  • topic_object (Google::Apis::PubsubliteV1::Topic) (defaults to: nil)
  • topic_id (String) (defaults to: nil) —

    Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: my-topic-name.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 260

def create_admin_project_location_topic(parent, topic_object = nil, topic_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/admin/{+parent}/topics', options)
  command.request_representation = Google::Apis::PubsubliteV1::Topic::Representation
  command.request_object = topic_object
  command.response_representation = Google::Apis::PubsubliteV1::Topic::Representation
  command.response_class = Google::Apis::PubsubliteV1::Topic
  command.params['parent'] = parent unless parent.nil?
  command.query['topicId'] = topic_id unless topic_id.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_admin_project_location_subscription(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::Empty

Deletes the specified subscription.

Parameters:

  • name (String) —

    Required. The name of the subscription to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



116
117
118
119
120
121
122
123
124
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 116

def delete_admin_project_location_subscription(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/admin/{+name}', options)
  command.response_representation = Google::Apis::PubsubliteV1::Empty::Representation
  command.response_class = Google::Apis::PubsubliteV1::Empty
  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_admin_project_location_topic(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::Empty

Deletes the specified topic.

Parameters:

  • name (String) —

    Required. The name of the topic to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



293
294
295
296
297
298
299
300
301
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 293

def delete_admin_project_location_topic(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/admin/{+name}', options)
  command.response_representation = Google::Apis::PubsubliteV1::Empty::Representation
  command.response_class = Google::Apis::PubsubliteV1::Empty
  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

#get_admin_project_location_subscription(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::Subscription

Returns the subscription configuration.

Parameters:

  • name (String) —

    Required. The name of the subscription whose configuration to return.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



146
147
148
149
150
151
152
153
154
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 146

def get_admin_project_location_subscription(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/admin/{+name}', options)
  command.response_representation = Google::Apis::PubsubliteV1::Subscription::Representation
  command.response_class = Google::Apis::PubsubliteV1::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

#get_admin_project_location_topic(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::Topic

Returns the topic configuration.

Parameters:

  • name (String) —

    Required. The name of the topic whose configuration to return.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



323
324
325
326
327
328
329
330
331
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 323

def get_admin_project_location_topic(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/admin/{+name}', options)
  command.response_representation = Google::Apis::PubsubliteV1::Topic::Representation
  command.response_class = Google::Apis::PubsubliteV1::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

#get_admin_project_location_topic_partitions(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::TopicPartitions

Returns the partition information for the requested topic.

Parameters:

  • name (String) —

    Required. The topic whose partition information to return.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



353
354
355
356
357
358
359
360
361
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 353

def get_admin_project_location_topic_partitions(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/admin/{+name}/partitions', options)
  command.response_representation = Google::Apis::PubsubliteV1::TopicPartitions::Representation
  command.response_class = Google::Apis::PubsubliteV1::TopicPartitions
  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

#list_admin_project_location_subscriptions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::ListSubscriptionsResponse

Returns the list of subscriptions for the given project.

Parameters:

  • parent (String) —

    Required. The parent whose subscriptions are to be listed. Structured like projects/project_number/locations/location``.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of subscriptions to return. The service may return fewer than this value. If unset or zero, all subscriptions for the parent will be returned.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListSubscriptions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSubscriptions must match the call that provided the page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 186

def list_admin_project_location_subscriptions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/admin/{+parent}/subscriptions', options)
  command.response_representation = Google::Apis::PubsubliteV1::ListSubscriptionsResponse::Representation
  command.response_class = Google::Apis::PubsubliteV1::ListSubscriptionsResponse
  command.params['parent'] = parent unless parent.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_admin_project_location_topic_subscriptions(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::ListTopicSubscriptionsResponse

Lists the subscriptions attached to the specified topic.

Parameters:

  • name (String) —

    Required. The name of the topic whose subscriptions to list.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of subscriptions to return. The service may return fewer than this value. If unset or zero, all subscriptions for the given topic will be returned.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListTopicSubscriptions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListTopicSubscriptions must match the call that provided the page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 469

def list_admin_project_location_topic_subscriptions(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/admin/{+name}/subscriptions', options)
  command.response_representation = Google::Apis::PubsubliteV1::ListTopicSubscriptionsResponse::Representation
  command.response_class = Google::Apis::PubsubliteV1::ListTopicSubscriptionsResponse
  command.params['name'] = name unless name.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_admin_project_location_topics(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::ListTopicsResponse

Returns the list of topics for the given project.

Parameters:

  • parent (String) —

    Required. The parent whose topics are to be listed. Structured like projects/ project_number/locations/location``.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the parent will be returned.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListTopics call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListTopics must match the call that provided the page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 391

def list_admin_project_location_topics(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/admin/{+parent}/topics', options)
  command.response_representation = Google::Apis::PubsubliteV1::ListTopicsResponse::Representation
  command.response_class = Google::Apis::PubsubliteV1::ListTopicsResponse
  command.params['parent'] = parent unless parent.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_cursor_project_location_subscription_cursors(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::ListPartitionCursorsResponse

Returns all committed cursor information for a subscription.

Parameters:

  • parent (String) —

    Required. The subscription for which to retrieve cursors. Structured like projects/project_number/locations/location/subscriptions/subscription_id`` .

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of cursors to return. The service may return fewer than this value. If unset or zero, all cursors for the parent will be returned.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListPartitionCursors call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPartitionCursors must match the call that provided the page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 544

def list_cursor_project_location_subscription_cursors(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/cursor/{+parent}/cursors', options)
  command.response_representation = Google::Apis::PubsubliteV1::ListPartitionCursorsResponse::Representation
  command.response_class = Google::Apis::PubsubliteV1::ListPartitionCursorsResponse
  command.params['parent'] = parent unless parent.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

#patch_admin_project_location_subscription(name, subscription_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::Subscription

Updates properties of the specified subscription.

Parameters:

  • name (String) —

    The name of the subscription. Structured like: projects/project_number/ locations/location/subscriptions/subscription_id

  • subscription_object (Google::Apis::PubsubliteV1::Subscription) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. A mask specifying the subscription fields to change.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 222

def patch_admin_project_location_subscription(name, subscription_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/admin/{+name}', options)
  command.request_representation = Google::Apis::PubsubliteV1::Subscription::Representation
  command.request_object = subscription_object
  command.response_representation = Google::Apis::PubsubliteV1::Subscription::Representation
  command.response_class = Google::Apis::PubsubliteV1::Subscription
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.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_admin_project_location_topic(name, topic_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::Topic

Updates properties of the specified topic.

Parameters:

  • name (String) —

    The name of the topic. Structured like: projects/project_number/locations/ location/topics/topic_id

  • topic_object (Google::Apis::PubsubliteV1::Topic) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. A mask specifying the topic fields to change.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 427

def patch_admin_project_location_topic(name, topic_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/admin/{+name}', options)
  command.request_representation = Google::Apis::PubsubliteV1::Topic::Representation
  command.request_object = topic_object
  command.response_representation = Google::Apis::PubsubliteV1::Topic::Representation
  command.response_class = Google::Apis::PubsubliteV1::Topic
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end