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

#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::Empty

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.

Parameters:

  • name (String) —

    The name of the operation resource to be cancelled.

  • cancel_operation_request_object (Google::Apis::PubsubliteV1::CancelOperationRequest) (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



80
81
82
83
84
85
86
87
88
89
90
 
# 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) {|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



699
700
701
702
703
704
705
706
707
708
709
 
# 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) {|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



778
779
780
781
782
783
784
785
786
787
788
 
# 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) {|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



811
812
813
814
815
816
817
818
819
820
821
 
# 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) {|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



845
846
847
848
849
850
851
852
853
854
855
 
# 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) {|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



232
233
234
235
236
237
238
239
240
241
242
243
244
 
# 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) {|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



457
458
459
460
461
462
463
464
465
466
467
468
 
# 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) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::Empty

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.

Parameters:

  • name (String) —

    The name of the operation resource to be deleted.

  • 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



115
116
117
118
119
120
121
122
123
 
# 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) {|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



266
267
268
269
270
271
272
273
274
 
# 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) {|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



490
491
492
493
494
495
496
497
498
 
# 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) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::Operation

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.

Parameters:

  • name (String) —

    The name of the operation resource.

  • 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_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) {|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



296
297
298
299
300
301
302
303
304
 
# 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) {|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



520
521
522
523
524
525
526
527
528
 
# 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) {|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



550
551
552
553
554
555
556
557
558
 
# 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) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::ListOperationsResponse

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.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

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

    The standard list filter.

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

    The standard list page size.

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

    The standard list 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



189
190
191
192
193
194
195
196
197
198
199
200
 
# 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) {|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



336
337
338
339
340
341
342
343
344
345
346
 
# 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) {|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



666
667
668
669
670
671
672
673
674
675
676
 
# 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) {|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



588
589
590
591
592
593
594
595
596
597
598
 
# 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) {|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



741
742
743
744
745
746
747
748
749
750
751
 
# 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) {|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



372
373
374
375
376
377
378
379
380
381
382
383
 
# 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) {|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



624
625
626
627
628
629
630
631
632
633
634
635
 
# 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) {|result, err| ... } ⇒ Google::Apis::PubsubliteV1::Operation

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.

Parameters:

  • name (String) —

    Required. The name of the subscription to seek.

  • seek_subscription_request_object (Google::Apis::PubsubliteV1::SeekSubscriptionRequest) (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



420
421
422
423
424
425
426
427
428
429
430
 
# 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