google-cloud-document_ai-v1beta3 0.29.0 → 0.30.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (19) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb +33 -8
  4. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/operations.rb +28 -6
  5. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/client.rb +35 -7
  6. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/operations.rb +33 -8
  7. data/lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/service_stub.rb +14 -2
  8. data/lib/google/cloud/document_ai/v1beta3/document_service/client.rb +33 -8
  9. data/lib/google/cloud/document_ai/v1beta3/document_service/operations.rb +28 -6
  10. data/lib/google/cloud/document_ai/v1beta3/document_service/rest/client.rb +35 -7
  11. data/lib/google/cloud/document_ai/v1beta3/document_service/rest/operations.rb +33 -8
  12. data/lib/google/cloud/document_ai/v1beta3/document_service/rest/service_stub.rb +14 -2
  13. data/lib/google/cloud/document_ai/v1beta3/version.rb +1 -1
  14. data/proto_docs/google/api/client.rb +14 -0
  15. data/proto_docs/google/cloud/documentai/v1beta3/dataset.rb +1 -0
  16. data/proto_docs/google/cloud/documentai/v1beta3/document.rb +13 -0
  17. data/proto_docs/google/cloud/documentai/v1beta3/document_io.rb +1 -0
  18. data/proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb +8 -0
  19. metadata +7 -7
data/lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/service_stub.rb CHANGED
@@ -30,16 +30,28 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, credentials:
33
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
34
34
  # These require statements are intentionally placed here to initialize
35
35
  # the REST modules only when it's required.
36
36
  require "gapic/rest"
37
37
 
38
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
38
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
39
+ endpoint_template: endpoint_template,
40
+ universe_domain: universe_domain,
41
+ credentials: credentials,
39
42
  numeric_enums: true,
40
43
  raise_faraday_errors: false
41
44
  end
42
45
 
46
+ ##
47
+ # The effective universe domain
48
+ #
49
+ # @return [String]
50
+ #
51
+ def universe_domain
52
+ @client_stub.universe_domain
53
+ end
54
+
43
55
  ##
44
56
  # Baseline implementation for the process_document REST call
45
57
  #
data/lib/google/cloud/document_ai/v1beta3/document_service/client.rb CHANGED
@@ -31,6 +31,9 @@ module Google
31
31
  # Service to call Cloud DocumentAI to manage document collection (dataset).
32
32
  #
33
33
  class Client
34
+ # @private
35
+ DEFAULT_ENDPOINT_TEMPLATE = "documentai.$UNIVERSE_DOMAIN$"
36
+
34
37
  include Paths
35
38
 
36
39
  # @private
@@ -91,6 +94,15 @@ module Google
91
94
  @config
92
95
  end
93
96
 
97
+ ##
98
+ # The effective universe domain
99
+ #
100
+ # @return [String]
101
+ #
102
+ def universe_domain
103
+ @document_service_stub.universe_domain
104
+ end
105
+
94
106
  ##
95
107
  # Create a new DocumentService client object.
96
108
  #
@@ -124,8 +136,9 @@ module Google
124
136
  credentials = @config.credentials
125
137
  # Use self-signed JWT if the endpoint is unchanged from default,
126
138
  # but only if the default endpoint does not have a region prefix.
127
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
128
- !@config.endpoint.split(".").first.include?("-")
139
+ enable_self_signed_jwt = @config.endpoint.nil? ||
140
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
141
+ !@config.endpoint.split(".").first.include?("-"))
129
142
  credentials ||= Credentials.default scope: @config.scope,
130
143
  enable_self_signed_jwt: enable_self_signed_jwt
131
144
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -138,18 +151,22 @@ module Google
138
151
  config.credentials = credentials
139
152
  config.quota_project = @quota_project_id
140
153
  config.endpoint = @config.endpoint
154
+ config.universe_domain = @config.universe_domain
141
155
  end
142
156
 
143
157
  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
144
158
  config.credentials = credentials
145
159
  config.quota_project = @quota_project_id
146
160
  config.endpoint = @config.endpoint
161
+ config.universe_domain = @config.universe_domain
147
162
  end
148
163
 
149
164
  @document_service_stub = ::Gapic::ServiceStub.new(
150
165
  ::Google::Cloud::DocumentAI::V1beta3::DocumentService::Stub,
151
- credentials: credentials,
152
- endpoint: @config.endpoint,
166
+ credentials: credentials,
167
+ endpoint: @config.endpoint,
168
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
169
+ universe_domain: @config.universe_domain,
153
170
  channel_args: @config.channel_args,
154
171
  interceptors: @config.interceptors,
155
172
  channel_pool_config: @config.channel_pool
@@ -903,9 +920,9 @@ module Google
903
920
  # end
904
921
  #
905
922
  # @!attribute [rw] endpoint
906
- # The hostname or hostname:port of the service endpoint.
907
- # Defaults to `"documentai.googleapis.com"`.
908
- # @return [::String]
923
+ # A custom service endpoint, as a hostname or hostname:port. The default is
924
+ # nil, indicating to use the default endpoint in the current universe domain.
925
+ # @return [::String,nil]
909
926
  # @!attribute [rw] credentials
910
927
  # Credentials to send with calls. You may provide any of the following types:
911
928
  # * (`String`) The path to a service account key file in JSON format
@@ -951,13 +968,20 @@ module Google
951
968
  # @!attribute [rw] quota_project
952
969
  # A separate project against which to charge quota.
953
970
  # @return [::String]
971
+ # @!attribute [rw] universe_domain
972
+ # The universe domain within which to make requests. This determines the
973
+ # default endpoint URL. The default value of nil uses the environment
974
+ # universe (usually the default "googleapis.com" universe).
975
+ # @return [::String,nil]
954
976
  #
955
977
  class Configuration
956
978
  extend ::Gapic::Config
957
979
 
980
+ # @private
981
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
958
982
  DEFAULT_ENDPOINT = "documentai.googleapis.com"
959
983
 
960
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
984
+ config_attr :endpoint, nil, ::String, nil
961
985
  config_attr :credentials, nil do |value|
962
986
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
963
987
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -972,6 +996,7 @@ module Google
972
996
  config_attr :metadata, nil, ::Hash, nil
973
997
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
974
998
  config_attr :quota_project, nil, ::String, nil
999
+ config_attr :universe_domain, nil, ::String, nil
975
1000
 
976
1001
  # @private
977
1002
  def initialize parent_config = nil
data/lib/google/cloud/document_ai/v1beta3/document_service/operations.rb CHANGED
@@ -26,6 +26,9 @@ module Google
26
26
  module DocumentService
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "documentai.$UNIVERSE_DOMAIN$"
31
+
29
32
  # @private
30
33
  attr_reader :operations_stub
31
34
 
@@ -60,6 +63,15 @@ module Google
60
63
  @config
61
64
  end
62
65
 
66
+ ##
67
+ # The effective universe domain
68
+ #
69
+ # @return [String]
70
+ #
71
+ def universe_domain
72
+ @operations_stub.universe_domain
73
+ end
74
+
63
75
  ##
64
76
  # Create a new Operations client object.
65
77
  #
@@ -90,8 +102,10 @@ module Google
90
102
 
91
103
  @operations_stub = ::Gapic::ServiceStub.new(
92
104
  ::Google::Longrunning::Operations::Stub,
93
- credentials: credentials,
94
- endpoint: @config.endpoint,
105
+ credentials: credentials,
106
+ endpoint: @config.endpoint,
107
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
108
+ universe_domain: @config.universe_domain,
95
109
  channel_args: @config.channel_args,
96
110
  interceptors: @config.interceptors,
97
111
  channel_pool_config: @config.channel_pool
@@ -613,9 +627,9 @@ module Google
613
627
  # end
614
628
  #
615
629
  # @!attribute [rw] endpoint
616
- # The hostname or hostname:port of the service endpoint.
617
- # Defaults to `"documentai.googleapis.com"`.
618
- # @return [::String]
630
+ # A custom service endpoint, as a hostname or hostname:port. The default is
631
+ # nil, indicating to use the default endpoint in the current universe domain.
632
+ # @return [::String,nil]
619
633
  # @!attribute [rw] credentials
620
634
  # Credentials to send with calls. You may provide any of the following types:
621
635
  # * (`String`) The path to a service account key file in JSON format
@@ -661,13 +675,20 @@ module Google
661
675
  # @!attribute [rw] quota_project
662
676
  # A separate project against which to charge quota.
663
677
  # @return [::String]
678
+ # @!attribute [rw] universe_domain
679
+ # The universe domain within which to make requests. This determines the
680
+ # default endpoint URL. The default value of nil uses the environment
681
+ # universe (usually the default "googleapis.com" universe).
682
+ # @return [::String,nil]
664
683
  #
665
684
  class Configuration
666
685
  extend ::Gapic::Config
667
686
 
687
+ # @private
688
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
668
689
  DEFAULT_ENDPOINT = "documentai.googleapis.com"
669
690
 
670
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
691
+ config_attr :endpoint, nil, ::String, nil
671
692
  config_attr :credentials, nil do |value|
672
693
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
673
694
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -682,6 +703,7 @@ module Google
682
703
  config_attr :metadata, nil, ::Hash, nil
683
704
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
684
705
  config_attr :quota_project, nil, ::String, nil
706
+ config_attr :universe_domain, nil, ::String, nil
685
707
 
686
708
  # @private
687
709
  def initialize parent_config = nil
data/lib/google/cloud/document_ai/v1beta3/document_service/rest/client.rb CHANGED
@@ -33,6 +33,9 @@ module Google
33
33
  # Service to call Cloud DocumentAI to manage document collection (dataset).
34
34
  #
35
35
  class Client
36
+ # @private
37
+ DEFAULT_ENDPOINT_TEMPLATE = "documentai.$UNIVERSE_DOMAIN$"
38
+
36
39
  include Paths
37
40
 
38
41
  # @private
@@ -93,6 +96,15 @@ module Google
93
96
  @config
94
97
  end
95
98
 
99
+ ##
100
+ # The effective universe domain
101
+ #
102
+ # @return [String]
103
+ #
104
+ def universe_domain
105
+ @document_service_stub.universe_domain
106
+ end
107
+
96
108
  ##
97
109
  # Create a new DocumentService REST client object.
98
110
  #
@@ -120,8 +132,9 @@ module Google
120
132
  credentials = @config.credentials
121
133
  # Use self-signed JWT if the endpoint is unchanged from default,
122
134
  # but only if the default endpoint does not have a region prefix.
123
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
124
- !@config.endpoint.split(".").first.include?("-")
135
+ enable_self_signed_jwt = @config.endpoint.nil? ||
136
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
137
+ !@config.endpoint.split(".").first.include?("-"))
125
138
  credentials ||= Credentials.default scope: @config.scope,
126
139
  enable_self_signed_jwt: enable_self_signed_jwt
127
140
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -135,16 +148,23 @@ module Google
135
148
  config.credentials = credentials
136
149
  config.quota_project = @quota_project_id
137
150
  config.endpoint = @config.endpoint
151
+ config.universe_domain = @config.universe_domain
138
152
  end
139
153
 
140
154
  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
141
155
  config.credentials = credentials
142
156
  config.quota_project = @quota_project_id
143
157
  config.endpoint = @config.endpoint
158
+ config.universe_domain = @config.universe_domain
144
159
  config.bindings_override = @config.bindings_override
145
160
  end
146
161
 
147
- @document_service_stub = ::Google::Cloud::DocumentAI::V1beta3::DocumentService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
162
+ @document_service_stub = ::Google::Cloud::DocumentAI::V1beta3::DocumentService::Rest::ServiceStub.new(
163
+ endpoint: @config.endpoint,
164
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
165
+ universe_domain: @config.universe_domain,
166
+ credentials: credentials
167
+ )
148
168
  end
149
169
 
150
170
  ##
@@ -845,9 +865,9 @@ module Google
845
865
  # end
846
866
  #
847
867
  # @!attribute [rw] endpoint
848
- # The hostname or hostname:port of the service endpoint.
849
- # Defaults to `"documentai.googleapis.com"`.
850
- # @return [::String]
868
+ # A custom service endpoint, as a hostname or hostname:port. The default is
869
+ # nil, indicating to use the default endpoint in the current universe domain.
870
+ # @return [::String,nil]
851
871
  # @!attribute [rw] credentials
852
872
  # Credentials to send with calls. You may provide any of the following types:
853
873
  # * (`String`) The path to a service account key file in JSON format
@@ -884,13 +904,20 @@ module Google
884
904
  # @!attribute [rw] quota_project
885
905
  # A separate project against which to charge quota.
886
906
  # @return [::String]
907
+ # @!attribute [rw] universe_domain
908
+ # The universe domain within which to make requests. This determines the
909
+ # default endpoint URL. The default value of nil uses the environment
910
+ # universe (usually the default "googleapis.com" universe).
911
+ # @return [::String,nil]
887
912
  #
888
913
  class Configuration
889
914
  extend ::Gapic::Config
890
915
 
916
+ # @private
917
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
891
918
  DEFAULT_ENDPOINT = "documentai.googleapis.com"
892
919
 
893
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
920
+ config_attr :endpoint, nil, ::String, nil
894
921
  config_attr :credentials, nil do |value|
895
922
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
896
923
  allowed.any? { |klass| klass === value }
@@ -902,6 +929,7 @@ module Google
902
929
  config_attr :metadata, nil, ::Hash, nil
903
930
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
904
931
  config_attr :quota_project, nil, ::String, nil
932
+ config_attr :universe_domain, nil, ::String, nil
905
933
 
906
934
  # @private
907
935
  # Overrides for http bindings for the RPCs of this service
data/lib/google/cloud/document_ai/v1beta3/document_service/rest/operations.rb CHANGED
@@ -26,6 +26,9 @@ module Google
26
26
  module Rest
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "documentai.$UNIVERSE_DOMAIN$"
31
+
29
32
  # @private
30
33
  attr_reader :operations_stub
31
34
 
@@ -60,6 +63,15 @@ module Google
60
63
  @config
61
64
  end
62
65
 
66
+ ##
67
+ # The effective universe domain
68
+ #
69
+ # @return [String]
70
+ #
71
+ def universe_domain
72
+ @operations_stub.universe_domain
73
+ end
74
+
63
75
  ##
64
76
  # Create a new Operations client object.
65
77
  #
@@ -84,8 +96,10 @@ module Google
84
96
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
85
97
 
86
98
  @operations_stub = OperationsServiceStub.new(
87
- endpoint: @config.endpoint,
88
- credentials: credentials
99
+ endpoint: @config.endpoint,
100
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
101
+ universe_domain: @config.universe_domain,
102
+ credentials: credentials
89
103
  )
90
104
 
91
105
  # Used by an LRO wrapper for some methods of this service
@@ -478,9 +492,9 @@ module Google
478
492
  # end
479
493
  #
480
494
  # @!attribute [rw] endpoint
481
- # The hostname or hostname:port of the service endpoint.
482
- # Defaults to `"documentai.googleapis.com"`.
483
- # @return [::String]
495
+ # A custom service endpoint, as a hostname or hostname:port. The default is
496
+ # nil, indicating to use the default endpoint in the current universe domain.
497
+ # @return [::String,nil]
484
498
  # @!attribute [rw] credentials
485
499
  # Credentials to send with calls. You may provide any of the following types:
486
500
  # * (`String`) The path to a service account key file in JSON format
@@ -517,13 +531,20 @@ module Google
517
531
  # @!attribute [rw] quota_project
518
532
  # A separate project against which to charge quota.
519
533
  # @return [::String]
534
+ # @!attribute [rw] universe_domain
535
+ # The universe domain within which to make requests. This determines the
536
+ # default endpoint URL. The default value of nil uses the environment
537
+ # universe (usually the default "googleapis.com" universe).
538
+ # @return [::String,nil]
520
539
  #
521
540
  class Configuration
522
541
  extend ::Gapic::Config
523
542
 
543
+ # @private
544
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
524
545
  DEFAULT_ENDPOINT = "documentai.googleapis.com"
525
546
 
526
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
547
+ config_attr :endpoint, nil, ::String, nil
527
548
  config_attr :credentials, nil do |value|
528
549
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
529
550
  allowed.any? { |klass| klass === value }
@@ -535,6 +556,7 @@ module Google
535
556
  config_attr :metadata, nil, ::Hash, nil
536
557
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
537
558
  config_attr :quota_project, nil, ::String, nil
559
+ config_attr :universe_domain, nil, ::String, nil
538
560
 
539
561
  # @private
540
562
  def initialize parent_config = nil
@@ -617,12 +639,15 @@ module Google
617
639
  # Service stub contains baseline method implementations
618
640
  # including transcoding, making the REST call, and deserialing the response.
619
641
  class OperationsServiceStub
620
- def initialize endpoint:, credentials:
642
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
621
643
  # These require statements are intentionally placed here to initialize
622
644
  # the REST modules only when it's required.
623
645
  require "gapic/rest"
624
646
 
625
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials
647
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
648
+ endpoint_template: endpoint_template,
649
+ universe_domain: universe_domain,
650
+ credentials: credentials
626
651
  end
627
652
 
628
653
  ##
data/lib/google/cloud/document_ai/v1beta3/document_service/rest/service_stub.rb CHANGED
@@ -30,16 +30,28 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, credentials:
33
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
34
34
  # These require statements are intentionally placed here to initialize
35
35
  # the REST modules only when it's required.
36
36
  require "gapic/rest"
37
37
 
38
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
38
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
39
+ endpoint_template: endpoint_template,
40
+ universe_domain: universe_domain,
41
+ credentials: credentials,
39
42
  numeric_enums: true,
40
43
  raise_faraday_errors: false
41
44
  end
42
45
 
46
+ ##
47
+ # The effective universe domain
48
+ #
49
+ # @return [String]
50
+ #
51
+ def universe_domain
52
+ @client_stub.universe_domain
53
+ end
54
+
43
55
  ##
44
56
  # Baseline implementation for the update_dataset REST call
45
57
  #
data/lib/google/cloud/document_ai/v1beta3/version.rb CHANGED
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module DocumentAI
23
23
  module V1beta3
24
- VERSION = "0.29.0"
24
+ VERSION = "0.30.0"
25
25
  end
26
26
  end
27
27
  end
data/proto_docs/google/api/client.rb CHANGED
@@ -21,6 +21,7 @@ module Google
21
21
  module Api
22
22
  # Required information for every language.
23
23
  # @!attribute [rw] reference_docs_uri
24
+ # @deprecated This field is deprecated and may be removed in the next major version update.
24
25
  # @return [::String]
25
26
  # Link to automatically generated reference documentation. Example:
26
27
  # https://cloud.google.com/nodejs/docs/reference/asset/latest
@@ -304,6 +305,19 @@ module Google
304
305
  # seconds: 360 # 6 minutes
305
306
  # total_poll_timeout:
306
307
  # seconds: 54000 # 90 minutes
308
+ # @!attribute [rw] auto_populated_fields
309
+ # @return [::Array<::String>]
310
+ # List of top-level fields of the request message, that should be
311
+ # automatically populated by the client libraries based on their
312
+ # (google.api.field_info).format. Currently supported format: UUID4.
313
+ #
314
+ # Example of a YAML configuration:
315
+ #
316
+ # publishing:
317
+ # method_settings:
318
+ # - selector: google.example.v1.ExampleService.CreateExample
319
+ # auto_populated_fields:
320
+ # - request_id
307
321
  class MethodSettings
308
322
  include ::Google::Protobuf::MessageExts
309
323
  extend ::Google::Protobuf::MessageExts::ClassMethods
data/proto_docs/google/cloud/documentai/v1beta3/dataset.rb CHANGED
@@ -126,6 +126,7 @@ module Google
126
126
  # @return [::String]
127
127
  # Required. The Cloud Storage URI where the actual document is stored.
128
128
  # @!attribute [rw] cw_doc_id
129
+ # @deprecated This field is deprecated and may be removed in the next major version update.
129
130
  # @return [::String]
130
131
  # Id of the document (indexed) managed by Content Warehouse.
131
132
  class GCSManagedDocumentId
data/proto_docs/google/cloud/documentai/v1beta3/document.rb CHANGED
@@ -44,6 +44,7 @@ module Google
44
44
  # @return [::String]
45
45
  # Optional. UTF-8 encoded text in reading order from the document.
46
46
  # @!attribute [rw] text_styles
47
+ # @deprecated This field is deprecated and may be removed in the next major version update.
47
48
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Style>]
48
49
  # Styles for the
49
50
  # {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
@@ -214,6 +215,7 @@ module Google
214
215
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::ImageQualityScores]
215
216
  # Image quality scores.
216
217
  # @!attribute [rw] provenance
218
+ # @deprecated This field is deprecated and may be removed in the next major version update.
217
219
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
218
220
  # The history of this page.
219
221
  class Page
@@ -333,6 +335,7 @@ module Google
333
335
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
334
336
  # A list of detected languages together with confidence.
335
337
  # @!attribute [rw] provenance
338
+ # @deprecated This field is deprecated and may be removed in the next major version update.
336
339
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
337
340
  # The history of this annotation.
338
341
  class Block
@@ -349,6 +352,7 @@ module Google
349
352
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
350
353
  # A list of detected languages together with confidence.
351
354
  # @!attribute [rw] provenance
355
+ # @deprecated This field is deprecated and may be removed in the next major version update.
352
356
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
353
357
  # The history of this annotation.
354
358
  class Paragraph
@@ -366,6 +370,7 @@ module Google
366
370
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
367
371
  # A list of detected languages together with confidence.
368
372
  # @!attribute [rw] provenance
373
+ # @deprecated This field is deprecated and may be removed in the next major version update.
369
374
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
370
375
  # The history of this annotation.
371
376
  class Line
@@ -386,6 +391,7 @@ module Google
386
391
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
387
392
  # A list of detected languages together with confidence.
388
393
  # @!attribute [rw] provenance
394
+ # @deprecated This field is deprecated and may be removed in the next major version update.
389
395
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
390
396
  # The history of this annotation.
391
397
  # @!attribute [rw] style_info
@@ -523,6 +529,7 @@ module Google
523
529
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>]
524
530
  # A list of detected languages together with confidence.
525
531
  # @!attribute [rw] provenance
532
+ # @deprecated This field is deprecated and may be removed in the next major version update.
526
533
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
527
534
  # The history of this table.
528
535
  class Table
@@ -836,6 +843,7 @@ module Google
836
843
  # Optional. The type of the layout element that is being referenced if
837
844
  # any.
838
845
  # @!attribute [rw] layout_id
846
+ # @deprecated This field is deprecated and may be removed in the next major version update.
839
847
  # @return [::String]
840
848
  # Optional. Deprecated. Use
841
849
  # {::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef#bounding_poly PageRef.bounding_poly}
@@ -898,9 +906,11 @@ module Google
898
906
  # Structure to identify provenance relationships between annotations in
899
907
  # different revisions.
900
908
  # @!attribute [rw] revision
909
+ # @deprecated This field is deprecated and may be removed in the next major version update.
901
910
  # @return [::Integer]
902
911
  # The index of the revision that produced this element.
903
912
  # @!attribute [rw] id
913
+ # @deprecated This field is deprecated and may be removed in the next major version update.
904
914
  # @return [::Integer]
905
915
  # The Id of this operation. Needs to be unique within the scope of the
906
916
  # revision.
@@ -924,6 +934,7 @@ module Google
924
934
  # The index of the parent item in the corresponding item list (eg. list
925
935
  # of entities, properties within entities, etc.) in the parent revision.
926
936
  # @!attribute [rw] id
937
+ # @deprecated This field is deprecated and may be removed in the next major version update.
927
938
  # @return [::Integer]
928
939
  # The id of the parent provenance.
929
940
  class Parent
@@ -979,6 +990,7 @@ module Google
979
990
  # Id of the revision, internally generated by doc proto storage.
980
991
  # Unique within the context of the document.
981
992
  # @!attribute [rw] parent
993
+ # @deprecated This field is deprecated and may be removed in the next major version update.
982
994
  # @return [::Array<::Integer>]
983
995
  # The revisions that this revision is based on. This can include one or
984
996
  # more parent (when documents are merged.) This field represents the
@@ -1026,6 +1038,7 @@ module Google
1026
1038
  # @return [::String]
1027
1039
  # The text that replaces the text identified in the `text_anchor`.
1028
1040
  # @!attribute [rw] provenance
1041
+ # @deprecated This field is deprecated and may be removed in the next major version update.
1029
1042
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Provenance>]
1030
1043
  # The history of this annotation.
1031
1044
  class TextChange
data/proto_docs/google/cloud/documentai/v1beta3/document_io.rb CHANGED
@@ -148,6 +148,7 @@ module Google
148
148
  # @return [::Boolean]
149
149
  # Includes symbol level OCR information if set to true.
150
150
  # @!attribute [rw] compute_style_info
151
+ # @deprecated This field is deprecated and may be removed in the next major version update.
151
152
  # @return [::Boolean]
152
153
  # Turn on font identification model and return font style information.
153
154
  # Deprecated, use