google-cloud-document_ai-v1 0.4.0 → 0.6.0

data/proto_docs/google/cloud/documentai/v1/processor.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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 DocumentAI
+      module V1
+        # A processor version is an implementation of a processor. Each processor
+        # can have multiple versions, pre-trained by Google internally or up-trained
+        # by the customer. At a time, a processor can only have one default version
+        # version. So the processor's behavior (when processing documents) is defined
+        # by a default version
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The resource name of the processor version.
+        #     Format:
+        #     `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     The display name of the processor version.
+        # @!attribute [rw] document_schema
+        #   @return [::Google::Cloud::DocumentAI::V1::DocumentSchema]
+        #     The schema of the processor version. Describes the output.
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::State]
+        #     The state of the processor version.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time the processor version was created.
+        # @!attribute [rw] kms_key_name
+        #   @return [::String]
+        #     The KMS key name used for encryption.
+        # @!attribute [rw] kms_key_version_name
+        #   @return [::String]
+        #     The KMS key version with which data is encrypted.
+        # @!attribute [rw] google_managed
+        #   @return [::Boolean]
+        #     Denotes that this ProcessorVersion is managed by google.
+        # @!attribute [rw] deprecation_info
+        #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::DeprecationInfo]
+        #     If set, information about the eventual deprecation of this version.
+        class ProcessorVersion
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Information about the upcoming deprecation of this processor version.
+          # @!attribute [rw] deprecation_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time at which this processor version will be deprecated.
+          # @!attribute [rw] replacement_processor_version
+          #   @return [::String]
+          #     If set, the processor version that will be used as a replacement.
+          class DeprecationInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The possible states of the processor version.
+          module State
+            # The processor version is in an unspecified state.
+            STATE_UNSPECIFIED = 0
+
+            # The processor version is deployed and can be used for processing.
+            DEPLOYED = 1
+
+            # The processor version is being deployed.
+            DEPLOYING = 2
+
+            # The processor version is not deployed and cannot be used for processing.
+            UNDEPLOYED = 3
+
+            # The processor version is being undeployed.
+            UNDEPLOYING = 4
+
+            # The processor version is being created.
+            CREATING = 5
+
+            # The processor version is being deleted.
+            DELETING = 6
+
+            # The processor version failed and is in an indeterminate state.
+            FAILED = 7
+          end
+        end
+
+        # The first-class citizen for Document AI. Each processor defines how to
+        # extract structural information from a document.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. Immutable. The resource name of the processor.
+        #     Format: `projects/{project}/locations/{location}/processors/{processor}`
+        # @!attribute [rw] type
+        #   @return [::String]
+        #     The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.
+        #     To get a list of processors types, see
+        #     {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#fetch_processor_types FetchProcessorTypes}.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     The display name of the processor.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::DocumentAI::V1::Processor::State]
+        #     Output only. The state of the processor.
+        # @!attribute [rw] default_processor_version
+        #   @return [::String]
+        #     The default processor version.
+        # @!attribute [r] process_endpoint
+        #   @return [::String]
+        #     Output only. Immutable. The http endpoint that can be called to invoke processing.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time the processor was created.
+        # @!attribute [rw] kms_key_name
+        #   @return [::String]
+        #     The KMS key used for encryption/decryption in CMEK scenarios.
+        #     See https://cloud.google.com/security-key-management.
+        class Processor
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The possible states of the processor.
+          module State
+            # The processor is in an unspecified state.
+            STATE_UNSPECIFIED = 0
+
+            # The processor is enabled, i.e., has an enabled version which can
+            # currently serve processing requests and all the feature dependencies have
+            # been successfully initialized.
+            ENABLED = 1
+
+            # The processor is disabled.
+            DISABLED = 2
+
+            # The processor is being enabled, will become `ENABLED` if successful.
+            ENABLING = 3
+
+            # The processor is being disabled, will become `DISABLED` if successful.
+            DISABLING = 4
+
+            # The processor is being created, will become either `ENABLED` (for
+            # successful creation) or `FAILED` (for failed ones).
+            # Once a processor is in this state, it can then be used for document
+            # processing, but the feature dependencies of the processor might not be
+            # fully created yet.
+            CREATING = 5
+
+            # The processor failed during creation or initialization of feature
+            # dependencies. The user should delete the processor and recreate one as
+            # all the functionalities of the processor are disabled.
+            FAILED = 6
+
+            # The processor is being deleted, will be removed if successful.
+            DELETING = 7
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/documentai/v1/processor_type.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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 DocumentAI
+      module V1
+        # A processor type is responsible for performing a certain document
+        # understanding task on a certain type of document.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The resource name of the processor type.
+        #     Format: `projects/{project}/processorTypes/{processor_type}`
+        # @!attribute [rw] type
+        #   @return [::String]
+        #     The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.
+        # @!attribute [rw] category
+        #   @return [::String]
+        #     The processor category, used by UI to group processor types.
+        # @!attribute [rw] available_locations
+        #   @return [::Array<::Google::Cloud::DocumentAI::V1::ProcessorType::LocationInfo>]
+        #     The locations in which this processor is available.
+        # @!attribute [rw] allow_creation
+        #   @return [::Boolean]
+        #     Whether the processor type allows creation. If true, users can create a
+        #     processor of this processor type. Otherwise, users need to request access.
+        # @!attribute [rw] launch_stage
+        #   @return [::Google::Api::LaunchStage]
+        #     Launch stage of the processor type
+        class ProcessorType
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The location information about where the processor is available.
+          # @!attribute [rw] location_id
+          #   @return [::String]
+          #     The location id, currently must be one of [us, eu].
+          class LocationInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/protobuf/empty.rb

@@ -26,8 +26,6 @@ module Google
     #     service Foo {
     #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
     #     }
-    #
-    # The JSON representation for `Empty` is empty JSON object `{}`.
     class Empty
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/protobuf/field_mask.rb

@@ -0,0 +1,229 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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 Protobuf
+    # `FieldMask` represents a set of symbolic field paths, for example:
+    #
+    #     paths: "f.a"
+    #     paths: "f.b.d"
+    #
+    # Here `f` represents a field in some root message, `a` and `b`
+    # fields in the message found in `f`, and `d` a field found in the
+    # message in `f.b`.
+    #
+    # Field masks are used to specify a subset of fields that should be
+    # returned by a get operation or modified by an update operation.
+    # Field masks also have a custom JSON encoding (see below).
+    #
+    # # Field Masks in Projections
+    #
+    # When used in the context of a projection, a response message or
+    # sub-message is filtered by the API to only contain those fields as
+    # specified in the mask. For example, if the mask in the previous
+    # example is applied to a response message as follows:
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #         x : 2
+    #       }
+    #       y : 13
+    #     }
+    #     z: 8
+    #
+    # The result will not contain specific values for fields x,y and z
+    # (their value will be set to the default, and omitted in proto text
+    # output):
+    #
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #       }
+    #     }
+    #
+    # A repeated field is not allowed except at the last position of a
+    # paths string.
+    #
+    # If a FieldMask object is not present in a get operation, the
+    # operation applies to all fields (as if a FieldMask of all fields
+    # had been specified).
+    #
+    # Note that a field mask does not necessarily apply to the
+    # top-level response message. In case of a REST get operation, the
+    # field mask applies directly to the response, but in case of a REST
+    # list operation, the mask instead applies to each individual message
+    # in the returned resource list. In case of a REST custom method,
+    # other definitions may be used. Where the mask applies will be
+    # clearly documented together with its declaration in the API.  In
+    # any case, the effect on the returned resource/resources is required
+    # behavior for APIs.
+    #
+    # # Field Masks in Update Operations
+    #
+    # A field mask in update operations specifies which fields of the
+    # targeted resource are going to be updated. The API is required
+    # to only change the values of the fields as specified in the mask
+    # and leave the others untouched. If a resource is passed in to
+    # describe the updated values, the API ignores the values of all
+    # fields not covered by the mask.
+    #
+    # If a repeated field is specified for an update operation, new values will
+    # be appended to the existing repeated field in the target resource. Note that
+    # a repeated field is only allowed in the last position of a `paths` string.
+    #
+    # If a sub-message is specified in the last position of the field mask for an
+    # update operation, then new value will be merged into the existing sub-message
+    # in the target resource.
+    #
+    # For example, given the target message:
+    #
+    #     f {
+    #       b {
+    #         d: 1
+    #         x: 2
+    #       }
+    #       c: [1]
+    #     }
+    #
+    # And an update message:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #       }
+    #       c: [2]
+    #     }
+    #
+    # then if the field mask is:
+    #
+    #  paths: ["f.b", "f.c"]
+    #
+    # then the result will be:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #         x: 2
+    #       }
+    #       c: [1, 2]
+    #     }
+    #
+    # An implementation may provide options to override this default behavior for
+    # repeated and message fields.
+    #
+    # In order to reset a field's value to the default, the field must
+    # be in the mask and set to the default value in the provided resource.
+    # Hence, in order to reset all fields of a resource, provide a default
+    # instance of the resource and set all fields in the mask, or do
+    # not provide a mask as described below.
+    #
+    # If a field mask is not present on update, the operation applies to
+    # all fields (as if a field mask of all fields has been specified).
+    # Note that in the presence of schema evolution, this may mean that
+    # fields the client does not know and has therefore not filled into
+    # the request will be reset to their default. If this is unwanted
+    # behavior, a specific service may require a client to always specify
+    # a field mask, producing an error if not.
+    #
+    # As with get operations, the location of the resource which
+    # describes the updated values in the request message depends on the
+    # operation kind. In any case, the effect of the field mask is
+    # required to be honored by the API.
+    #
+    # ## Considerations for HTTP REST
+    #
+    # The HTTP kind of an update operation which uses a field mask must
+    # be set to PATCH instead of PUT in order to satisfy HTTP semantics
+    # (PUT must only be used for full updates).
+    #
+    # # JSON Encoding of Field Masks
+    #
+    # In JSON, a field mask is encoded as a single string where paths are
+    # separated by a comma. Fields name in each path are converted
+    # to/from lower-camel naming conventions.
+    #
+    # As an example, consider the following message declarations:
+    #
+    #     message Profile {
+    #       User user = 1;
+    #       Photo photo = 2;
+    #     }
+    #     message User {
+    #       string display_name = 1;
+    #       string address = 2;
+    #     }
+    #
+    # In proto a field mask for `Profile` may look as such:
+    #
+    #     mask {
+    #       paths: "user.display_name"
+    #       paths: "photo"
+    #     }
+    #
+    # In JSON, the same mask is represented as below:
+    #
+    #     {
+    #       mask: "user.displayName,photo"
+    #     }
+    #
+    # # Field Masks and Oneof Fields
+    #
+    # Field masks treat fields in oneofs just as regular fields. Consider the
+    # following message:
+    #
+    #     message SampleMessage {
+    #       oneof test_oneof {
+    #         string name = 4;
+    #         SubMessage sub_message = 9;
+    #       }
+    #     }
+    #
+    # The field mask can be:
+    #
+    #     mask {
+    #       paths: "name"
+    #     }
+    #
+    # Or:
+    #
+    #     mask {
+    #       paths: "sub_message"
+    #     }
+    #
+    # Note that oneof type names ("test_oneof" in this case) cannot be used in
+    # paths.
+    #
+    # ## Field Mask Verification
+    #
+    # The implementation of any API method which has a FieldMask type field in the
+    # request should verify the included field paths, and return an
+    # `INVALID_ARGUMENT` error if any path is unmappable.
+    # @!attribute [rw] paths
+    #   @return [::Array<::String>]
+    #     The set of field mask paths.
+    class FieldMask
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-document_ai-v1
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-02 00:00:00.000000000 Z
+date: 2022-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.12'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.12'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -44,6 +44,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-location
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-style
   requirement: !ruby/object:Gem::Requirement
@@ -178,24 +198,34 @@ files:
 - lib/google/cloud/document_ai/v1/document_processor_service/operations.rb
 - lib/google/cloud/document_ai/v1/document_processor_service/paths.rb
 - lib/google/cloud/document_ai/v1/version.rb
+- lib/google/cloud/documentai/v1/barcode_pb.rb
 - lib/google/cloud/documentai/v1/document_io_pb.rb
 - lib/google/cloud/documentai/v1/document_pb.rb
 - lib/google/cloud/documentai/v1/document_processor_service_pb.rb
 - lib/google/cloud/documentai/v1/document_processor_service_services_pb.rb
+- lib/google/cloud/documentai/v1/document_schema_pb.rb
 - lib/google/cloud/documentai/v1/geometry_pb.rb
 - lib/google/cloud/documentai/v1/operation_metadata_pb.rb
+- lib/google/cloud/documentai/v1/processor_pb.rb
+- lib/google/cloud/documentai/v1/processor_type_pb.rb
 - proto_docs/README.md
 - proto_docs/google/api/field_behavior.rb
+- proto_docs/google/api/launch_stage.rb
 - proto_docs/google/api/resource.rb
+- proto_docs/google/cloud/documentai/v1/barcode.rb
 - proto_docs/google/cloud/documentai/v1/document.rb
 - proto_docs/google/cloud/documentai/v1/document_io.rb
 - proto_docs/google/cloud/documentai/v1/document_processor_service.rb
+- proto_docs/google/cloud/documentai/v1/document_schema.rb
 - proto_docs/google/cloud/documentai/v1/geometry.rb
 - proto_docs/google/cloud/documentai/v1/operation_metadata.rb
+- proto_docs/google/cloud/documentai/v1/processor.rb
+- proto_docs/google/cloud/documentai/v1/processor_type.rb
 - proto_docs/google/longrunning/operations.rb
 - proto_docs/google/protobuf/any.rb
 - proto_docs/google/protobuf/duration.rb
 - proto_docs/google/protobuf/empty.rb
+- proto_docs/google/protobuf/field_mask.rb
 - proto_docs/google/protobuf/timestamp.rb
 - proto_docs/google/protobuf/wrappers.rb
 - proto_docs/google/rpc/status.rb