google-apis-documentai_v1beta3 0.5.0 → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DocumentaiV1beta3
18
18
  # Version of the google-apis-documentai_v1beta3 gem
19
- GEM_VERSION = "0.5.0"
19
+ GEM_VERSION = "0.10.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.1.2"
22
+ GENERATOR_VERSION = "0.2.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20210226"
25
+ REVISION = "20210507"
26
26
  end
27
27
  end
28
28
  end
@@ -400,12 +400,6 @@ module Google
400
400
  include Google::Apis::Core::JsonObjectSupport
401
401
  end
402
402
 
403
- class GoogleCloudDocumentaiV1beta1DocumentTranslation
404
- class Representation < Google::Apis::Core::JsonRepresentation; end
405
-
406
- include Google::Apis::Core::JsonObjectSupport
407
- end
408
-
409
403
  class GoogleCloudDocumentaiV1beta1GcsDestination
410
404
  class Representation < Google::Apis::Core::JsonRepresentation; end
411
405
 
@@ -664,12 +658,6 @@ module Google
664
658
  include Google::Apis::Core::JsonObjectSupport
665
659
  end
666
660
 
667
- class GoogleCloudDocumentaiV1beta2DocumentTranslation
668
- class Representation < Google::Apis::Core::JsonRepresentation; end
669
-
670
- include Google::Apis::Core::JsonObjectSupport
671
- end
672
-
673
661
  class GoogleCloudDocumentaiV1beta2GcsDestination
674
662
  class Representation < Google::Apis::Core::JsonRepresentation; end
675
663
 
@@ -772,6 +760,12 @@ module Google
772
760
  include Google::Apis::Core::JsonObjectSupport
773
761
  end
774
762
 
763
+ class GoogleCloudDocumentaiV1beta3DisableProcessorRequest
764
+ class Representation < Google::Apis::Core::JsonRepresentation; end
765
+
766
+ include Google::Apis::Core::JsonObjectSupport
767
+ end
768
+
775
769
  class GoogleCloudDocumentaiV1beta3Document
776
770
  class Representation < Google::Apis::Core::JsonRepresentation; end
777
771
 
@@ -976,7 +970,13 @@ module Google
976
970
  include Google::Apis::Core::JsonObjectSupport
977
971
  end
978
972
 
979
- class GoogleCloudDocumentaiV1beta3DocumentTranslation
973
+ class GoogleCloudDocumentaiV1beta3EnableProcessorRequest
974
+ class Representation < Google::Apis::Core::JsonRepresentation; end
975
+
976
+ include Google::Apis::Core::JsonObjectSupport
977
+ end
978
+
979
+ class GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse
980
980
  class Representation < Google::Apis::Core::JsonRepresentation; end
981
981
 
982
982
  include Google::Apis::Core::JsonObjectSupport
@@ -1006,6 +1006,12 @@ module Google
1006
1006
  include Google::Apis::Core::JsonObjectSupport
1007
1007
  end
1008
1008
 
1009
+ class GoogleCloudDocumentaiV1beta3ListProcessorsResponse
1010
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1011
+
1012
+ include Google::Apis::Core::JsonObjectSupport
1013
+ end
1014
+
1009
1015
  class GoogleCloudDocumentaiV1beta3NormalizedVertex
1010
1016
  class Representation < Google::Apis::Core::JsonRepresentation; end
1011
1017
 
@@ -1024,6 +1030,24 @@ module Google
1024
1030
  include Google::Apis::Core::JsonObjectSupport
1025
1031
  end
1026
1032
 
1033
+ class GoogleCloudDocumentaiV1beta3Processor
1034
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1035
+
1036
+ include Google::Apis::Core::JsonObjectSupport
1037
+ end
1038
+
1039
+ class GoogleCloudDocumentaiV1beta3ProcessorType
1040
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1041
+
1042
+ include Google::Apis::Core::JsonObjectSupport
1043
+ end
1044
+
1045
+ class GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo
1046
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1047
+
1048
+ include Google::Apis::Core::JsonObjectSupport
1049
+ end
1050
+
1027
1051
  class GoogleCloudDocumentaiV1beta3RawDocument
1028
1052
  class Representation < Google::Apis::Core::JsonRepresentation; end
1029
1053
 
@@ -1048,6 +1072,18 @@ module Google
1048
1072
  include Google::Apis::Core::JsonObjectSupport
1049
1073
  end
1050
1074
 
1075
+ class GoogleCloudDocumentaiV1beta3Schema
1076
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1077
+
1078
+ include Google::Apis::Core::JsonObjectSupport
1079
+ end
1080
+
1081
+ class GoogleCloudDocumentaiV1beta3SchemaEntityType
1082
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1083
+
1084
+ include Google::Apis::Core::JsonObjectSupport
1085
+ end
1086
+
1051
1087
  class GoogleCloudDocumentaiV1beta3Vertex
1052
1088
  class Representation < Google::Apis::Core::JsonRepresentation; end
1053
1089
 
@@ -1248,8 +1284,10 @@ module Google
1248
1284
  class GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation
1249
1285
  # @private
1250
1286
  class Representation < Google::Apis::Core::JsonRepresentation
1287
+ property :dataset_error_count, as: 'datasetErrorCount'
1251
1288
  collection :dataset_errors, as: 'datasetErrors', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
1252
1289
 
1290
+ property :document_error_count, as: 'documentErrorCount'
1253
1291
  collection :document_errors, as: 'documentErrors', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
1254
1292
 
1255
1293
  end
@@ -1396,8 +1434,6 @@ module Google
1396
1434
 
1397
1435
  collection :text_styles, as: 'textStyles', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentStyle, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentStyle::Representation
1398
1436
 
1399
- collection :translations, as: 'translations', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentTranslation, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentTranslation::Representation
1400
-
1401
1437
  property :uri, as: 'uri'
1402
1438
  end
1403
1439
  end
@@ -1493,6 +1529,7 @@ module Google
1493
1529
  class Representation < Google::Apis::Core::JsonRepresentation
1494
1530
  property :bounding_poly, as: 'boundingPoly', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1BoundingPoly, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1BoundingPoly::Representation
1495
1531
 
1532
+ property :confidence, as: 'confidence'
1496
1533
  property :layout_id, as: 'layoutId'
1497
1534
  property :layout_type, as: 'layoutType'
1498
1535
  property :page, :numeric_string => true, as: 'page'
@@ -1680,6 +1717,7 @@ module Google
1680
1717
  # @private
1681
1718
  class Representation < Google::Apis::Core::JsonRepresentation
1682
1719
  property :id, as: 'id'
1720
+ property :index, as: 'index'
1683
1721
  property :revision, as: 'revision'
1684
1722
  end
1685
1723
  end
@@ -1767,18 +1805,6 @@ module Google
1767
1805
  end
1768
1806
  end
1769
1807
 
1770
- class GoogleCloudDocumentaiV1beta1DocumentTranslation
1771
- # @private
1772
- class Representation < Google::Apis::Core::JsonRepresentation
1773
- property :language_code, as: 'languageCode'
1774
- collection :provenance, as: 'provenance', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentProvenance, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentProvenance::Representation
1775
-
1776
- property :text_anchor, as: 'textAnchor', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentTextAnchor, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentTextAnchor::Representation
1777
-
1778
- property :translated_text, as: 'translatedText'
1779
- end
1780
- end
1781
-
1782
1808
  class GoogleCloudDocumentaiV1beta1GcsDestination
1783
1809
  # @private
1784
1810
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1889,8 +1915,6 @@ module Google
1889
1915
 
1890
1916
  collection :text_styles, as: 'textStyles', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentStyle, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentStyle::Representation
1891
1917
 
1892
- collection :translations, as: 'translations', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentTranslation, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentTranslation::Representation
1893
-
1894
1918
  property :uri, as: 'uri'
1895
1919
  end
1896
1920
  end
@@ -1995,6 +2019,7 @@ module Google
1995
2019
  class Representation < Google::Apis::Core::JsonRepresentation
1996
2020
  property :bounding_poly, as: 'boundingPoly', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2BoundingPoly, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2BoundingPoly::Representation
1997
2021
 
2022
+ property :confidence, as: 'confidence'
1998
2023
  property :layout_id, as: 'layoutId'
1999
2024
  property :layout_type, as: 'layoutType'
2000
2025
  property :page, :numeric_string => true, as: 'page'
@@ -2182,6 +2207,7 @@ module Google
2182
2207
  # @private
2183
2208
  class Representation < Google::Apis::Core::JsonRepresentation
2184
2209
  property :id, as: 'id'
2210
+ property :index, as: 'index'
2185
2211
  property :revision, as: 'revision'
2186
2212
  end
2187
2213
  end
@@ -2269,18 +2295,6 @@ module Google
2269
2295
  end
2270
2296
  end
2271
2297
 
2272
- class GoogleCloudDocumentaiV1beta2DocumentTranslation
2273
- # @private
2274
- class Representation < Google::Apis::Core::JsonRepresentation
2275
- property :language_code, as: 'languageCode'
2276
- collection :provenance, as: 'provenance', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentProvenance, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentProvenance::Representation
2277
-
2278
- property :text_anchor, as: 'textAnchor', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentTextAnchor, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentTextAnchor::Representation
2279
-
2280
- property :translated_text, as: 'translatedText'
2281
- end
2282
- end
2283
-
2284
2298
  class GoogleCloudDocumentaiV1beta2GcsDestination
2285
2299
  # @private
2286
2300
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2441,6 +2455,12 @@ module Google
2441
2455
  end
2442
2456
  end
2443
2457
 
2458
+ class GoogleCloudDocumentaiV1beta3DisableProcessorRequest
2459
+ # @private
2460
+ class Representation < Google::Apis::Core::JsonRepresentation
2461
+ end
2462
+ end
2463
+
2444
2464
  class GoogleCloudDocumentaiV1beta3Document
2445
2465
  # @private
2446
2466
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2463,8 +2483,6 @@ module Google
2463
2483
 
2464
2484
  collection :text_styles, as: 'textStyles', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentStyle, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentStyle::Representation
2465
2485
 
2466
- collection :translations, as: 'translations', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentTranslation, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentTranslation::Representation
2467
-
2468
2486
  property :uri, as: 'uri'
2469
2487
  end
2470
2488
  end
@@ -2575,6 +2593,7 @@ module Google
2575
2593
  class Representation < Google::Apis::Core::JsonRepresentation
2576
2594
  property :bounding_poly, as: 'boundingPoly', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BoundingPoly, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BoundingPoly::Representation
2577
2595
 
2596
+ property :confidence, as: 'confidence'
2578
2597
  property :layout_id, as: 'layoutId'
2579
2598
  property :layout_type, as: 'layoutType'
2580
2599
  property :page, :numeric_string => true, as: 'page'
@@ -2762,6 +2781,7 @@ module Google
2762
2781
  # @private
2763
2782
  class Representation < Google::Apis::Core::JsonRepresentation
2764
2783
  property :id, as: 'id'
2784
+ property :index, as: 'index'
2765
2785
  property :revision, as: 'revision'
2766
2786
  end
2767
2787
  end
@@ -2849,15 +2869,17 @@ module Google
2849
2869
  end
2850
2870
  end
2851
2871
 
2852
- class GoogleCloudDocumentaiV1beta3DocumentTranslation
2872
+ class GoogleCloudDocumentaiV1beta3EnableProcessorRequest
2853
2873
  # @private
2854
2874
  class Representation < Google::Apis::Core::JsonRepresentation
2855
- property :language_code, as: 'languageCode'
2856
- collection :provenance, as: 'provenance', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentProvenance, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentProvenance::Representation
2875
+ end
2876
+ end
2857
2877
 
2858
- property :text_anchor, as: 'textAnchor', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentTextAnchor, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentTextAnchor::Representation
2878
+ class GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse
2879
+ # @private
2880
+ class Representation < Google::Apis::Core::JsonRepresentation
2881
+ collection :processor_types, as: 'processorTypes', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorType, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorType::Representation
2859
2882
 
2860
- property :translated_text, as: 'translatedText'
2861
2883
  end
2862
2884
  end
2863
2885
 
@@ -2893,6 +2915,15 @@ module Google
2893
2915
  end
2894
2916
  end
2895
2917
 
2918
+ class GoogleCloudDocumentaiV1beta3ListProcessorsResponse
2919
+ # @private
2920
+ class Representation < Google::Apis::Core::JsonRepresentation
2921
+ property :next_page_token, as: 'nextPageToken'
2922
+ collection :processors, as: 'processors', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor::Representation
2923
+
2924
+ end
2925
+ end
2926
+
2896
2927
  class GoogleCloudDocumentaiV1beta3NormalizedVertex
2897
2928
  # @private
2898
2929
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2925,6 +2956,41 @@ module Google
2925
2956
  end
2926
2957
  end
2927
2958
 
2959
+ class GoogleCloudDocumentaiV1beta3Processor
2960
+ # @private
2961
+ class Representation < Google::Apis::Core::JsonRepresentation
2962
+ property :create_time, as: 'createTime'
2963
+ property :default_processor_version, as: 'defaultProcessorVersion'
2964
+ property :display_name, as: 'displayName'
2965
+ property :kms_key_name, as: 'kmsKeyName'
2966
+ property :name, as: 'name'
2967
+ property :process_endpoint, as: 'processEndpoint'
2968
+ property :state, as: 'state'
2969
+ property :type, as: 'type'
2970
+ end
2971
+ end
2972
+
2973
+ class GoogleCloudDocumentaiV1beta3ProcessorType
2974
+ # @private
2975
+ class Representation < Google::Apis::Core::JsonRepresentation
2976
+ property :allow_creation, as: 'allowCreation'
2977
+ collection :available_locations, as: 'availableLocations', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo::Representation
2978
+
2979
+ property :category, as: 'category'
2980
+ property :name, as: 'name'
2981
+ property :schema, as: 'schema', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Schema, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Schema::Representation
2982
+
2983
+ property :type, as: 'type'
2984
+ end
2985
+ end
2986
+
2987
+ class GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo
2988
+ # @private
2989
+ class Representation < Google::Apis::Core::JsonRepresentation
2990
+ property :location_id, as: 'locationId'
2991
+ end
2992
+ end
2993
+
2928
2994
  class GoogleCloudDocumentaiV1beta3RawDocument
2929
2995
  # @private
2930
2996
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2962,6 +3028,30 @@ module Google
2962
3028
  end
2963
3029
  end
2964
3030
 
3031
+ class GoogleCloudDocumentaiV1beta3Schema
3032
+ # @private
3033
+ class Representation < Google::Apis::Core::JsonRepresentation
3034
+ property :description, as: 'description'
3035
+ property :display_name, as: 'displayName'
3036
+ collection :entity_types, as: 'entityTypes', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType::Representation
3037
+
3038
+ end
3039
+ end
3040
+
3041
+ class GoogleCloudDocumentaiV1beta3SchemaEntityType
3042
+ # @private
3043
+ class Representation < Google::Apis::Core::JsonRepresentation
3044
+ property :base_type, as: 'baseType'
3045
+ property :description, as: 'description'
3046
+ collection :enum_values, as: 'enumValues'
3047
+ property :occurrence_type, as: 'occurrenceType'
3048
+ collection :properties, as: 'properties', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType::Representation
3049
+
3050
+ property :source, as: 'source'
3051
+ property :type, as: 'type'
3052
+ end
3053
+ end
3054
+
2965
3055
  class GoogleCloudDocumentaiV1beta3Vertex
2966
3056
  # @private
2967
3057
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -51,6 +51,38 @@ module Google
51
51
  @batch_path = 'batch'
52
52
  end
53
53
 
54
+ # Fetches processor types.
55
+ # @param [String] parent
56
+ # Required. The project of processor type to list. The available processor types
57
+ # may depend on the whitelisting on projects. Format: projects/`project`/
58
+ # locations/`location`
59
+ # @param [String] fields
60
+ # Selector specifying which fields to include in a partial response.
61
+ # @param [String] quota_user
62
+ # Available to use for quota purposes for server-side applications. Can be any
63
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
64
+ # @param [Google::Apis::RequestOptions] options
65
+ # Request-specific options
66
+ #
67
+ # @yield [result, err] Result & error if block supplied
68
+ # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse] parsed result object
69
+ # @yieldparam err [StandardError] error object if request failed
70
+ #
71
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse]
72
+ #
73
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
74
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
75
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
76
+ def fetch_project_location_processor_types(parent, fields: nil, quota_user: nil, options: nil, &block)
77
+ command = make_simple_command(:get, 'v1beta3/{+parent}:fetchProcessorTypes', options)
78
+ command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse::Representation
79
+ command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse
80
+ command.params['parent'] = parent unless parent.nil?
81
+ command.query['fields'] = fields unless fields.nil?
82
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
83
+ execute_or_queue_command(command, &block)
84
+ end
85
+
54
86
  # Gets information about a location.
55
87
  # @param [String] name
56
88
  # Resource name for the location.
@@ -85,11 +117,15 @@ module Google
85
117
  # @param [String] name
86
118
  # The resource that owns the locations collection, if applicable.
87
119
  # @param [String] filter
88
- # The standard list filter.
120
+ # A filter to narrow down results to a preferred subset. The filtering language
121
+ # accepts strings like "displayName=tokyo", and is documented in more detail in [
122
+ # AIP-160](https://google.aip.dev/160).
89
123
  # @param [Fixnum] page_size
90
- # The standard list page size.
124
+ # The maximum number of results to return. If not set, the service selects a
125
+ # default.
91
126
  # @param [String] page_token
92
- # The standard list page token.
127
+ # A page token received from the `next_page_token` field in the response. Send
128
+ # that page token to receive the subsequent page.
93
129
  # @param [String] fields
94
130
  # Selector specifying which fields to include in a partial response.
95
131
  # @param [String] quota_user
@@ -156,7 +192,8 @@ module Google
156
192
  # @param [String] name
157
193
  # Required. The resource name of Processor or ProcessorVersion. Format: projects/
158
194
  # `project`/locations/`location`/processors/`processor`, or projects/`project`/
159
- # locations/`location`/processors/`processor`/processorVerions/`processorVersion`
195
+ # locations/`location`/processors/`processor`/processorVersions/`
196
+ # processorVersion`
160
197
  # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequest] google_cloud_documentai_v1beta3_batch_process_request_object
161
198
  # @param [String] fields
162
199
  # Selector specifying which fields to include in a partial response.
@@ -187,13 +224,185 @@ module Google
187
224
  execute_or_queue_command(command, &block)
188
225
  end
189
226
 
227
+ # Creates a processor from the type processor that the user chose. The processor
228
+ # will be at "ENABLED" state by default after its creation.
229
+ # @param [String] parent
230
+ # Required. The parent (project and location) under which to create the
231
+ # processor. Format: projects/`project`/locations/`location`
232
+ # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor] google_cloud_documentai_v1beta3_processor_object
233
+ # @param [String] fields
234
+ # Selector specifying which fields to include in a partial response.
235
+ # @param [String] quota_user
236
+ # Available to use for quota purposes for server-side applications. Can be any
237
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
238
+ # @param [Google::Apis::RequestOptions] options
239
+ # Request-specific options
240
+ #
241
+ # @yield [result, err] Result & error if block supplied
242
+ # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor] parsed result object
243
+ # @yieldparam err [StandardError] error object if request failed
244
+ #
245
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor]
246
+ #
247
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
248
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
249
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
250
+ def create_project_location_processor(parent, google_cloud_documentai_v1beta3_processor_object = nil, fields: nil, quota_user: nil, options: nil, &block)
251
+ command = make_simple_command(:post, 'v1beta3/{+parent}/processors', options)
252
+ command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor::Representation
253
+ command.request_object = google_cloud_documentai_v1beta3_processor_object
254
+ command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor::Representation
255
+ command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor
256
+ command.params['parent'] = parent unless parent.nil?
257
+ command.query['fields'] = fields unless fields.nil?
258
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
259
+ execute_or_queue_command(command, &block)
260
+ end
261
+
262
+ # Deletes the processor, unloads all deployed model artifacts if it was enabled
263
+ # and then deletes all artifacts associated with this processor.
264
+ # @param [String] name
265
+ # Required. The processor resource name to be deleted.
266
+ # @param [String] fields
267
+ # Selector specifying which fields to include in a partial response.
268
+ # @param [String] quota_user
269
+ # Available to use for quota purposes for server-side applications. Can be any
270
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
271
+ # @param [Google::Apis::RequestOptions] options
272
+ # Request-specific options
273
+ #
274
+ # @yield [result, err] Result & error if block supplied
275
+ # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] parsed result object
276
+ # @yieldparam err [StandardError] error object if request failed
277
+ #
278
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation]
279
+ #
280
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
281
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
282
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
283
+ def delete_project_location_processor(name, fields: nil, quota_user: nil, options: nil, &block)
284
+ command = make_simple_command(:delete, 'v1beta3/{+name}', options)
285
+ command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation::Representation
286
+ command.response_class = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation
287
+ command.params['name'] = name unless name.nil?
288
+ command.query['fields'] = fields unless fields.nil?
289
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
290
+ execute_or_queue_command(command, &block)
291
+ end
292
+
293
+ # Disables a processor
294
+ # @param [String] name
295
+ # Required. The processor resource name to be disabled.
296
+ # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DisableProcessorRequest] google_cloud_documentai_v1beta3_disable_processor_request_object
297
+ # @param [String] fields
298
+ # Selector specifying which fields to include in a partial response.
299
+ # @param [String] quota_user
300
+ # Available to use for quota purposes for server-side applications. Can be any
301
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
302
+ # @param [Google::Apis::RequestOptions] options
303
+ # Request-specific options
304
+ #
305
+ # @yield [result, err] Result & error if block supplied
306
+ # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] parsed result object
307
+ # @yieldparam err [StandardError] error object if request failed
308
+ #
309
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation]
310
+ #
311
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
312
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
313
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
314
+ def disable_project_location_processor(name, google_cloud_documentai_v1beta3_disable_processor_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
315
+ command = make_simple_command(:post, 'v1beta3/{+name}:disable', options)
316
+ command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DisableProcessorRequest::Representation
317
+ command.request_object = google_cloud_documentai_v1beta3_disable_processor_request_object
318
+ command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation::Representation
319
+ command.response_class = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation
320
+ command.params['name'] = name unless name.nil?
321
+ command.query['fields'] = fields unless fields.nil?
322
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
323
+ execute_or_queue_command(command, &block)
324
+ end
325
+
326
+ # Enables a processor
327
+ # @param [String] name
328
+ # Required. The processor resource name to be enabled.
329
+ # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EnableProcessorRequest] google_cloud_documentai_v1beta3_enable_processor_request_object
330
+ # @param [String] fields
331
+ # Selector specifying which fields to include in a partial response.
332
+ # @param [String] quota_user
333
+ # Available to use for quota purposes for server-side applications. Can be any
334
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
335
+ # @param [Google::Apis::RequestOptions] options
336
+ # Request-specific options
337
+ #
338
+ # @yield [result, err] Result & error if block supplied
339
+ # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] parsed result object
340
+ # @yieldparam err [StandardError] error object if request failed
341
+ #
342
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation]
343
+ #
344
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
345
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
346
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
347
+ def enable_project_location_processor(name, google_cloud_documentai_v1beta3_enable_processor_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
348
+ command = make_simple_command(:post, 'v1beta3/{+name}:enable', options)
349
+ command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EnableProcessorRequest::Representation
350
+ command.request_object = google_cloud_documentai_v1beta3_enable_processor_request_object
351
+ command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation::Representation
352
+ command.response_class = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation
353
+ command.params['name'] = name unless name.nil?
354
+ command.query['fields'] = fields unless fields.nil?
355
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
356
+ execute_or_queue_command(command, &block)
357
+ end
358
+
359
+ # Lists all processors which belong to this project.
360
+ # @param [String] parent
361
+ # Required. The parent (project and location) which owns this collection of
362
+ # Processors. Format: projects/`project`/locations/`location`
363
+ # @param [Fixnum] page_size
364
+ # The maximum number of processors to return. If unspecified, at most 50
365
+ # processors will be returned. The maximum value is 100; values above 100 will
366
+ # be coerced to 100.
367
+ # @param [String] page_token
368
+ # We will return the processors sorted by creation time. The page token will
369
+ # point to the next processor.
370
+ # @param [String] fields
371
+ # Selector specifying which fields to include in a partial response.
372
+ # @param [String] quota_user
373
+ # Available to use for quota purposes for server-side applications. Can be any
374
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
375
+ # @param [Google::Apis::RequestOptions] options
376
+ # Request-specific options
377
+ #
378
+ # @yield [result, err] Result & error if block supplied
379
+ # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListProcessorsResponse] parsed result object
380
+ # @yieldparam err [StandardError] error object if request failed
381
+ #
382
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListProcessorsResponse]
383
+ #
384
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
385
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
386
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
387
+ def list_project_location_processors(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
388
+ command = make_simple_command(:get, 'v1beta3/{+parent}/processors', options)
389
+ command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListProcessorsResponse::Representation
390
+ command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListProcessorsResponse
391
+ command.params['parent'] = parent unless parent.nil?
392
+ command.query['pageSize'] = page_size unless page_size.nil?
393
+ command.query['pageToken'] = page_token unless page_token.nil?
394
+ command.query['fields'] = fields unless fields.nil?
395
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
396
+ execute_or_queue_command(command, &block)
397
+ end
398
+
190
399
  # Processes a single document.
191
400
  # @param [String] name
192
401
  # Required. The resource name of the Processor or ProcessorVersion to use for
193
402
  # processing. If a Processor is specified, the server will use its default
194
403
  # version. Format: projects/`project`/locations/`location`/processors/`processor`
195
404
  # , or projects/`project`/locations/`location`/processors/`processor`/
196
- # processorVerions/`processorVersion`
405
+ # processorVersions/`processorVersion`
197
406
  # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessRequest] google_cloud_documentai_v1beta3_process_request_object
198
407
  # @param [String] fields
199
408
  # Selector specifying which fields to include in a partial response.
@@ -264,7 +473,8 @@ module Google
264
473
  # @param [String] name
265
474
  # Required. The resource name of Processor or ProcessorVersion. Format: projects/
266
475
  # `project`/locations/`location`/processors/`processor`, or projects/`project`/
267
- # locations/`location`/processors/`processor`/processorVerions/`processorVersion`
476
+ # locations/`location`/processors/`processor`/processorVersions/`
477
+ # processorVersion`
268
478
  # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequest] google_cloud_documentai_v1beta3_batch_process_request_object
269
479
  # @param [String] fields
270
480
  # Selector specifying which fields to include in a partial response.
@@ -301,7 +511,7 @@ module Google
301
511
  # processing. If a Processor is specified, the server will use its default
302
512
  # version. Format: projects/`project`/locations/`location`/processors/`processor`
303
513
  # , or projects/`project`/locations/`location`/processors/`processor`/
304
- # processorVerions/`processorVersion`
514
+ # processorVersions/`processorVersion`
305
515
  # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessRequest] google_cloud_documentai_v1beta3_process_request_object
306
516
  # @param [String] fields
307
517
  # Selector specifying which fields to include in a partial response.