google-cloud-data_labeling-v1beta1 0.1.0

data/proto_docs/google/cloud/datalabeling/v1beta1/instruction.rb

@@ -0,0 +1,88 @@
+# 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 DataLabeling
+      module V1beta1
+        # Instruction of how to perform the labeling task for human operators.
+        # Currently only PDF instruction is supported.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Output only. Instruction resource name, format:
+        #     projects/\\{project_id}/instructions/\\{instruction_id}
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The display name of the instruction. Maximum of 64 characters.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. User-provided description of the instruction.
+        #     The description can be up to 10000 characters long.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Creation time of instruction.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Last update time of instruction.
+        # @!attribute [rw] data_type
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::DataType]
+        #     Required. The data type of this instruction.
+        # @!attribute [rw] csv_instruction
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::CsvInstruction]
+        #     Deprecated: this instruction format is not supported any more.
+        #     Instruction from a CSV file, such as for classification task.
+        #     The CSV file should have exact two columns, in the following format:
+        #
+        #     * The first column is labeled data, such as an image reference, text.
+        #     * The second column is comma separated labels associated with data.
+        # @!attribute [rw] pdf_instruction
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::PdfInstruction]
+        #     Instruction from a PDF document. The PDF should be in a Cloud Storage
+        #     bucket.
+        # @!attribute [rw] blocking_resources
+        #   @return [::Array<::String>]
+        #     Output only. The names of any related resources that are blocking changes
+        #     to the instruction.
+        class Instruction
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Deprecated: this instruction format is not supported any more.
+        # Instruction from a CSV file.
+        # @!attribute [rw] gcs_file_uri
+        #   @return [::String]
+        #     CSV file for the instruction. Only gcs path is allowed.
+        class CsvInstruction
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Instruction from a PDF file.
+        # @!attribute [rw] gcs_file_uri
+        #   @return [::String]
+        #     PDF file for the instruction. Only gcs path is allowed.
+        class PdfInstruction
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/datalabeling/v1beta1/operations.rb

@@ -0,0 +1,279 @@
+# 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 DataLabeling
+      module V1beta1
+        # Response used for ImportData longrunning operation.
+        # @!attribute [rw] dataset
+        #   @return [::String]
+        #     Ouptut only. The name of imported dataset.
+        # @!attribute [rw] total_count
+        #   @return [::Integer]
+        #     Output only. Total number of examples requested to import
+        # @!attribute [rw] import_count
+        #   @return [::Integer]
+        #     Output only. Number of examples imported successfully.
+        class ImportDataOperationResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response used for ExportDataset longrunning operation.
+        # @!attribute [rw] dataset
+        #   @return [::String]
+        #     Ouptut only. The name of dataset.
+        #     "projects/*/datasets/*"
+        # @!attribute [rw] total_count
+        #   @return [::Integer]
+        #     Output only. Total number of examples requested to export
+        # @!attribute [rw] export_count
+        #   @return [::Integer]
+        #     Output only. Number of examples exported successfully.
+        # @!attribute [rw] label_stats
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::LabelStats]
+        #     Output only. Statistic infos of labels in the exported dataset.
+        # @!attribute [rw] output_config
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::OutputConfig]
+        #     Output only. output_config in the ExportData request.
+        class ExportDataOperationResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata of an ImportData operation.
+        # @!attribute [rw] dataset
+        #   @return [::String]
+        #     Output only. The name of imported dataset.
+        #     "projects/*/datasets/*"
+        # @!attribute [rw] partial_failures
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     Output only. Partial failures encountered.
+        #     E.g. single files that couldn't be read.
+        #     Status details field will contain standard GCP error details.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when import dataset request was created.
+        class ImportDataOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata of an ExportData operation.
+        # @!attribute [rw] dataset
+        #   @return [::String]
+        #     Output only. The name of dataset to be exported.
+        #     "projects/*/datasets/*"
+        # @!attribute [rw] partial_failures
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     Output only. Partial failures encountered.
+        #     E.g. single files that couldn't be read.
+        #     Status details field will contain standard GCP error details.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when export dataset request was created.
+        class ExportDataOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata of a labeling operation, such as LabelImage or LabelVideo.
+        # Next tag: 20
+        # @!attribute [rw] image_classification_details
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::LabelImageClassificationOperationMetadata]
+        #     Details of label image classification operation.
+        # @!attribute [rw] image_bounding_box_details
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::LabelImageBoundingBoxOperationMetadata]
+        #     Details of label image bounding box operation.
+        # @!attribute [rw] image_bounding_poly_details
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::LabelImageBoundingPolyOperationMetadata]
+        #     Details of label image bounding poly operation.
+        # @!attribute [rw] image_oriented_bounding_box_details
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::LabelImageOrientedBoundingBoxOperationMetadata]
+        #     Details of label image oriented bounding box operation.
+        # @!attribute [rw] image_polyline_details
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::LabelImagePolylineOperationMetadata]
+        #     Details of label image polyline operation.
+        # @!attribute [rw] image_segmentation_details
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::LabelImageSegmentationOperationMetadata]
+        #     Details of label image segmentation operation.
+        # @!attribute [rw] video_classification_details
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::LabelVideoClassificationOperationMetadata]
+        #     Details of label video classification operation.
+        # @!attribute [rw] video_object_detection_details
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::LabelVideoObjectDetectionOperationMetadata]
+        #     Details of label video object detection operation.
+        # @!attribute [rw] video_object_tracking_details
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::LabelVideoObjectTrackingOperationMetadata]
+        #     Details of label video object tracking operation.
+        # @!attribute [rw] video_event_details
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::LabelVideoEventOperationMetadata]
+        #     Details of label video event operation.
+        # @!attribute [rw] text_classification_details
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::LabelTextClassificationOperationMetadata]
+        #     Details of label text classification operation.
+        # @!attribute [rw] text_entity_extraction_details
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::LabelTextEntityExtractionOperationMetadata]
+        #     Details of label text entity extraction operation.
+        # @!attribute [rw] progress_percent
+        #   @return [::Integer]
+        #     Output only. Progress of label operation. Range: [0, 100].
+        # @!attribute [rw] partial_failures
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     Output only. Partial failures encountered.
+        #     E.g. single files that couldn't be read.
+        #     Status details field will contain standard GCP error details.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when labeling request was created.
+        class LabelOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata of a LabelImageClassification operation.
+        # @!attribute [rw] basic_config
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::HumanAnnotationConfig]
+        #     Basic human annotation config used in labeling request.
+        class LabelImageClassificationOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Details of a LabelImageBoundingBox operation metadata.
+        # @!attribute [rw] basic_config
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::HumanAnnotationConfig]
+        #     Basic human annotation config used in labeling request.
+        class LabelImageBoundingBoxOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Details of a LabelImageOrientedBoundingBox operation metadata.
+        # @!attribute [rw] basic_config
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::HumanAnnotationConfig]
+        #     Basic human annotation config.
+        class LabelImageOrientedBoundingBoxOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Details of LabelImageBoundingPoly operation metadata.
+        # @!attribute [rw] basic_config
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::HumanAnnotationConfig]
+        #     Basic human annotation config used in labeling request.
+        class LabelImageBoundingPolyOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Details of LabelImagePolyline operation metadata.
+        # @!attribute [rw] basic_config
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::HumanAnnotationConfig]
+        #     Basic human annotation config used in labeling request.
+        class LabelImagePolylineOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Details of a LabelImageSegmentation operation metadata.
+        # @!attribute [rw] basic_config
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::HumanAnnotationConfig]
+        #     Basic human annotation config.
+        class LabelImageSegmentationOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Details of a LabelVideoClassification operation metadata.
+        # @!attribute [rw] basic_config
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::HumanAnnotationConfig]
+        #     Basic human annotation config used in labeling request.
+        class LabelVideoClassificationOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Details of a LabelVideoObjectDetection operation metadata.
+        # @!attribute [rw] basic_config
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::HumanAnnotationConfig]
+        #     Basic human annotation config used in labeling request.
+        class LabelVideoObjectDetectionOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Details of a LabelVideoObjectTracking operation metadata.
+        # @!attribute [rw] basic_config
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::HumanAnnotationConfig]
+        #     Basic human annotation config used in labeling request.
+        class LabelVideoObjectTrackingOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Details of a LabelVideoEvent operation metadata.
+        # @!attribute [rw] basic_config
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::HumanAnnotationConfig]
+        #     Basic human annotation config used in labeling request.
+        class LabelVideoEventOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Details of a LabelTextClassification operation metadata.
+        # @!attribute [rw] basic_config
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::HumanAnnotationConfig]
+        #     Basic human annotation config used in labeling request.
+        class LabelTextClassificationOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Details of a LabelTextEntityExtraction operation metadata.
+        # @!attribute [rw] basic_config
+        #   @return [::Google::Cloud::DataLabeling::V1beta1::HumanAnnotationConfig]
+        #     Basic human annotation config used in labeling request.
+        class LabelTextEntityExtractionOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata of a CreateInstruction operation.
+        # @!attribute [rw] instruction
+        #   @return [::String]
+        #     The name of the created Instruction.
+        #     projects/\\{project_id}/instructions/\\{instruction_id}
+        # @!attribute [rw] partial_failures
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     Partial failures encountered.
+        #     E.g. single files that couldn't be read.
+        #     Status details field will contain standard GCP error details.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Timestamp when create instruction request was created.
+        class CreateInstructionMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/longrunning/operations.rb

@@ -0,0 +1,150 @@
+# 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 Longrunning
+    # This resource represents a long-running operation that is the result of a
+    # network API call.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The server-assigned name, which is only unique within the same service that
+    #     originally returns it. If you use the default HTTP mapping, the
+    #     `name` should have the format of `operations/some/unique/name`.
+    # @!attribute [rw] metadata
+    #   @return [::Google::Protobuf::Any]
+    #     Service-specific metadata associated with the operation.  It typically
+    #     contains progress information and common metadata such as create time.
+    #     Some services might not provide such metadata.  Any method that returns a
+    #     long-running operation should document the metadata type, if any.
+    # @!attribute [rw] done
+    #   @return [::Boolean]
+    #     If the value is `false`, it means the operation is still in progress.
+    #     If true, the operation is completed, and either `error` or `response` is
+    #     available.
+    # @!attribute [rw] error
+    #   @return [::Google::Rpc::Status]
+    #     The error result of the operation in case of failure or cancellation.
+    # @!attribute [rw] response
+    #   @return [::Google::Protobuf::Any]
+    #     The normal response of the operation in case of success.  If the original
+    #     method returns no data on success, such as `Delete`, the response is
+    #     `google.protobuf.Empty`.  If the original method is standard
+    #     `Get`/`Create`/`Update`, the response should be the resource.  For other
+    #     methods, the response should have the type `XxxResponse`, where `Xxx`
+    #     is the original method name.  For example, if the original method name
+    #     is `TakeSnapshot()`, the inferred response type is
+    #     `TakeSnapshotResponse`.
+    class Operation
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.GetOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource.
+    class GetOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.ListOperations.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation collection.
+    # @!attribute [rw] filter
+    #   @return [::String]
+    #     The standard list filter.
+    # @!attribute [rw] page_size
+    #   @return [::Integer]
+    #     The standard list page size.
+    # @!attribute [rw] page_token
+    #   @return [::String]
+    #     The standard list page token.
+    class ListOperationsRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The response message for Operations.ListOperations.
+    # @!attribute [rw] operations
+    #   @return [::Array<::Google::Longrunning::Operation>]
+    #     A list of operations that matches the specified filter in the request.
+    # @!attribute [rw] next_page_token
+    #   @return [::String]
+    #     The standard List next-page token.
+    class ListOperationsResponse
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.CancelOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to be cancelled.
+    class CancelOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.DeleteOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to be deleted.
+    class DeleteOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # A message representing the message types used by a long-running operation.
+    #
+    # Example:
+    #
+    #   rpc LongRunningRecognize(LongRunningRecognizeRequest)
+    #       returns (google.longrunning.Operation) {
+    #     option (google.longrunning.operation_info) = {
+    #       response_type: "LongRunningRecognizeResponse"
+    #       metadata_type: "LongRunningRecognizeMetadata"
+    #     };
+    #   }
+    # @!attribute [rw] response_type
+    #   @return [::String]
+    #     Required. The message name of the primary return type for this
+    #     long-running operation.
+    #     This type will be used to deserialize the LRO's response.
+    #
+    #     If the response is in a different package from the rpc, a fully-qualified
+    #     message name must be used (e.g. `google.protobuf.Struct`).
+    #
+    #     Note: Altering this value constitutes a breaking change.
+    # @!attribute [rw] metadata_type
+    #   @return [::String]
+    #     Required. The message name of the metadata type for this long-running
+    #     operation.
+    #
+    #     If the response is in a different package from the rpc, a fully-qualified
+    #     message name must be used (e.g. `google.protobuf.Struct`).
+    #
+    #     Note: Altering this value constitutes a breaking change.
+    class OperationInfo
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end