class Google::Apis::PubsubliteV1::PubsubLiteService

Pub/Sub Lite API

@example

require 'google/apis/pubsublite_v1'

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

@see cloud.google.com/pubsub/lite/docs

Attributes

key[RW]

@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.
quota_user[RW]

@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

new() click to toggle source
Calls superclass method
# 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

Public Instance Methods

cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. @param [String] name

The name of the operation resource to be cancelled.

@param [Google::Apis::PubsubliteV1::CancelOperationRequest] cancel_operation_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::PubsubliteV1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::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/pubsublite_v1/service.rb, line 80
def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/admin/{+name}:cancel', options)
  command.request_representation = Google::Apis::PubsubliteV1::CancelOperationRequest::Representation
  command.request_object = cancel_operation_request_object
  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
commit_subscription_cursor(subscription, commit_cursor_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates the committed cursor. @param [String] subscription

The subscription for which to update the cursor.

@param [Google::Apis::PubsubliteV1::CommitCursorRequest] commit_cursor_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::PubsubliteV1::CommitCursorResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::CommitCursorResponse]

@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/pubsublite_v1/service.rb, line 699
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, &block) click to toggle source

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. @param [String] topic

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

@param [Google::Apis::PubsubliteV1::ComputeHeadCursorRequest] compute_head_cursor_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::PubsubliteV1::ComputeHeadCursorResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::ComputeHeadCursorResponse]

@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/pubsublite_v1/service.rb, line 778
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, &block) click to toggle source

Compute statistics about a range of messages in a given topic and partition. @param [String] topic

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

@param [Google::Apis::PubsubliteV1::ComputeMessageStatsRequest] compute_message_stats_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::PubsubliteV1::ComputeMessageStatsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::ComputeMessageStatsResponse]

@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/pubsublite_v1/service.rb, line 811
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, &block) click to toggle source

Compute the corresponding cursor for a publish or event time in a topic partition. @param [String] topic

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

@param [Google::Apis::PubsubliteV1::ComputeTimeCursorRequest] compute_time_cursor_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::PubsubliteV1::ComputeTimeCursorResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::ComputeTimeCursorResponse]

@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/pubsublite_v1/service.rb, line 845
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, &block) click to toggle source

Creates a new subscription. @param [String] parent

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

@param [Google::Apis::PubsubliteV1::Subscription] subscription_object @param [Boolean] skip_backlog

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.

@param [String] subscription_id

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`.

@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::PubsubliteV1::Subscription] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::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/pubsublite_v1/service.rb, line 232
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, &block) click to toggle source

Creates a new topic. @param [String] parent

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

@param [Google::Apis::PubsubliteV1::Topic] topic_object @param [String] topic_id

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`.

@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::PubsubliteV1::Topic] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::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/pubsublite_v1/service.rb, line 457
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_operation(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code. UNIMPLEMENTED`. @param [String] name

The name of the operation resource to be deleted.

@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::PubsubliteV1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::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/pubsublite_v1/service.rb, line 115
def delete_admin_project_location_operation(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_subscription(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes the specified subscription. @param [String] name

Required. The name of 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::PubsubliteV1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::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/pubsublite_v1/service.rb, line 266
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, &block) click to toggle source

Deletes the specified topic. @param [String] name

Required. The 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::PubsubliteV1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::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/pubsublite_v1/service.rb, line 490
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_operation(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. @param [String] name

The name of the operation resource.

@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::PubsubliteV1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::Operation]

@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/pubsublite_v1/service.rb, line 146
def get_admin_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/admin/{+name}', options)
  command.response_representation = Google::Apis::PubsubliteV1::Operation::Representation
  command.response_class = Google::Apis::PubsubliteV1::Operation
  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, &block) click to toggle source

Returns the subscription configuration. @param [String] name

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

@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::PubsubliteV1::Subscription] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::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/pubsublite_v1/service.rb, line 296
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, &block) click to toggle source

Returns the topic configuration. @param [String] name

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

@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::PubsubliteV1::Topic] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::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/pubsublite_v1/service.rb, line 520
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, &block) click to toggle source

Returns the partition information for the requested topic. @param [String] name

Required. The topic whose partition information to return.

@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::PubsubliteV1::TopicPartitions] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::TopicPartitions]

@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/pubsublite_v1/service.rb, line 550
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_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `“/v1/`name=users/*`/operations”` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. @param [String] name

The name of the operation's parent resource.

@param [String] filter

The standard list filter.

@param [Fixnum] page_size

The standard list page size.

@param [String] page_token

The standard list page token.

@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::PubsubliteV1::ListOperationsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::ListOperationsResponse]

@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/pubsublite_v1/service.rb, line 189
def list_admin_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/admin/{+name}/operations', options)
  command.response_representation = Google::Apis::PubsubliteV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::PubsubliteV1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.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_subscriptions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Returns the list of subscriptions for the given project. @param [String] parent

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

@param [Fixnum] page_size

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.

@param [String] page_token

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.

@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::PubsubliteV1::ListSubscriptionsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::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/pubsublite_v1/service.rb, line 336
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, &block) click to toggle source

Lists the subscriptions attached to the specified topic. @param [String] name

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

@param [Fixnum] page_size

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.

@param [String] page_token

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.

@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::PubsubliteV1::ListTopicSubscriptionsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::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/pubsublite_v1/service.rb, line 666
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, &block) click to toggle source

Returns the list of topics for the given project. @param [String] parent

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

@param [Fixnum] page_size

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.

@param [String] page_token

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.

@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::PubsubliteV1::ListTopicsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::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/pubsublite_v1/service.rb, line 588
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, &block) click to toggle source

Returns all committed cursor information for a subscription. @param [String] parent

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

@param [Fixnum] page_size

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.

@param [String] page_token

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.

@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::PubsubliteV1::ListPartitionCursorsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::ListPartitionCursorsResponse]

@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/pubsublite_v1/service.rb, line 741
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, &block) click to toggle source

Updates properties of the specified subscription. @param [String] name

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

@param [Google::Apis::PubsubliteV1::Subscription] subscription_object @param [String] update_mask

Required. A mask specifying the subscription fields to change.

@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::PubsubliteV1::Subscription] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::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/pubsublite_v1/service.rb, line 372
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, &block) click to toggle source

Updates properties of the specified topic. @param [String] name

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

@param [Google::Apis::PubsubliteV1::Topic] topic_object @param [String] update_mask

Required. A mask specifying the topic fields to change.

@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::PubsubliteV1::Topic] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::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/pubsublite_v1/service.rb, line 624
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
seek_subscription(name, seek_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Performs an out-of-band seek for a subscription to a specified target, which may be timestamps or named positions within the message backlog. Seek translates these targets to cursors for each partition and orchestrates subscribers to start consuming messages from these seek cursors. If an operation is returned, the seek has been registered and subscribers will eventually receive messages from the seek cursors (i.e. eventual consistency), as long as they are using a minimum supported client library version and not a system that tracks cursors independently of Pub/Sub Lite (e.g. Apache Beam, Dataflow, Spark). The seek operation will fail for unsupported clients. If clients would like to know when subscribers react to the seek (or not), they can poll the operation. The seek operation will succeed and complete once subscribers are ready to receive messages from the seek cursors for all partitions of the topic. This means that the seek operation will not complete until all subscribers come online. If the previous seek operation has not yet completed, it will be aborted and the new invocation of seek will supersede it. @param [String] name

Required. The name of the subscription to seek.

@param [Google::Apis::PubsubliteV1::SeekSubscriptionRequest] seek_subscription_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::PubsubliteV1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::PubsubliteV1::Operation]

@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/pubsublite_v1/service.rb, line 420
def seek_subscription(name, seek_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/admin/{+name}:seek', options)
  command.request_representation = Google::Apis::PubsubliteV1::SeekSubscriptionRequest::Representation
  command.request_object = seek_subscription_request_object
  command.response_representation = Google::Apis::PubsubliteV1::Operation::Representation
  command.response_class = Google::Apis::PubsubliteV1::Operation
  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

Protected Instance Methods

apply_command_defaults(command) click to toggle source
# File lib/google/apis/pubsublite_v1/service.rb, line 859
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
end