google-cloud-pubsub-v1 0.1.2 → 0.2.0

data/lib/google/pubsub/v1/schema_services_pb.rb

@@ -0,0 +1,58 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/pubsub/v1/schema.proto for package 'Google.Cloud.PubSub.V1'
+# Original file comments:
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'grpc'
+require 'google/pubsub/v1/schema_pb'
+
+module Google
+  module Cloud
+    module PubSub
+      module V1
+        module SchemaService
+          # Service for doing schema-related operations.
+          #
+          # EXPERIMENTAL: The Schema service is in development and may not work yet.
+          #
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.pubsub.v1.SchemaService'
+
+            # Creates a schema.
+            rpc :CreateSchema, ::Google::Cloud::PubSub::V1::CreateSchemaRequest, ::Google::Cloud::PubSub::V1::Schema
+            # Gets a schema.
+            rpc :GetSchema, ::Google::Cloud::PubSub::V1::GetSchemaRequest, ::Google::Cloud::PubSub::V1::Schema
+            # Lists schemas in a project.
+            rpc :ListSchemas, ::Google::Cloud::PubSub::V1::ListSchemasRequest, ::Google::Cloud::PubSub::V1::ListSchemasResponse
+            # Deletes a schema.
+            rpc :DeleteSchema, ::Google::Cloud::PubSub::V1::DeleteSchemaRequest, ::Google::Protobuf::Empty
+            # Validates a schema.
+            rpc :ValidateSchema, ::Google::Cloud::PubSub::V1::ValidateSchemaRequest, ::Google::Cloud::PubSub::V1::ValidateSchemaResponse
+            # Validates a message against a schema.
+            rpc :ValidateMessage, ::Google::Cloud::PubSub::V1::ValidateMessageRequest, ::Google::Cloud::PubSub::V1::ValidateMessageResponse
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/api/resource.rb

@@ -43,12 +43,12 @@ module Google
     #
     # The ResourceDescriptor Yaml config will look like:
     #
-    #    resources:
-    #    - type: "pubsub.googleapis.com/Topic"
-    #      name_descriptor:
-    #        - pattern: "projects/\\{project}/topics/\\{topic}"
-    #          parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #          parent_name_extractor: "projects/\\{project}"
+    #     resources:
+    #     - type: "pubsub.googleapis.com/Topic"
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
     #
     # Sometimes, resources have multiple patterns, typically because they can
     # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
     #         }
     # @!attribute [rw] plural
     #   @return [::String]
-    #     The plural name used in the resource name, such as 'projects' for
-    #     the name of 'projects/\\{project}'. It is the same concept of the `plural`
-    #     field in k8s CRD spec
+    #     The plural name used in the resource name and permission names, such as
+    #     'projects' for the resource name of 'projects/\\{project}' and the permission
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
+    #     concept of the `plural` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #
+    #     Note: The plural form is required even for singleton resources. See
+    #     https://aip.dev/156
     # @!attribute [rw] singular
     #   @return [::String]
     #     The same concept of the `singular` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
     #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    # @!attribute [rw] style
+    #   @return [::Array<::Google::Api::ResourceDescriptor::Style>]
+    #     Style flag(s) for this resource.
+    #     These indicate that a resource is expected to conform to a given
+    #     style. See the specific style flags for additional information.
     class ResourceDescriptor
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
         # that from being necessary once there are multiple patterns.)
         FUTURE_MULTI_PATTERN = 2
       end
+
+      # A flag representing a specific style that a resource claims to conform to.
+      module Style
+        # The unspecified value. Do not use.
+        STYLE_UNSPECIFIED = 0
+
+        # This resource is intended to be "declarative-friendly".
+        #
+        # Declarative-friendly resources must be more strictly consistent, and
+        # setting this to true communicates to tools that this resource should
+        # adhere to declarative-friendly expectations.
+        #
+        # Note: This is used by the API linter (linter.aip.dev) to enable
+        # additional checks.
+        DECLARATIVE_FRIENDLY = 1
+      end
     end
 
     # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
     #             type: "pubsub.googleapis.com/Topic"
     #           }];
     #         }
+    #
+    #     Occasionally, a field may reference an arbitrary resource. In this case,
+    #     APIs use the special value * in their resource reference.
+    #
+    #     Example:
+    #
+    #         message GetIamPolicyRequest {
+    #           string resource = 2 [(google.api.resource_reference) = {
+    #             type: "*"
+    #           }];
+    #         }
     # @!attribute [rw] child_type
     #   @return [::String]
     #     The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
     #
     #     Example:
     #
-    #       message ListLogEntriesRequest {
-    #         string parent = 1 [(google.api.resource_reference) = {
-    #           child_type: "logging.googleapis.com/LogEntry"
-    #         };
-    #       }
+    #         message ListLogEntriesRequest {
+    #           string parent = 1 [(google.api.resource_reference) = {
+    #             child_type: "logging.googleapis.com/LogEntry"
+    #           };
+    #         }
     class ResourceReference
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/pubsub/v1/pubsub.rb

@@ -34,6 +34,21 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Settings for validating messages published against a schema.
+        # @!attribute [rw] schema
+        #   @return [::String]
+        #     Required. The name of the schema that messages published should be
+        #     validated against. Format is `projects/{project}/schemas/{schema}`. The
+        #     value of this field will be `_deleted-schema_` if the schema has been
+        #     deleted.
+        # @!attribute [rw] encoding
+        #   @return [::Google::Cloud::PubSub::V1::Encoding]
+        #     The encoding of messages validated against `schema`.
+        class SchemaSettings
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # A topic resource.
         # @!attribute [rw] name
         #   @return [::String]
@@ -58,6 +73,15 @@ module Google
         #     to messages published on this topic.
         #
         #     The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
+        # @!attribute [rw] schema_settings
+        #   @return [::Google::Cloud::PubSub::V1::SchemaSettings]
+        #     Settings for validating messages published against a schema.
+        #
+        #     EXPERIMENTAL: Schema support is in development and may not work yet.
+        # @!attribute [rw] satisfies_pzs
+        #   @return [::Boolean]
+        #     Reserved for future use. This field is set only in responses from the
+        #     server; it is ignored if it is set in any requests.
         class Topic
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/pubsub/v1/schema.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module PubSub
+      module V1
+        # A schema resource.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the schema.
+        #     Format is `projects/{project}/schemas/{schema}`.
+        # @!attribute [rw] type
+        #   @return [::Google::Cloud::PubSub::V1::Schema::Type]
+        #     The type of the schema definition.
+        # @!attribute [rw] definition
+        #   @return [::String]
+        #     The definition of the schema. This should contain a string representing
+        #     the full definition of the schema that is a valid schema definition of
+        #     the type specified in `type`.
+        class Schema
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Possible schema definition types.
+          module Type
+            # Default value. This value is unused.
+            TYPE_UNSPECIFIED = 0
+
+            # A Protocol Buffer schema definition.
+            PROTOCOL_BUFFER = 1
+
+            # An Avro schema definition.
+            AVRO = 2
+          end
+        end
+
+        # Request for the CreateSchema method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The name of the project in which to create the schema.
+        #     Format is `projects/{project-id}`.
+        # @!attribute [rw] schema
+        #   @return [::Google::Cloud::PubSub::V1::Schema]
+        #     Required. The schema object to create.
+        #
+        #     This schema's `name` parameter is ignored. The schema object returned
+        #     by CreateSchema will have a `name` made using the given `parent` and
+        #     `schema_id`.
+        # @!attribute [rw] schema_id
+        #   @return [::String]
+        #     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#resource_names for resource
+        #     name constraints.
+        class CreateSchemaRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the GetSchema method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the schema to get.
+        #     Format is `projects/{project}/schemas/{schema}`.
+        # @!attribute [rw] view
+        #   @return [::Google::Cloud::PubSub::V1::SchemaView]
+        #     The set of fields to return in the response. If not set, returns a Schema
+        #     with `name` and `type`, but not `definition`. Set to `FULL` to retrieve all
+        #     fields.
+        class GetSchemaRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the `ListSchemas` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The name of the project in which to list schemas.
+        #     Format is `projects/{project-id}`.
+        # @!attribute [rw] view
+        #   @return [::Google::Cloud::PubSub::V1::SchemaView]
+        #     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.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Maximum number of schemas to return.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     The value returned by the last `ListSchemasResponse`; indicates that
+        #     this is a continuation of a prior `ListSchemas` call, and that the
+        #     system should return the next page of data.
+        class ListSchemasRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response for the `ListSchemas` method.
+        # @!attribute [rw] schemas
+        #   @return [::Array<::Google::Cloud::PubSub::V1::Schema>]
+        #     The resulting schemas.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     If not empty, indicates that there may be more schemas that match the
+        #     request; this value should be passed in a new `ListSchemasRequest`.
+        class ListSchemasResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the `DeleteSchema` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the schema to delete.
+        #     Format is `projects/{project}/schemas/{schema}`.
+        class DeleteSchemaRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the `ValidateSchema` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The name of the project in which to validate schemas.
+        #     Format is `projects/{project-id}`.
+        # @!attribute [rw] schema
+        #   @return [::Google::Cloud::PubSub::V1::Schema]
+        #     Required. The schema object to validate.
+        class ValidateSchemaRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response for the `ValidateSchema` method.
+        class ValidateSchemaResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the `ValidateMessage` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The name of the project in which to validate schemas.
+        #     Format is `projects/{project-id}`.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Name of the schema against which to validate.
+        #
+        #     Format is `projects/{project}/schemas/{schema}`.
+        # @!attribute [rw] schema
+        #   @return [::Google::Cloud::PubSub::V1::Schema]
+        #     Ad-hoc schema against which to validate
+        # @!attribute [rw] message
+        #   @return [::String]
+        #     Message to validate against the provided `schema_spec`.
+        # @!attribute [rw] encoding
+        #   @return [::Google::Cloud::PubSub::V1::Encoding]
+        #     The encoding expected for messages
+        class ValidateMessageRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response for the `ValidateMessage` method.
+        class ValidateMessageResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # View of Schema object fields to be returned by GetSchema and ListSchemas.
+        module SchemaView
+          # The default / unset value.
+          # The API will default to the BASIC view.
+          SCHEMA_VIEW_UNSPECIFIED = 0
+
+          # Include the name and type of the schema, but not the definition.
+          BASIC = 1
+
+          # Include all Schema object fields.
+          FULL = 2
+        end
+
+        # Possible encoding types for messages.
+        module Encoding
+          # Unspecified
+          ENCODING_UNSPECIFIED = 0
+
+          # JSON encoding
+          JSON = 1
+
+          # Binary encoding, as defined by the schema type. For some schema types,
+          # binary encoding may not be available.
+          BINARY = 2
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-pubsub-v1
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-10 00:00:00.000000000 Z
+date: 2021-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -191,6 +191,10 @@ files:
 - lib/google/cloud/pubsub/v1/publisher/credentials.rb
 - lib/google/cloud/pubsub/v1/publisher/helpers.rb
 - lib/google/cloud/pubsub/v1/publisher/paths.rb
+- lib/google/cloud/pubsub/v1/schema_service.rb
+- lib/google/cloud/pubsub/v1/schema_service/client.rb
+- lib/google/cloud/pubsub/v1/schema_service/credentials.rb
+- lib/google/cloud/pubsub/v1/schema_service/paths.rb
 - lib/google/cloud/pubsub/v1/subscriber.rb
 - lib/google/cloud/pubsub/v1/subscriber/client.rb
 - lib/google/cloud/pubsub/v1/subscriber/credentials.rb
@@ -200,6 +204,8 @@ files:
 - lib/google/iam/v1/iam_policy_services_pb.rb
 - lib/google/pubsub/v1/pubsub_pb.rb
 - lib/google/pubsub/v1/pubsub_services_pb.rb
+- lib/google/pubsub/v1/schema_pb.rb
+- lib/google/pubsub/v1/schema_services_pb.rb
 - proto_docs/README.md
 - proto_docs/google/api/field_behavior.rb
 - proto_docs/google/api/resource.rb
@@ -211,6 +217,7 @@ files:
 - proto_docs/google/protobuf/field_mask.rb
 - proto_docs/google/protobuf/timestamp.rb
 - proto_docs/google/pubsub/v1/pubsub.rb
+- proto_docs/google/pubsub/v1/schema.rb
 - proto_docs/google/type/expr.rb
 homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
@@ -231,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud Pub/Sub V1 API