google-cloud-document_ai-v1beta3 0.13.0 → 0.14.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +1 -1
- data/lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb +420 -0
- data/lib/google/cloud/document_ai/v1beta3/document_processor_service/paths.rb +23 -0
- data/lib/google/cloud/document_ai/v1beta3/version.rb +1 -1
- data/lib/google/cloud/documentai/v1beta3/document_io_pb.rb +3 -0
- data/lib/google/cloud/documentai/v1beta3/document_pb.rb +13 -0
- data/lib/google/cloud/documentai/v1beta3/document_processor_service_pb.rb +59 -0
- data/lib/google/cloud/documentai/v1beta3/document_processor_service_services_pb.rb +11 -0
- data/lib/google/cloud/documentai/v1beta3/evaluation_pb.rb +72 -0
- data/lib/google/cloud/documentai/v1beta3/processor_pb.rb +2 -0
- data/proto_docs/google/api/client.rb +318 -0
- data/proto_docs/google/api/launch_stage.rb +3 -3
- data/proto_docs/google/cloud/documentai/v1beta3/barcode.rb +29 -27
- data/proto_docs/google/cloud/documentai/v1beta3/document.rb +55 -11
- data/proto_docs/google/cloud/documentai/v1beta3/document_io.rb +7 -2
- data/proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb +159 -0
- data/proto_docs/google/cloud/documentai/v1beta3/document_schema.rb +4 -3
- data/proto_docs/google/cloud/documentai/v1beta3/evaluation.rb +181 -0
- data/proto_docs/google/cloud/documentai/v1beta3/processor.rb +8 -5
- data/proto_docs/google/cloud/documentai/v1beta3/processor_type.rb +2 -2
- metadata +7 -4
@@ -10,6 +10,7 @@ require 'google/api/resource_pb'
|
|
10
10
|
require 'google/cloud/documentai/v1beta3/document_pb'
|
11
11
|
require 'google/cloud/documentai/v1beta3/document_io_pb'
|
12
12
|
require 'google/cloud/documentai/v1beta3/document_schema_pb'
|
13
|
+
require 'google/cloud/documentai/v1beta3/evaluation_pb'
|
13
14
|
require 'google/cloud/documentai/v1beta3/operation_metadata_pb'
|
14
15
|
require 'google/cloud/documentai/v1beta3/processor_pb'
|
15
16
|
require 'google/cloud/documentai/v1beta3/processor_type_pb'
|
@@ -183,6 +184,31 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
183
184
|
add_message "google.cloud.documentai.v1beta3.SetDefaultProcessorVersionMetadata" do
|
184
185
|
optional :common_metadata, :message, 1, "google.cloud.documentai.v1beta3.CommonOperationMetadata"
|
185
186
|
end
|
187
|
+
add_message "google.cloud.documentai.v1beta3.TrainProcessorVersionRequest" do
|
188
|
+
optional :parent, :string, 1
|
189
|
+
optional :processor_version, :message, 2, "google.cloud.documentai.v1beta3.ProcessorVersion"
|
190
|
+
optional :document_schema, :message, 10, "google.cloud.documentai.v1beta3.DocumentSchema"
|
191
|
+
optional :input_data, :message, 4, "google.cloud.documentai.v1beta3.TrainProcessorVersionRequest.InputData"
|
192
|
+
optional :base_processor_version, :string, 8
|
193
|
+
end
|
194
|
+
add_message "google.cloud.documentai.v1beta3.TrainProcessorVersionRequest.InputData" do
|
195
|
+
optional :training_documents, :message, 3, "google.cloud.documentai.v1beta3.BatchDocumentsInputConfig"
|
196
|
+
optional :test_documents, :message, 4, "google.cloud.documentai.v1beta3.BatchDocumentsInputConfig"
|
197
|
+
end
|
198
|
+
add_message "google.cloud.documentai.v1beta3.TrainProcessorVersionResponse" do
|
199
|
+
optional :processor_version, :string, 1
|
200
|
+
end
|
201
|
+
add_message "google.cloud.documentai.v1beta3.TrainProcessorVersionMetadata" do
|
202
|
+
optional :common_metadata, :message, 1, "google.cloud.documentai.v1beta3.CommonOperationMetadata"
|
203
|
+
optional :training_dataset_validation, :message, 2, "google.cloud.documentai.v1beta3.TrainProcessorVersionMetadata.DatasetValidation"
|
204
|
+
optional :test_dataset_validation, :message, 3, "google.cloud.documentai.v1beta3.TrainProcessorVersionMetadata.DatasetValidation"
|
205
|
+
end
|
206
|
+
add_message "google.cloud.documentai.v1beta3.TrainProcessorVersionMetadata.DatasetValidation" do
|
207
|
+
optional :document_error_count, :int32, 3
|
208
|
+
optional :dataset_error_count, :int32, 4
|
209
|
+
repeated :document_errors, :message, 1, "google.rpc.Status"
|
210
|
+
repeated :dataset_errors, :message, 2, "google.rpc.Status"
|
211
|
+
end
|
186
212
|
add_message "google.cloud.documentai.v1beta3.ReviewDocumentRequest" do
|
187
213
|
optional :human_review_config, :string, 1
|
188
214
|
optional :document, :message, 2, "google.cloud.documentai.v1beta3.Document"
|
@@ -223,6 +249,28 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
223
249
|
value :FAILED, 4
|
224
250
|
value :CANCELLED, 5
|
225
251
|
end
|
252
|
+
add_message "google.cloud.documentai.v1beta3.EvaluateProcessorVersionRequest" do
|
253
|
+
optional :processor_version, :string, 1
|
254
|
+
optional :evaluation_documents, :message, 3, "google.cloud.documentai.v1beta3.BatchDocumentsInputConfig"
|
255
|
+
end
|
256
|
+
add_message "google.cloud.documentai.v1beta3.EvaluateProcessorVersionMetadata" do
|
257
|
+
optional :common_metadata, :message, 1, "google.cloud.documentai.v1beta3.CommonOperationMetadata"
|
258
|
+
end
|
259
|
+
add_message "google.cloud.documentai.v1beta3.EvaluateProcessorVersionResponse" do
|
260
|
+
optional :evaluation, :string, 2
|
261
|
+
end
|
262
|
+
add_message "google.cloud.documentai.v1beta3.GetEvaluationRequest" do
|
263
|
+
optional :name, :string, 1
|
264
|
+
end
|
265
|
+
add_message "google.cloud.documentai.v1beta3.ListEvaluationsRequest" do
|
266
|
+
optional :parent, :string, 1
|
267
|
+
optional :page_size, :int32, 2
|
268
|
+
optional :page_token, :string, 3
|
269
|
+
end
|
270
|
+
add_message "google.cloud.documentai.v1beta3.ListEvaluationsResponse" do
|
271
|
+
repeated :evaluations, :message, 1, "google.cloud.documentai.v1beta3.Evaluation"
|
272
|
+
optional :next_page_token, :string, 2
|
273
|
+
end
|
226
274
|
end
|
227
275
|
end
|
228
276
|
|
@@ -271,12 +319,23 @@ module Google
|
|
271
319
|
SetDefaultProcessorVersionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.SetDefaultProcessorVersionRequest").msgclass
|
272
320
|
SetDefaultProcessorVersionResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.SetDefaultProcessorVersionResponse").msgclass
|
273
321
|
SetDefaultProcessorVersionMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.SetDefaultProcessorVersionMetadata").msgclass
|
322
|
+
TrainProcessorVersionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.TrainProcessorVersionRequest").msgclass
|
323
|
+
TrainProcessorVersionRequest::InputData = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.TrainProcessorVersionRequest.InputData").msgclass
|
324
|
+
TrainProcessorVersionResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.TrainProcessorVersionResponse").msgclass
|
325
|
+
TrainProcessorVersionMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.TrainProcessorVersionMetadata").msgclass
|
326
|
+
TrainProcessorVersionMetadata::DatasetValidation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.TrainProcessorVersionMetadata.DatasetValidation").msgclass
|
274
327
|
ReviewDocumentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ReviewDocumentRequest").msgclass
|
275
328
|
ReviewDocumentRequest::Priority = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ReviewDocumentRequest.Priority").enummodule
|
276
329
|
ReviewDocumentResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ReviewDocumentResponse").msgclass
|
277
330
|
ReviewDocumentResponse::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ReviewDocumentResponse.State").enummodule
|
278
331
|
ReviewDocumentOperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ReviewDocumentOperationMetadata").msgclass
|
279
332
|
ReviewDocumentOperationMetadata::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ReviewDocumentOperationMetadata.State").enummodule
|
333
|
+
EvaluateProcessorVersionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.EvaluateProcessorVersionRequest").msgclass
|
334
|
+
EvaluateProcessorVersionMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.EvaluateProcessorVersionMetadata").msgclass
|
335
|
+
EvaluateProcessorVersionResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.EvaluateProcessorVersionResponse").msgclass
|
336
|
+
GetEvaluationRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.GetEvaluationRequest").msgclass
|
337
|
+
ListEvaluationsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ListEvaluationsRequest").msgclass
|
338
|
+
ListEvaluationsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ListEvaluationsResponse").msgclass
|
280
339
|
end
|
281
340
|
end
|
282
341
|
end
|
@@ -50,6 +50,10 @@ module Google
|
|
50
50
|
rpc :ListProcessors, ::Google::Cloud::DocumentAI::V1beta3::ListProcessorsRequest, ::Google::Cloud::DocumentAI::V1beta3::ListProcessorsResponse
|
51
51
|
# Gets a processor detail.
|
52
52
|
rpc :GetProcessor, ::Google::Cloud::DocumentAI::V1beta3::GetProcessorRequest, ::Google::Cloud::DocumentAI::V1beta3::Processor
|
53
|
+
# Trains a new processor version.
|
54
|
+
# Operation metadata is returned as
|
55
|
+
# cloud_documentai_core.TrainProcessorVersionMetadata.
|
56
|
+
rpc :TrainProcessorVersion, ::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest, ::Google::Longrunning::Operation
|
53
57
|
# Gets a processor version detail.
|
54
58
|
rpc :GetProcessorVersion, ::Google::Cloud::DocumentAI::V1beta3::GetProcessorVersionRequest, ::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion
|
55
59
|
# Lists all versions of a processor.
|
@@ -78,6 +82,13 @@ module Google
|
|
78
82
|
# Send a document for Human Review. The input document should be processed by
|
79
83
|
# the specified processor.
|
80
84
|
rpc :ReviewDocument, ::Google::Cloud::DocumentAI::V1beta3::ReviewDocumentRequest, ::Google::Longrunning::Operation
|
85
|
+
# Evaluates a ProcessorVersion against annotated documents, producing an
|
86
|
+
# Evaluation.
|
87
|
+
rpc :EvaluateProcessorVersion, ::Google::Cloud::DocumentAI::V1beta3::EvaluateProcessorVersionRequest, ::Google::Longrunning::Operation
|
88
|
+
# Retrieves a specific evaluation.
|
89
|
+
rpc :GetEvaluation, ::Google::Cloud::DocumentAI::V1beta3::GetEvaluationRequest, ::Google::Cloud::DocumentAI::V1beta3::Evaluation
|
90
|
+
# Retrieves a set of evaluations for a given processor version.
|
91
|
+
rpc :ListEvaluations, ::Google::Cloud::DocumentAI::V1beta3::ListEvaluationsRequest, ::Google::Cloud::DocumentAI::V1beta3::ListEvaluationsResponse
|
81
92
|
end
|
82
93
|
|
83
94
|
Stub = Service.rpc_stub_class
|
@@ -0,0 +1,72 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# source: google/cloud/documentai/v1beta3/evaluation.proto
|
3
|
+
|
4
|
+
require 'google/protobuf'
|
5
|
+
|
6
|
+
require 'google/api/resource_pb'
|
7
|
+
require 'google/protobuf/timestamp_pb'
|
8
|
+
|
9
|
+
Google::Protobuf::DescriptorPool.generated_pool.build do
|
10
|
+
add_file("google/cloud/documentai/v1beta3/evaluation.proto", :syntax => :proto3) do
|
11
|
+
add_message "google.cloud.documentai.v1beta3.Evaluation" do
|
12
|
+
optional :name, :string, 1
|
13
|
+
optional :create_time, :message, 2, "google.protobuf.Timestamp"
|
14
|
+
optional :document_counters, :message, 5, "google.cloud.documentai.v1beta3.Evaluation.Counters"
|
15
|
+
optional :all_entities_metrics, :message, 3, "google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics"
|
16
|
+
map :entity_metrics, :string, :message, 4, "google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics"
|
17
|
+
optional :kms_key_name, :string, 6
|
18
|
+
optional :kms_key_version_name, :string, 7
|
19
|
+
end
|
20
|
+
add_message "google.cloud.documentai.v1beta3.Evaluation.Counters" do
|
21
|
+
optional :input_documents_count, :int32, 1
|
22
|
+
optional :invalid_documents_count, :int32, 2
|
23
|
+
optional :failed_documents_count, :int32, 3
|
24
|
+
optional :evaluated_documents_count, :int32, 4
|
25
|
+
end
|
26
|
+
add_message "google.cloud.documentai.v1beta3.Evaluation.Metrics" do
|
27
|
+
optional :precision, :float, 1
|
28
|
+
optional :recall, :float, 2
|
29
|
+
optional :f1_score, :float, 3
|
30
|
+
optional :predicted_occurrences_count, :int32, 4
|
31
|
+
optional :ground_truth_occurrences_count, :int32, 5
|
32
|
+
optional :predicted_document_count, :int32, 10
|
33
|
+
optional :ground_truth_document_count, :int32, 11
|
34
|
+
optional :true_positives_count, :int32, 6
|
35
|
+
optional :false_positives_count, :int32, 7
|
36
|
+
optional :false_negatives_count, :int32, 8
|
37
|
+
optional :total_documents_count, :int32, 9
|
38
|
+
end
|
39
|
+
add_message "google.cloud.documentai.v1beta3.Evaluation.ConfidenceLevelMetrics" do
|
40
|
+
optional :confidence_level, :float, 1
|
41
|
+
optional :metrics, :message, 2, "google.cloud.documentai.v1beta3.Evaluation.Metrics"
|
42
|
+
end
|
43
|
+
add_message "google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics" do
|
44
|
+
repeated :confidence_level_metrics, :message, 1, "google.cloud.documentai.v1beta3.Evaluation.ConfidenceLevelMetrics"
|
45
|
+
repeated :confidence_level_metrics_exact, :message, 4, "google.cloud.documentai.v1beta3.Evaluation.ConfidenceLevelMetrics"
|
46
|
+
optional :auprc, :float, 2
|
47
|
+
optional :estimated_calibration_error, :float, 3
|
48
|
+
optional :auprc_exact, :float, 5
|
49
|
+
optional :estimated_calibration_error_exact, :float, 6
|
50
|
+
optional :metrics_type, :enum, 7, "google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics.MetricsType"
|
51
|
+
end
|
52
|
+
add_enum "google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics.MetricsType" do
|
53
|
+
value :METRICS_TYPE_UNSPECIFIED, 0
|
54
|
+
value :AGGREGATE, 1
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
58
|
+
|
59
|
+
module Google
|
60
|
+
module Cloud
|
61
|
+
module DocumentAI
|
62
|
+
module V1beta3
|
63
|
+
Evaluation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.Evaluation").msgclass
|
64
|
+
Evaluation::Counters = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.Evaluation.Counters").msgclass
|
65
|
+
Evaluation::Metrics = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.Evaluation.Metrics").msgclass
|
66
|
+
Evaluation::ConfidenceLevelMetrics = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.Evaluation.ConfidenceLevelMetrics").msgclass
|
67
|
+
Evaluation::MultiConfidenceMetrics = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics").msgclass
|
68
|
+
Evaluation::MultiConfidenceMetrics::MetricsType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics.MetricsType").enummodule
|
69
|
+
end
|
70
|
+
end
|
71
|
+
end
|
72
|
+
end
|
@@ -5,6 +5,7 @@ require 'google/protobuf'
|
|
5
5
|
|
6
6
|
require 'google/api/field_behavior_pb'
|
7
7
|
require 'google/api/resource_pb'
|
8
|
+
require 'google/cloud/documentai/v1beta3/document_schema_pb'
|
8
9
|
require 'google/protobuf/timestamp_pb'
|
9
10
|
|
10
11
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
@@ -12,6 +13,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
12
13
|
add_message "google.cloud.documentai.v1beta3.ProcessorVersion" do
|
13
14
|
optional :name, :string, 1
|
14
15
|
optional :display_name, :string, 2
|
16
|
+
optional :document_schema, :message, 12, "google.cloud.documentai.v1beta3.DocumentSchema"
|
15
17
|
optional :state, :enum, 6, "google.cloud.documentai.v1beta3.ProcessorVersion.State"
|
16
18
|
optional :create_time, :message, 7, "google.protobuf.Timestamp"
|
17
19
|
optional :kms_key_name, :string, 9
|
@@ -0,0 +1,318 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Api
|
22
|
+
# Required information for every language.
|
23
|
+
# @!attribute [rw] reference_docs_uri
|
24
|
+
# @return [::String]
|
25
|
+
# Link to automatically generated reference documentation. Example:
|
26
|
+
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
27
|
+
# @!attribute [rw] destinations
|
28
|
+
# @return [::Array<::Google::Api::ClientLibraryDestination>]
|
29
|
+
# The destination where API teams want this client library to be published.
|
30
|
+
class CommonLanguageSettings
|
31
|
+
include ::Google::Protobuf::MessageExts
|
32
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
33
|
+
end
|
34
|
+
|
35
|
+
# Details about how and where to publish client libraries.
|
36
|
+
# @!attribute [rw] version
|
37
|
+
# @return [::String]
|
38
|
+
# Version of the API to apply these settings to.
|
39
|
+
# @!attribute [rw] launch_stage
|
40
|
+
# @return [::Google::Api::LaunchStage]
|
41
|
+
# Launch stage of this version of the API.
|
42
|
+
# @!attribute [rw] rest_numeric_enums
|
43
|
+
# @return [::Boolean]
|
44
|
+
# When using transport=rest, the client request will encode enums as
|
45
|
+
# numbers rather than strings.
|
46
|
+
# @!attribute [rw] java_settings
|
47
|
+
# @return [::Google::Api::JavaSettings]
|
48
|
+
# Settings for legacy Java features, supported in the Service YAML.
|
49
|
+
# @!attribute [rw] cpp_settings
|
50
|
+
# @return [::Google::Api::CppSettings]
|
51
|
+
# Settings for C++ client libraries.
|
52
|
+
# @!attribute [rw] php_settings
|
53
|
+
# @return [::Google::Api::PhpSettings]
|
54
|
+
# Settings for PHP client libraries.
|
55
|
+
# @!attribute [rw] python_settings
|
56
|
+
# @return [::Google::Api::PythonSettings]
|
57
|
+
# Settings for Python client libraries.
|
58
|
+
# @!attribute [rw] node_settings
|
59
|
+
# @return [::Google::Api::NodeSettings]
|
60
|
+
# Settings for Node client libraries.
|
61
|
+
# @!attribute [rw] dotnet_settings
|
62
|
+
# @return [::Google::Api::DotnetSettings]
|
63
|
+
# Settings for .NET client libraries.
|
64
|
+
# @!attribute [rw] ruby_settings
|
65
|
+
# @return [::Google::Api::RubySettings]
|
66
|
+
# Settings for Ruby client libraries.
|
67
|
+
# @!attribute [rw] go_settings
|
68
|
+
# @return [::Google::Api::GoSettings]
|
69
|
+
# Settings for Go client libraries.
|
70
|
+
class ClientLibrarySettings
|
71
|
+
include ::Google::Protobuf::MessageExts
|
72
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
73
|
+
end
|
74
|
+
|
75
|
+
# This message configures the settings for publishing [Google Cloud Client
|
76
|
+
# libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
|
77
|
+
# generated from the service config.
|
78
|
+
# @!attribute [rw] method_settings
|
79
|
+
# @return [::Array<::Google::Api::MethodSettings>]
|
80
|
+
# A list of API method settings, e.g. the behavior for methods that use the
|
81
|
+
# long-running operation pattern.
|
82
|
+
# @!attribute [rw] new_issue_uri
|
83
|
+
# @return [::String]
|
84
|
+
# Link to a place that API users can report issues. Example:
|
85
|
+
# https://issuetracker.google.com/issues/new?component=190865&template=1161103
|
86
|
+
# @!attribute [rw] documentation_uri
|
87
|
+
# @return [::String]
|
88
|
+
# Link to product home page. Example:
|
89
|
+
# https://cloud.google.com/asset-inventory/docs/overview
|
90
|
+
# @!attribute [rw] api_short_name
|
91
|
+
# @return [::String]
|
92
|
+
# Used as a tracking tag when collecting data about the APIs developer
|
93
|
+
# relations artifacts like docs, packages delivered to package managers,
|
94
|
+
# etc. Example: "speech".
|
95
|
+
# @!attribute [rw] github_label
|
96
|
+
# @return [::String]
|
97
|
+
# GitHub label to apply to issues and pull requests opened for this API.
|
98
|
+
# @!attribute [rw] codeowner_github_teams
|
99
|
+
# @return [::Array<::String>]
|
100
|
+
# GitHub teams to be added to CODEOWNERS in the directory in GitHub
|
101
|
+
# containing source code for the client libraries for this API.
|
102
|
+
# @!attribute [rw] doc_tag_prefix
|
103
|
+
# @return [::String]
|
104
|
+
# A prefix used in sample code when demarking regions to be included in
|
105
|
+
# documentation.
|
106
|
+
# @!attribute [rw] organization
|
107
|
+
# @return [::Google::Api::ClientLibraryOrganization]
|
108
|
+
# For whom the client library is being published.
|
109
|
+
# @!attribute [rw] library_settings
|
110
|
+
# @return [::Array<::Google::Api::ClientLibrarySettings>]
|
111
|
+
# Client library settings. If the same version string appears multiple
|
112
|
+
# times in this list, then the last one wins. Settings from earlier
|
113
|
+
# settings with the same version string are discarded.
|
114
|
+
class Publishing
|
115
|
+
include ::Google::Protobuf::MessageExts
|
116
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
117
|
+
end
|
118
|
+
|
119
|
+
# Settings for Java client libraries.
|
120
|
+
# @!attribute [rw] library_package
|
121
|
+
# @return [::String]
|
122
|
+
# The package name to use in Java. Clobbers the java_package option
|
123
|
+
# set in the protobuf. This should be used **only** by APIs
|
124
|
+
# who have already set the language_settings.java.package_name" field
|
125
|
+
# in gapic.yaml. API teams should use the protobuf java_package option
|
126
|
+
# where possible.
|
127
|
+
#
|
128
|
+
# Example of a YAML configuration::
|
129
|
+
#
|
130
|
+
# publishing:
|
131
|
+
# java_settings:
|
132
|
+
# library_package: com.google.cloud.pubsub.v1
|
133
|
+
# @!attribute [rw] service_class_names
|
134
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
135
|
+
# Configure the Java class name to use instead of the service's for its
|
136
|
+
# corresponding generated GAPIC client. Keys are fully-qualified
|
137
|
+
# service names as they appear in the protobuf (including the full
|
138
|
+
# the language_settings.java.interface_names" field in gapic.yaml. API
|
139
|
+
# teams should otherwise use the service name as it appears in the
|
140
|
+
# protobuf.
|
141
|
+
#
|
142
|
+
# Example of a YAML configuration::
|
143
|
+
#
|
144
|
+
# publishing:
|
145
|
+
# java_settings:
|
146
|
+
# service_class_names:
|
147
|
+
# - google.pubsub.v1.Publisher: TopicAdmin
|
148
|
+
# - google.pubsub.v1.Subscriber: SubscriptionAdmin
|
149
|
+
# @!attribute [rw] common
|
150
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
151
|
+
# Some settings.
|
152
|
+
class JavaSettings
|
153
|
+
include ::Google::Protobuf::MessageExts
|
154
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
155
|
+
|
156
|
+
# @!attribute [rw] key
|
157
|
+
# @return [::String]
|
158
|
+
# @!attribute [rw] value
|
159
|
+
# @return [::String]
|
160
|
+
class ServiceClassNamesEntry
|
161
|
+
include ::Google::Protobuf::MessageExts
|
162
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
163
|
+
end
|
164
|
+
end
|
165
|
+
|
166
|
+
# Settings for C++ client libraries.
|
167
|
+
# @!attribute [rw] common
|
168
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
169
|
+
# Some settings.
|
170
|
+
class CppSettings
|
171
|
+
include ::Google::Protobuf::MessageExts
|
172
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
173
|
+
end
|
174
|
+
|
175
|
+
# Settings for Php client libraries.
|
176
|
+
# @!attribute [rw] common
|
177
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
178
|
+
# Some settings.
|
179
|
+
class PhpSettings
|
180
|
+
include ::Google::Protobuf::MessageExts
|
181
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
182
|
+
end
|
183
|
+
|
184
|
+
# Settings for Python client libraries.
|
185
|
+
# @!attribute [rw] common
|
186
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
187
|
+
# Some settings.
|
188
|
+
class PythonSettings
|
189
|
+
include ::Google::Protobuf::MessageExts
|
190
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
191
|
+
end
|
192
|
+
|
193
|
+
# Settings for Node client libraries.
|
194
|
+
# @!attribute [rw] common
|
195
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
196
|
+
# Some settings.
|
197
|
+
class NodeSettings
|
198
|
+
include ::Google::Protobuf::MessageExts
|
199
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
200
|
+
end
|
201
|
+
|
202
|
+
# Settings for Dotnet client libraries.
|
203
|
+
# @!attribute [rw] common
|
204
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
205
|
+
# Some settings.
|
206
|
+
class DotnetSettings
|
207
|
+
include ::Google::Protobuf::MessageExts
|
208
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
209
|
+
end
|
210
|
+
|
211
|
+
# Settings for Ruby client libraries.
|
212
|
+
# @!attribute [rw] common
|
213
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
214
|
+
# Some settings.
|
215
|
+
class RubySettings
|
216
|
+
include ::Google::Protobuf::MessageExts
|
217
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
218
|
+
end
|
219
|
+
|
220
|
+
# Settings for Go client libraries.
|
221
|
+
# @!attribute [rw] common
|
222
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
223
|
+
# Some settings.
|
224
|
+
class GoSettings
|
225
|
+
include ::Google::Protobuf::MessageExts
|
226
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
227
|
+
end
|
228
|
+
|
229
|
+
# Describes the generator configuration for a method.
|
230
|
+
# @!attribute [rw] selector
|
231
|
+
# @return [::String]
|
232
|
+
# The fully qualified name of the method, for which the options below apply.
|
233
|
+
# This is used to find the method to apply the options.
|
234
|
+
# @!attribute [rw] long_running
|
235
|
+
# @return [::Google::Api::MethodSettings::LongRunning]
|
236
|
+
# Describes settings to use for long-running operations when generating
|
237
|
+
# API methods for RPCs. Complements RPCs that use the annotations in
|
238
|
+
# google/longrunning/operations.proto.
|
239
|
+
#
|
240
|
+
# Example of a YAML configuration::
|
241
|
+
#
|
242
|
+
# publishing:
|
243
|
+
# method_behavior:
|
244
|
+
# - selector: CreateAdDomain
|
245
|
+
# long_running:
|
246
|
+
# initial_poll_delay:
|
247
|
+
# seconds: 60 # 1 minute
|
248
|
+
# poll_delay_multiplier: 1.5
|
249
|
+
# max_poll_delay:
|
250
|
+
# seconds: 360 # 6 minutes
|
251
|
+
# total_poll_timeout:
|
252
|
+
# seconds: 54000 # 90 minutes
|
253
|
+
class MethodSettings
|
254
|
+
include ::Google::Protobuf::MessageExts
|
255
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
256
|
+
|
257
|
+
# Describes settings to use when generating API methods that use the
|
258
|
+
# long-running operation pattern.
|
259
|
+
# All default values below are from those used in the client library
|
260
|
+
# generators (e.g.
|
261
|
+
# [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
|
262
|
+
# @!attribute [rw] initial_poll_delay
|
263
|
+
# @return [::Google::Protobuf::Duration]
|
264
|
+
# Initial delay after which the first poll request will be made.
|
265
|
+
# Default value: 5 seconds.
|
266
|
+
# @!attribute [rw] poll_delay_multiplier
|
267
|
+
# @return [::Float]
|
268
|
+
# Multiplier to gradually increase delay between subsequent polls until it
|
269
|
+
# reaches max_poll_delay.
|
270
|
+
# Default value: 1.5.
|
271
|
+
# @!attribute [rw] max_poll_delay
|
272
|
+
# @return [::Google::Protobuf::Duration]
|
273
|
+
# Maximum time between two subsequent poll requests.
|
274
|
+
# Default value: 45 seconds.
|
275
|
+
# @!attribute [rw] total_poll_timeout
|
276
|
+
# @return [::Google::Protobuf::Duration]
|
277
|
+
# Total polling timeout.
|
278
|
+
# Default value: 5 minutes.
|
279
|
+
class LongRunning
|
280
|
+
include ::Google::Protobuf::MessageExts
|
281
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
282
|
+
end
|
283
|
+
end
|
284
|
+
|
285
|
+
# The organization for which the client libraries are being published.
|
286
|
+
# Affects the url where generated docs are published, etc.
|
287
|
+
module ClientLibraryOrganization
|
288
|
+
# Not useful.
|
289
|
+
CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
|
290
|
+
|
291
|
+
# Google Cloud Platform Org.
|
292
|
+
CLOUD = 1
|
293
|
+
|
294
|
+
# Ads (Advertising) Org.
|
295
|
+
ADS = 2
|
296
|
+
|
297
|
+
# Photos Org.
|
298
|
+
PHOTOS = 3
|
299
|
+
|
300
|
+
# Street View Org.
|
301
|
+
STREET_VIEW = 4
|
302
|
+
end
|
303
|
+
|
304
|
+
# To where should client libraries be published?
|
305
|
+
module ClientLibraryDestination
|
306
|
+
# Client libraries will neither be generated nor published to package
|
307
|
+
# managers.
|
308
|
+
CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
|
309
|
+
|
310
|
+
# Generate the client library in a repo under github.com/googleapis,
|
311
|
+
# but don't publish it to package managers.
|
312
|
+
GITHUB = 10
|
313
|
+
|
314
|
+
# Publish the library to package managers like nuget.org and npmjs.com.
|
315
|
+
PACKAGE_MANAGER = 20
|
316
|
+
end
|
317
|
+
end
|
318
|
+
end
|
@@ -20,7 +20,7 @@
|
|
20
20
|
module Google
|
21
21
|
module Api
|
22
22
|
# The launch stage as defined by [Google Cloud Platform
|
23
|
-
# Launch Stages](
|
23
|
+
# Launch Stages](https://cloud.google.com/terms/launch-stages).
|
24
24
|
module LaunchStage
|
25
25
|
# Do not use this default value.
|
26
26
|
LAUNCH_STAGE_UNSPECIFIED = 0
|
@@ -42,7 +42,7 @@ module Google
|
|
42
42
|
# for widespread use. By Alpha, all significant design issues are resolved
|
43
43
|
# and we are in the process of verifying functionality. Alpha customers
|
44
44
|
# need to apply for access, agree to applicable terms, and have their
|
45
|
-
# projects allowlisted. Alpha releases don
|
45
|
+
# projects allowlisted. Alpha releases don't have to be feature complete,
|
46
46
|
# no SLAs are provided, and there are no technical support obligations, but
|
47
47
|
# they will be far enough along that customers can actually use them in
|
48
48
|
# test environments or for limited-use tests -- just like they would in
|
@@ -61,7 +61,7 @@ module Google
|
|
61
61
|
GA = 4
|
62
62
|
|
63
63
|
# Deprecated features are scheduled to be shut down and removed. For more
|
64
|
-
# information, see the
|
64
|
+
# information, see the "Deprecation Policy" section of our [Terms of
|
65
65
|
# Service](https://cloud.google.com/terms/)
|
66
66
|
# and the [Google Cloud Platform Subject to the Deprecation
|
67
67
|
# Policy](https://cloud.google.com/terms/deprecation) documentation.
|
@@ -26,41 +26,43 @@ module Google
|
|
26
26
|
# @return [::String]
|
27
27
|
# Format of a barcode.
|
28
28
|
# The supported formats are:
|
29
|
-
#
|
30
|
-
#
|
31
|
-
#
|
32
|
-
#
|
33
|
-
#
|
34
|
-
#
|
35
|
-
#
|
36
|
-
#
|
37
|
-
#
|
38
|
-
#
|
39
|
-
#
|
40
|
-
#
|
41
|
-
#
|
42
|
-
#
|
29
|
+
#
|
30
|
+
# - `CODE_128`: Code 128 type.
|
31
|
+
# - `CODE_39`: Code 39 type.
|
32
|
+
# - `CODE_93`: Code 93 type.
|
33
|
+
# - `CODABAR`: Codabar type.
|
34
|
+
# - `DATA_MATRIX`: 2D Data Matrix type.
|
35
|
+
# - `ITF`: ITF type.
|
36
|
+
# - `EAN_13`: EAN-13 type.
|
37
|
+
# - `EAN_8`: EAN-8 type.
|
38
|
+
# - `QR_CODE`: 2D QR code type.
|
39
|
+
# - `UPC_A`: UPC-A type.
|
40
|
+
# - `UPC_E`: UPC-E type.
|
41
|
+
# - `PDF417`: PDF417 type.
|
42
|
+
# - `AZTEC`: 2D Aztec code type.
|
43
|
+
# - `DATABAR`: GS1 DataBar code type.
|
43
44
|
# @!attribute [rw] value_format
|
44
45
|
# @return [::String]
|
45
46
|
# Value format describes the format of the value that a barcode
|
46
47
|
# encodes.
|
47
48
|
# The supported formats are:
|
48
|
-
#
|
49
|
-
#
|
50
|
-
#
|
51
|
-
#
|
52
|
-
#
|
53
|
-
#
|
54
|
-
#
|
55
|
-
#
|
56
|
-
#
|
57
|
-
#
|
58
|
-
#
|
59
|
-
#
|
49
|
+
#
|
50
|
+
# - `CONTACT_INFO`: Contact information.
|
51
|
+
# - `EMAIL`: Email address.
|
52
|
+
# - `ISBN`: ISBN identifier.
|
53
|
+
# - `PHONE`: Phone number.
|
54
|
+
# - `PRODUCT`: Product.
|
55
|
+
# - `SMS`: SMS message.
|
56
|
+
# - `TEXT`: Text string.
|
57
|
+
# - `URL`: URL address.
|
58
|
+
# - `WIFI`: Wifi information.
|
59
|
+
# - `GEO`: Geo-localization.
|
60
|
+
# - `CALENDAR_EVENT`: Calendar event.
|
61
|
+
# - `DRIVER_LICENSE`: Driver's license.
|
60
62
|
# @!attribute [rw] raw_value
|
61
63
|
# @return [::String]
|
62
64
|
# Raw value encoded in the barcode.
|
63
|
-
# For example
|
65
|
+
# For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.
|
64
66
|
class Barcode
|
65
67
|
include ::Google::Protobuf::MessageExts
|
66
68
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|