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

#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



539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 539

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

#create_admin_project_location_subscription(parent, subscription_object = 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)
  • 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



78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 78

def create_admin_project_location_subscription(parent, subscription_object = 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['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



255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 255

def create_admin_project_location_topic(parent, topic_object = nil, topic_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/admin/{+parent}/topics', options)
  command.request_representation = Google::Apis::PubsubliteV1::Topic::Representation
  command.request_object = topic_object
  command.response_representation = Google::Apis::PubsubliteV1::Topic::Representation
  command.response_class = Google::Apis::PubsubliteV1::Topic
  command.params['parent'] = parent unless parent.nil?
  command.query['topicId'] = topic_id unless topic_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Deletes the specified subscription.

Parameters:

  • name (String) —

    Required. The name of the subscription to delete.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



111
112
113
114
115
116
117
118
119
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 111

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



288
289
290
291
292
293
294
295
296
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 288

def delete_admin_project_location_topic(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/admin/{+name}', options)
  command.response_representation = Google::Apis::PubsubliteV1::Empty::Representation
  command.response_class = Google::Apis::PubsubliteV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Returns the subscription configuration.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



141
142
143
144
145
146
147
148
149
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 141

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



318
319
320
321
322
323
324
325
326
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 318

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



348
349
350
351
352
353
354
355
356
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 348

def get_admin_project_location_topic_partitions(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/admin/{+name}/partitions', options)
  command.response_representation = Google::Apis::PubsubliteV1::TopicPartitions::Representation
  command.response_class = Google::Apis::PubsubliteV1::TopicPartitions
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Returns the list of subscriptions for the given project.

Parameters:

  • parent (String) —

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

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 181

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



464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 464

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



386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 386

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



506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 506

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



217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 217

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



422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/google/apis/pubsublite_v1/service.rb', line 422

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