google-cloud-document_ai-v1beta3 0.4.0 → 0.9.0

data/proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb

@@ -229,7 +229,140 @@ module Google
           end
         end
 
+        # Request message for fetch processor types.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The project of processor type to list.
+        #     Format: projects/\\{project}/locations/\\{location}
+        class FetchProcessorTypesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for fetch processor types.
+        # @!attribute [rw] processor_types
+        #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::ProcessorType>]
+        #     The list of processor types.
+        class FetchProcessorTypesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for list all processors belongs to a project.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent (project and location) which owns this collection of Processors.
+        #     Format: projects/\\{project}/locations/\\{location}
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of processors to return.
+        #     If unspecified, at most 50 processors will be returned.
+        #     The maximum value is 100; values above 100 will be coerced to 100.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     We will return the processors sorted by creation time. The page token
+        #     will point to the next processor.
+        class ListProcessorsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for list processors.
+        # @!attribute [rw] processors
+        #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Processor>]
+        #     The list of processors.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Points to the next processor, otherwise empty.
+        class ListProcessorsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for create a processor. Notice this request is sent to
+        # a regionalized backend service, and if the processor type is not available
+        # on that region, the creation will fail.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent (project and location) under which to create the processor.
+        #     Format: projects/\\{project}/locations/\\{location}
+        # @!attribute [rw] processor
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::Processor]
+        #     Required. The processor to be created, requires [processor_type] and [display_name]
+        #     to be set. Also, the processor is under CMEK if CMEK fields are set.
+        class CreateProcessorRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the delete processor method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The processor resource name to be deleted.
+        class DeleteProcessorRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The long running operation metadata for delete processor method.
+        # @!attribute [rw] common_metadata
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
+        #     The basic metadata of the long running operation.
+        class DeleteProcessorMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the enable processor method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The processor resource name to be enabled.
+        class EnableProcessorRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for the enable processor method.
+        class EnableProcessorResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The long running operation metadata for enable processor method.
+        # @!attribute [rw] common_metadata
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
+        #     The basic metadata of the long running operation.
+        class EnableProcessorMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the disable processor method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The processor resource name to be disabled.
+        class DisableProcessorRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for the disable processor method.
+        class DisableProcessorResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The long running operation metadata for disable processor method.
+        # @!attribute [rw] common_metadata
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
+        #     The basic metadata of the long running operation.
+        class DisableProcessorMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Request message for review document method.
+        # Next Id: 6.
         # @!attribute [rw] inline_document
         #   @return [::Google::Cloud::DocumentAI::V1beta3::Document]
         #     An inline document proto.
@@ -240,9 +373,25 @@ module Google
         # @!attribute [rw] document
         #   @return [::Google::Cloud::DocumentAI::V1beta3::Document]
         #     The document that needs human review.
+        # @!attribute [rw] enable_schema_validation
+        #   @return [::Boolean]
+        #     Whether the validation should be performed on the ad-hoc review request.
+        # @!attribute [rw] priority
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::ReviewDocumentRequest::Priority]
+        #     The priority of the human review task.
         class ReviewDocumentRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The priority level of the human review task.
+          module Priority
+            # The default priority level.
+            DEFAULT = 0
+
+            # The urgent priority level. The labeling manager should allocate labeler
+            # resource to the urgent task queue to respect this priority level.
+            URGENT = 1
+          end
         end
 
         # Response message for review document method.
@@ -296,45 +445,6 @@ module Google
             CANCELLED = 5
           end
         end
-
-        # The common metadata for long running operations.
-        # @!attribute [rw] state
-        #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata::State]
-        #     The state of the operation.
-        # @!attribute [rw] state_message
-        #   @return [::String]
-        #     A message providing more details about the current state of processing.
-        # @!attribute [rw] create_time
-        #   @return [::Google::Protobuf::Timestamp]
-        #     The creation time of the operation.
-        # @!attribute [rw] update_time
-        #   @return [::Google::Protobuf::Timestamp]
-        #     The last update time of the operation.
-        class CommonOperationMetadata
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-
-          # State of the longrunning operation.
-          module State
-            # Unspecified state.
-            STATE_UNSPECIFIED = 0
-
-            # Operation is still running.
-            RUNNING = 1
-
-            # Operation is being cancelled.
-            CANCELLING = 2
-
-            # Operation succeeded.
-            SUCCEEDED = 3
-
-            # Operation failed.
-            FAILED = 4
-
-            # Operation is cancelled.
-            CANCELLED = 5
-          end
-        end
       end
     end
   end

data/proto_docs/google/cloud/documentai/v1beta3/geometry.rb

@@ -28,7 +28,7 @@ module Google
         #     X coordinate.
         # @!attribute [rw] y
         #   @return [::Integer]
-        #     Y coordinate.
+        #     Y coordinate (starts from the top of the image).
         class Vertex
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -42,7 +42,7 @@ module Google
         #     X coordinate.
         # @!attribute [rw] y
         #   @return [::Float]
-        #     Y coordinate.
+        #     Y coordinate (starts from the top of the image).
         class NormalizedVertex
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/documentai/v1beta3/operation_metadata.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 V1beta3
+        # The common metadata for long running operations.
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata::State]
+        #     The state of the operation.
+        # @!attribute [rw] state_message
+        #   @return [::String]
+        #     A message providing more details about the current state of processing.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The creation time of the operation.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The last update time of the operation.
+        class CommonOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # State of the longrunning operation.
+          module State
+            # Unspecified state.
+            STATE_UNSPECIFIED = 0
+
+            # Operation is still running.
+            RUNNING = 1
+
+            # Operation is being cancelled.
+            CANCELLING = 2
+
+            # Operation succeeded.
+            SUCCEEDED = 3
+
+            # Operation failed.
+            FAILED = 4
+
+            # Operation is cancelled.
+            CANCELLED = 5
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 V1beta3
+        # The first-class citizen for DocumentAI. 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.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     The display name of the processor.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::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.
+            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.
+            CREATING = 5
+
+            # The processor failed during creation.
+            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/v1beta3/processor_type.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 V1beta3
+        # 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.
+        # @!attribute [rw] type
+        #   @return [::String]
+        #     The type of the processor.
+        # @!attribute [rw] category
+        #   @return [::String]
+        #     The processor category.
+        # @!attribute [rw] available_locations
+        #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::ProcessorType::LocationInfo>]
+        #     The locations in which this processor is available.
+        # @!attribute [rw] allow_creation
+        #   @return [::Boolean]
+        #     Whether the processor type allows creation. If yes, user can create a
+        #     processor of this processor type. Otherwise, user needs to require for
+        #     whitelisting.
+        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.
+          class LocationInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-document_ai-v1beta3
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -177,6 +183,9 @@ files:
 - lib/google/cloud/documentai/v1beta3/document_processor_service_pb.rb
 - lib/google/cloud/documentai/v1beta3/document_processor_service_services_pb.rb
 - lib/google/cloud/documentai/v1beta3/geometry_pb.rb
+- lib/google/cloud/documentai/v1beta3/operation_metadata_pb.rb
+- lib/google/cloud/documentai/v1beta3/processor_pb.rb
+- lib/google/cloud/documentai/v1beta3/processor_type_pb.rb
 - proto_docs/README.md
 - proto_docs/google/api/field_behavior.rb
 - proto_docs/google/api/resource.rb
@@ -184,6 +193,9 @@ files:
 - proto_docs/google/cloud/documentai/v1beta3/document_io.rb
 - proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb
 - proto_docs/google/cloud/documentai/v1beta3/geometry.rb
+- proto_docs/google/cloud/documentai/v1beta3/operation_metadata.rb
+- proto_docs/google/cloud/documentai/v1beta3/processor.rb
+- proto_docs/google/cloud/documentai/v1beta3/processor_type.rb
 - proto_docs/google/longrunning/operations.rb
 - proto_docs/google/protobuf/any.rb
 - proto_docs/google/protobuf/duration.rb
@@ -209,14 +221,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.11
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: API Client library for the Document AI V1beta3 API