google-apis-pubsub_v1 0.28.0 → 0.53.0

data/lib/google/apis/pubsub_v1/service.rb

@@ -32,6 +32,8 @@ module Google
       #
       # @see https://cloud.google.com/pubsub/docs
       class PubsubService < Google::Apis::Core::BaseService
+        DEFAULT_ENDPOINT_TEMPLATE = "https://pubsub.$UNIVERSE_DOMAIN$/"
+
         # @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.
@@ -43,12 +45,46 @@ module Google
         attr_accessor :quota_user
 
         def initialize
-          super('https://pubsub.googleapis.com/', '',
+          super(DEFAULT_ENDPOINT_TEMPLATE, '',
                 client_name: 'google-apis-pubsub_v1',
                 client_version: Google::Apis::PubsubV1::GEM_VERSION)
           @batch_path = 'batch'
         end
         
+        # Commits a new schema revision to an existing schema.
+        # @param [String] name
+        #   Required. The name of the schema we are revising. Format is `projects/`project`
+        #   /schemas/`schema``.
+        # @param [Google::Apis::PubsubV1::CommitSchemaRequest] commit_schema_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::PubsubV1::Schema] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::PubsubV1::Schema]
+        #
+        # @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
+        def commit_schema(name, commit_schema_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+name}:commit', options)
+          command.request_representation = Google::Apis::PubsubV1::CommitSchemaRequest::Representation
+          command.request_object = commit_schema_request_object
+          command.response_representation = Google::Apis::PubsubV1::Schema::Representation
+          command.response_class = Google::Apis::PubsubV1::Schema
+          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
+        
         # Creates a schema.
         # @param [String] parent
         #   Required. The name of the project in which to create the schema. Format is `
@@ -56,7 +92,7 @@ module Google
         # @param [Google::Apis::PubsubV1::Schema] schema_object
         # @param [String] schema_id
         #   The ID to use for the schema, which will become the final component of the
-        #   schema's resource name. See https://cloud.google.com/pubsub/docs/admin#
+        #   schema's resource name. See https://cloud.google.com/pubsub/docs/pubsub-basics#
         #   resource_names for resource name constraints.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -119,6 +155,41 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Deletes a specific schema revision.
+        # @param [String] name
+        #   Required. The name of the schema revision to be deleted, with a revision ID
+        #   explicitly included. Example: `projects/123/schemas/my-schema@c7cfa2a8`
+        # @param [String] revision_id
+        #   Optional. This field is deprecated and should not be used for specifying the
+        #   revision ID. The revision ID should be specified via the `name` parameter.
+        # @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::PubsubV1::Schema] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::PubsubV1::Schema]
+        #
+        # @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
+        def delete_project_schema_revision(name, revision_id: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:delete, 'v1/{+name}:deleteRevision', options)
+          command.response_representation = Google::Apis::PubsubV1::Schema::Representation
+          command.response_class = Google::Apis::PubsubV1::Schema
+          command.params['name'] = name unless name.nil?
+          command.query['revisionId'] = revision_id unless revision_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
+        
         # Gets a schema.
         # @param [String] name
         #   Required. The name of the schema to get. Format is `projects/`project`/schemas/
@@ -243,6 +314,81 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Lists all schema revisions for the named schema.
+        # @param [String] name
+        #   Required. The name of the schema to list revisions for.
+        # @param [Fixnum] page_size
+        #   The maximum number of revisions to return per page.
+        # @param [String] page_token
+        #   The page token, received from a previous ListSchemaRevisions call. Provide
+        #   this to retrieve the subsequent page.
+        # @param [String] view
+        #   The set of Schema fields to return in the response. If not set, returns
+        #   Schemas with `name` and `type`, but not `definition`. Set to `FULL` to
+        #   retrieve all fields.
+        # @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::PubsubV1::ListSchemaRevisionsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::PubsubV1::ListSchemaRevisionsResponse]
+        #
+        # @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
+        def list_project_schema_revisions(name, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+name}:listRevisions', options)
+          command.response_representation = Google::Apis::PubsubV1::ListSchemaRevisionsResponse::Representation
+          command.response_class = Google::Apis::PubsubV1::ListSchemaRevisionsResponse
+          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['view'] = view unless view.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Creates a new schema revision that is a copy of the provided revision_id.
+        # @param [String] name
+        #   Required. The schema being rolled back with revision id.
+        # @param [Google::Apis::PubsubV1::RollbackSchemaRequest] rollback_schema_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::PubsubV1::Schema] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::PubsubV1::Schema]
+        #
+        # @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
+        def rollback_schema(name, rollback_schema_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+name}:rollback', options)
+          command.request_representation = Google::Apis::PubsubV1::RollbackSchemaRequest::Representation
+          command.request_object = rollback_schema_request_object
+          command.response_representation = Google::Apis::PubsubV1::Schema::Representation
+          command.response_class = Google::Apis::PubsubV1::Schema
+          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
+        
         # Sets the access control policy on the specified resource. Replaces any
         # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
         # PERMISSION_DENIED` errors.
@@ -398,15 +544,17 @@ module Google
         # returned. See also the `Snapshot.expire_time` field. If the name is not
         # provided in the request, the server will assign a random name for this
         # snapshot on the same project as the subscription, conforming to the [resource
-        # name format] (https://cloud.google.com/pubsub/docs/admin#resource_names). The
-        # generated name is populated in the returned Snapshot object. Note that for
-        # REST API requests, you must specify a name in the request.
+        # name format] (https://cloud.google.com/pubsub/docs/pubsub-basics#
+        # resource_names). The generated name is populated in the returned Snapshot
+        # object. Note that for REST API requests, you must specify a name in the
+        # request.
         # @param [String] name
         #   Required. User-provided name for this snapshot. If the name is not provided in
         #   the request, the server will assign a random name for this snapshot on the
         #   same project as the subscription. Note that for REST API requests, you must
         #   specify a name. See the [resource name rules](https://cloud.google.com/pubsub/
-        #   docs/admin#resource_names). Format is `projects/`project`/snapshots/`snap``.
+        #   docs/pubsub-basics#resource_names). Format is `projects/`project`/snapshots/`
+        #   snap``.
         # @param [Google::Apis::PubsubV1::CreateSnapshotRequest] create_snapshot_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -563,11 +711,11 @@ module Google
         #   Required. The name of the project in which to list snapshots. Format is `
         #   projects/`project-id``.
         # @param [Fixnum] page_size
-        #   Maximum number of snapshots to return.
+        #   Optional. Maximum number of snapshots to return.
         # @param [String] page_token
-        #   The value returned by the last `ListSnapshotsResponse`; indicates that this is
-        #   a continuation of a prior `ListSnapshots` call, and that the system should
-        #   return the next page of data.
+        #   Optional. The value returned by the last `ListSnapshotsResponse`; indicates
+        #   that this is a continuation of a prior `ListSnapshots` call, and that the
+        #   system should return the next page of data.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -597,12 +745,13 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Updates an existing snapshot. Snapshots are used in [Seek](https://cloud.
-        # google.com/pubsub/docs/replay-overview) operations, which allow you to manage
-        # message acknowledgments in bulk. That is, you can set the acknowledgment state
-        # of messages in an existing subscription to the state captured by a snapshot.
+        # Updates an existing snapshot by updating the fields specified in the update
+        # mask. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-
+        # overview) operations, which allow you to manage message acknowledgments in
+        # bulk. That is, you can set the acknowledgment state of messages in an existing
+        # subscription to the state captured by a snapshot.
         # @param [String] name
-        #   The name of the snapshot.
+        #   Optional. The name of the snapshot.
         # @param [Google::Apis::PubsubV1::UpdateSnapshotRequest] update_snapshot_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -748,14 +897,14 @@ module Google
         end
         
         # Creates a subscription to a given topic. See the [resource name rules] (https:/
-        # /cloud.google.com/pubsub/docs/admin#resource_names). If the subscription
-        # already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't
-        # exist, returns `NOT_FOUND`. If the name is not provided in the request, the
-        # server will assign a random name for this subscription on the same project as
-        # the topic, conforming to the [resource name format] (https://cloud.google.com/
-        # pubsub/docs/admin#resource_names). The generated name is populated in the
-        # returned Subscription object. Note that for REST API requests, you must
-        # specify a name in the request.
+        # /cloud.google.com/pubsub/docs/pubsub-basics#resource_names). If the
+        # subscription already exists, returns `ALREADY_EXISTS`. If the corresponding
+        # topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the
+        # request, the server will assign a random name for this subscription on the
+        # same project as the topic, conforming to the [resource name format] (https://
+        # cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The generated name
+        # is populated in the returned Subscription object. Note that for REST API
+        # requests, you must specify a name in the request.
         # @param [String] name
         #   Required. The name of the subscription. It must have the format `"projects/`
         #   project`/subscriptions/`subscription`"`. ``subscription`` must start with a
@@ -943,11 +1092,11 @@ module Google
         #   Required. The name of the project in which to list subscriptions. Format is `
         #   projects/`project-id``.
         # @param [Fixnum] page_size
-        #   Maximum number of subscriptions to return.
+        #   Optional. Maximum number of subscriptions to return.
         # @param [String] page_token
-        #   The value returned by the last `ListSubscriptionsResponse`; indicates that
-        #   this is a continuation of a prior `ListSubscriptions` call, and that the
-        #   system should return the next page of data.
+        #   Optional. The value returned by the last `ListSubscriptionsResponse`;
+        #   indicates that this is a continuation of a prior `ListSubscriptions` call, and
+        #   that the system should return the next page of data.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -1053,8 +1202,9 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Updates an existing subscription. Note that certain properties of a
-        # subscription, such as its topic, are not modifiable.
+        # Updates an existing subscription by updating the fields specified in the
+        # update mask. Note that certain properties of a subscription, such as its topic,
+        # are not modifiable.
         # @param [String] name
         #   Required. The name of the subscription. It must have the format `"projects/`
         #   project`/subscriptions/`subscription`"`. ``subscription`` must start with a
@@ -1242,7 +1392,7 @@ module Google
         end
         
         # Creates the given topic with the given name. See the [resource name rules] (
-        # https://cloud.google.com/pubsub/docs/admin#resource_names).
+        # https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
         # @param [String] name
         #   Required. The name of the topic. It must have the format `"projects/`project`/
         #   topics/`topic`"`. ``topic`` must start with a letter, and contain only letters
@@ -1395,11 +1545,11 @@ module Google
         #   Required. The name of the project in which to list topics. Format is `projects/
         #   `project-id``.
         # @param [Fixnum] page_size
-        #   Maximum number of topics to return.
+        #   Optional. Maximum number of topics to return.
         # @param [String] page_token
-        #   The value returned by the last `ListTopicsResponse`; indicates that this is a
-        #   continuation of a prior `ListTopics` call, and that the system should return
-        #   the next page of data.
+        #   Optional. The value returned by the last `ListTopicsResponse`; indicates that
+        #   this is a continuation of a prior `ListTopics` call, and that the system
+        #   should return the next page of data.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -1429,8 +1579,8 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Updates an existing topic. Note that certain properties of a topic are not
-        # modifiable.
+        # Updates an existing topic by updating the fields specified in the update mask.
+        # Note that certain properties of a topic are not modifiable.
         # @param [String] name
         #   Required. The name of the topic. It must have the format `"projects/`project`/
         #   topics/`topic`"`. ``topic`` must start with a letter, and contain only letters
@@ -1587,11 +1737,11 @@ module Google
         #   Required. The name of the topic that snapshots are attached to. Format is `
         #   projects/`project`/topics/`topic``.
         # @param [Fixnum] page_size
-        #   Maximum number of snapshot names to return.
+        #   Optional. Maximum number of snapshot names to return.
         # @param [String] page_token
-        #   The value returned by the last `ListTopicSnapshotsResponse`; indicates that
-        #   this is a continuation of a prior `ListTopicSnapshots` call, and that the
-        #   system should return the next page of data.
+        #   Optional. The value returned by the last `ListTopicSnapshotsResponse`;
+        #   indicates that this is a continuation of a prior `ListTopicSnapshots` call,
+        #   and that the system should return the next page of data.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -1626,11 +1776,11 @@ module Google
         #   Required. The name of the topic that subscriptions are attached to. Format is `
         #   projects/`project`/topics/`topic``.
         # @param [Fixnum] page_size
-        #   Maximum number of subscription names to return.
+        #   Optional. Maximum number of subscription names to return.
         # @param [String] page_token
-        #   The value returned by the last `ListTopicSubscriptionsResponse`; indicates
-        #   that this is a continuation of a prior `ListTopicSubscriptions` call, and that
-        #   the system should return the next page of data.
+        #   Optional. The value returned by the last `ListTopicSubscriptionsResponse`;
+        #   indicates that this is a continuation of a prior `ListTopicSubscriptions` call,
+        #   and that the system should return the next page of data.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-pubsub_v1
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.53.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-19 00:00:00.000000000 Z
+date: 2024-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.15.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.15.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-pubsub_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-pubsub_v1/v0.28.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-pubsub_v1/v0.53.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-pubsub_v1
 post_install_message: 
 rdoc_options: []
@@ -68,14 +68,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.5.6
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Cloud Pub/Sub API V1