google-apis-documentai_v1beta3 0.7.0 → 0.12.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.7.0"
19
+ GEM_VERSION = "0.12.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.2.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20210312"
25
+ REVISION = "20210520"
26
26
  end
27
27
  end
28
28
  end
@@ -100,12 +100,6 @@ module Google
100
100
  include Google::Apis::Core::JsonObjectSupport
101
101
  end
102
102
 
103
- class GoogleCloudDocumentaiUiv1beta3SampleDatasetMetadata
104
- class Representation < Google::Apis::Core::JsonRepresentation; end
105
-
106
- include Google::Apis::Core::JsonObjectSupport
107
- end
108
-
109
103
  class GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata
110
104
  class Representation < Google::Apis::Core::JsonRepresentation; end
111
105
 
@@ -766,6 +760,12 @@ module Google
766
760
  include Google::Apis::Core::JsonObjectSupport
767
761
  end
768
762
 
763
+ class GoogleCloudDocumentaiV1beta3DisableProcessorRequest
764
+ class Representation < Google::Apis::Core::JsonRepresentation; end
765
+
766
+ include Google::Apis::Core::JsonObjectSupport
767
+ end
768
+
769
769
  class GoogleCloudDocumentaiV1beta3Document
770
770
  class Representation < Google::Apis::Core::JsonRepresentation; end
771
771
 
@@ -970,6 +970,18 @@ module Google
970
970
  include Google::Apis::Core::JsonObjectSupport
971
971
  end
972
972
 
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
+ class Representation < Google::Apis::Core::JsonRepresentation; end
981
+
982
+ include Google::Apis::Core::JsonObjectSupport
983
+ end
984
+
973
985
  class GoogleCloudDocumentaiV1beta3GcsDocument
974
986
  class Representation < Google::Apis::Core::JsonRepresentation; end
975
987
 
@@ -994,6 +1006,12 @@ module Google
994
1006
  include Google::Apis::Core::JsonObjectSupport
995
1007
  end
996
1008
 
1009
+ class GoogleCloudDocumentaiV1beta3ListProcessorsResponse
1010
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1011
+
1012
+ include Google::Apis::Core::JsonObjectSupport
1013
+ end
1014
+
997
1015
  class GoogleCloudDocumentaiV1beta3NormalizedVertex
998
1016
  class Representation < Google::Apis::Core::JsonRepresentation; end
999
1017
 
@@ -1012,6 +1030,24 @@ module Google
1012
1030
  include Google::Apis::Core::JsonObjectSupport
1013
1031
  end
1014
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
+
1015
1051
  class GoogleCloudDocumentaiV1beta3RawDocument
1016
1052
  class Representation < Google::Apis::Core::JsonRepresentation; end
1017
1053
 
@@ -1036,6 +1072,18 @@ module Google
1036
1072
  include Google::Apis::Core::JsonObjectSupport
1037
1073
  end
1038
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
+
1039
1087
  class GoogleCloudDocumentaiV1beta3Vertex
1040
1088
  class Representation < Google::Apis::Core::JsonRepresentation; end
1041
1089
 
@@ -1054,6 +1102,12 @@ module Google
1054
1102
  include Google::Apis::Core::JsonObjectSupport
1055
1103
  end
1056
1104
 
1105
+ class GoogleLongrunningListOperationsResponse
1106
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1107
+
1108
+ include Google::Apis::Core::JsonObjectSupport
1109
+ end
1110
+
1057
1111
  class GoogleLongrunningOperation
1058
1112
  class Representation < Google::Apis::Core::JsonRepresentation; end
1059
1113
 
@@ -1207,14 +1261,6 @@ module Google
1207
1261
  end
1208
1262
  end
1209
1263
 
1210
- class GoogleCloudDocumentaiUiv1beta3SampleDatasetMetadata
1211
- # @private
1212
- class Representation < Google::Apis::Core::JsonRepresentation
1213
- property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation
1214
-
1215
- end
1216
- end
1217
-
1218
1264
  class GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata
1219
1265
  # @private
1220
1266
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1244,8 +1290,10 @@ module Google
1244
1290
  class GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation
1245
1291
  # @private
1246
1292
  class Representation < Google::Apis::Core::JsonRepresentation
1293
+ property :dataset_error_count, as: 'datasetErrorCount'
1247
1294
  collection :dataset_errors, as: 'datasetErrors', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
1248
1295
 
1296
+ property :document_error_count, as: 'documentErrorCount'
1249
1297
  collection :document_errors, as: 'documentErrors', class: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta3::GoogleRpcStatus::Representation
1250
1298
 
1251
1299
  end
@@ -1487,6 +1535,7 @@ module Google
1487
1535
  class Representation < Google::Apis::Core::JsonRepresentation
1488
1536
  property :bounding_poly, as: 'boundingPoly', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1BoundingPoly, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1BoundingPoly::Representation
1489
1537
 
1538
+ property :confidence, as: 'confidence'
1490
1539
  property :layout_id, as: 'layoutId'
1491
1540
  property :layout_type, as: 'layoutType'
1492
1541
  property :page, :numeric_string => true, as: 'page'
@@ -1674,6 +1723,7 @@ module Google
1674
1723
  # @private
1675
1724
  class Representation < Google::Apis::Core::JsonRepresentation
1676
1725
  property :id, as: 'id'
1726
+ property :index, as: 'index'
1677
1727
  property :revision, as: 'revision'
1678
1728
  end
1679
1729
  end
@@ -1975,6 +2025,7 @@ module Google
1975
2025
  class Representation < Google::Apis::Core::JsonRepresentation
1976
2026
  property :bounding_poly, as: 'boundingPoly', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2BoundingPoly, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2BoundingPoly::Representation
1977
2027
 
2028
+ property :confidence, as: 'confidence'
1978
2029
  property :layout_id, as: 'layoutId'
1979
2030
  property :layout_type, as: 'layoutType'
1980
2031
  property :page, :numeric_string => true, as: 'page'
@@ -2162,6 +2213,7 @@ module Google
2162
2213
  # @private
2163
2214
  class Representation < Google::Apis::Core::JsonRepresentation
2164
2215
  property :id, as: 'id'
2216
+ property :index, as: 'index'
2165
2217
  property :revision, as: 'revision'
2166
2218
  end
2167
2219
  end
@@ -2409,6 +2461,12 @@ module Google
2409
2461
  end
2410
2462
  end
2411
2463
 
2464
+ class GoogleCloudDocumentaiV1beta3DisableProcessorRequest
2465
+ # @private
2466
+ class Representation < Google::Apis::Core::JsonRepresentation
2467
+ end
2468
+ end
2469
+
2412
2470
  class GoogleCloudDocumentaiV1beta3Document
2413
2471
  # @private
2414
2472
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2541,6 +2599,7 @@ module Google
2541
2599
  class Representation < Google::Apis::Core::JsonRepresentation
2542
2600
  property :bounding_poly, as: 'boundingPoly', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BoundingPoly, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BoundingPoly::Representation
2543
2601
 
2602
+ property :confidence, as: 'confidence'
2544
2603
  property :layout_id, as: 'layoutId'
2545
2604
  property :layout_type, as: 'layoutType'
2546
2605
  property :page, :numeric_string => true, as: 'page'
@@ -2728,6 +2787,7 @@ module Google
2728
2787
  # @private
2729
2788
  class Representation < Google::Apis::Core::JsonRepresentation
2730
2789
  property :id, as: 'id'
2790
+ property :index, as: 'index'
2731
2791
  property :revision, as: 'revision'
2732
2792
  end
2733
2793
  end
@@ -2815,6 +2875,20 @@ module Google
2815
2875
  end
2816
2876
  end
2817
2877
 
2878
+ class GoogleCloudDocumentaiV1beta3EnableProcessorRequest
2879
+ # @private
2880
+ class Representation < Google::Apis::Core::JsonRepresentation
2881
+ end
2882
+ end
2883
+
2884
+ class GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse
2885
+ # @private
2886
+ class Representation < Google::Apis::Core::JsonRepresentation
2887
+ collection :processor_types, as: 'processorTypes', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorType, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorType::Representation
2888
+
2889
+ end
2890
+ end
2891
+
2818
2892
  class GoogleCloudDocumentaiV1beta3GcsDocument
2819
2893
  # @private
2820
2894
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2847,6 +2921,15 @@ module Google
2847
2921
  end
2848
2922
  end
2849
2923
 
2924
+ class GoogleCloudDocumentaiV1beta3ListProcessorsResponse
2925
+ # @private
2926
+ class Representation < Google::Apis::Core::JsonRepresentation
2927
+ property :next_page_token, as: 'nextPageToken'
2928
+ collection :processors, as: 'processors', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor::Representation
2929
+
2930
+ end
2931
+ end
2932
+
2850
2933
  class GoogleCloudDocumentaiV1beta3NormalizedVertex
2851
2934
  # @private
2852
2935
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2879,6 +2962,41 @@ module Google
2879
2962
  end
2880
2963
  end
2881
2964
 
2965
+ class GoogleCloudDocumentaiV1beta3Processor
2966
+ # @private
2967
+ class Representation < Google::Apis::Core::JsonRepresentation
2968
+ property :create_time, as: 'createTime'
2969
+ property :default_processor_version, as: 'defaultProcessorVersion'
2970
+ property :display_name, as: 'displayName'
2971
+ property :kms_key_name, as: 'kmsKeyName'
2972
+ property :name, as: 'name'
2973
+ property :process_endpoint, as: 'processEndpoint'
2974
+ property :state, as: 'state'
2975
+ property :type, as: 'type'
2976
+ end
2977
+ end
2978
+
2979
+ class GoogleCloudDocumentaiV1beta3ProcessorType
2980
+ # @private
2981
+ class Representation < Google::Apis::Core::JsonRepresentation
2982
+ property :allow_creation, as: 'allowCreation'
2983
+ collection :available_locations, as: 'availableLocations', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo::Representation
2984
+
2985
+ property :category, as: 'category'
2986
+ property :name, as: 'name'
2987
+ property :schema, as: 'schema', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Schema, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Schema::Representation
2988
+
2989
+ property :type, as: 'type'
2990
+ end
2991
+ end
2992
+
2993
+ class GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo
2994
+ # @private
2995
+ class Representation < Google::Apis::Core::JsonRepresentation
2996
+ property :location_id, as: 'locationId'
2997
+ end
2998
+ end
2999
+
2882
3000
  class GoogleCloudDocumentaiV1beta3RawDocument
2883
3001
  # @private
2884
3002
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2916,6 +3034,30 @@ module Google
2916
3034
  end
2917
3035
  end
2918
3036
 
3037
+ class GoogleCloudDocumentaiV1beta3Schema
3038
+ # @private
3039
+ class Representation < Google::Apis::Core::JsonRepresentation
3040
+ property :description, as: 'description'
3041
+ property :display_name, as: 'displayName'
3042
+ collection :entity_types, as: 'entityTypes', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType::Representation
3043
+
3044
+ end
3045
+ end
3046
+
3047
+ class GoogleCloudDocumentaiV1beta3SchemaEntityType
3048
+ # @private
3049
+ class Representation < Google::Apis::Core::JsonRepresentation
3050
+ property :base_type, as: 'baseType'
3051
+ property :description, as: 'description'
3052
+ collection :enum_values, as: 'enumValues'
3053
+ property :occurrence_type, as: 'occurrenceType'
3054
+ collection :properties, as: 'properties', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3SchemaEntityType::Representation
3055
+
3056
+ property :source, as: 'source'
3057
+ property :type, as: 'type'
3058
+ end
3059
+ end
3060
+
2919
3061
  class GoogleCloudDocumentaiV1beta3Vertex
2920
3062
  # @private
2921
3063
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2944,6 +3086,15 @@ module Google
2944
3086
  end
2945
3087
  end
2946
3088
 
3089
+ class GoogleLongrunningListOperationsResponse
3090
+ # @private
3091
+ class Representation < Google::Apis::Core::JsonRepresentation
3092
+ property :next_page_token, as: 'nextPageToken'
3093
+ collection :operations, as: 'operations', class: Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation, decorator: Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation::Representation
3094
+
3095
+ end
3096
+ end
3097
+
2947
3098
  class GoogleLongrunningOperation
2948
3099
  # @private
2949
3100
  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.
@@ -89,7 +121,7 @@ module Google
89
121
  # accepts strings like "displayName=tokyo", and is documented in more detail in [
90
122
  # AIP-160](https://google.aip.dev/160).
91
123
  # @param [Fixnum] page_size
92
- # The maximum number of results to return. If not set, the service will select a
124
+ # The maximum number of results to return. If not set, the service selects a
93
125
  # default.
94
126
  # @param [String] page_token
95
127
  # A page token received from the `next_page_token` field in the response. Send
@@ -124,6 +156,43 @@ module Google
124
156
  execute_or_queue_command(command, &block)
125
157
  end
126
158
 
159
+ # Starts asynchronous cancellation on a long-running operation. The server makes
160
+ # a best effort to cancel the operation, but success is not guaranteed. If the
161
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
162
+ # Clients can use Operations.GetOperation or other methods to check whether the
163
+ # cancellation succeeded or whether the operation completed despite cancellation.
164
+ # On successful cancellation, the operation is not deleted; instead, it becomes
165
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
166
+ # corresponding to `Code.CANCELLED`.
167
+ # @param [String] name
168
+ # The name of the operation resource to be cancelled.
169
+ # @param [String] fields
170
+ # Selector specifying which fields to include in a partial response.
171
+ # @param [String] quota_user
172
+ # Available to use for quota purposes for server-side applications. Can be any
173
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
174
+ # @param [Google::Apis::RequestOptions] options
175
+ # Request-specific options
176
+ #
177
+ # @yield [result, err] Result & error if block supplied
178
+ # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleProtobufEmpty] parsed result object
179
+ # @yieldparam err [StandardError] error object if request failed
180
+ #
181
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleProtobufEmpty]
182
+ #
183
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
184
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
185
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
186
+ def cancel_project_location_operation_operation(name, fields: nil, quota_user: nil, options: nil, &block)
187
+ command = make_simple_command(:delete, 'v1beta3/{+name}', options)
188
+ command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleProtobufEmpty::Representation
189
+ command.response_class = Google::Apis::DocumentaiV1beta3::GoogleProtobufEmpty
190
+ command.params['name'] = name unless name.nil?
191
+ command.query['fields'] = fields unless fields.nil?
192
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
193
+ execute_or_queue_command(command, &block)
194
+ end
195
+
127
196
  # Gets the latest state of a long-running operation. Clients can use this method
128
197
  # to poll the operation result at intervals as recommended by the API service.
129
198
  # @param [String] name
@@ -155,6 +224,52 @@ module Google
155
224
  execute_or_queue_command(command, &block)
156
225
  end
157
226
 
227
+ # Lists operations that match the specified filter in the request. If the server
228
+ # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
229
+ # binding allows API services to override the binding to use different resource
230
+ # name schemes, such as `users/*/operations`. To override the binding, API
231
+ # services can add a binding such as `"/v1/`name=users/*`/operations"` to their
232
+ # service configuration. For backwards compatibility, the default name includes
233
+ # the operations collection id, however overriding users must ensure the name
234
+ # binding is the parent resource, without the operations collection id.
235
+ # @param [String] name
236
+ # The name of the operation's parent resource.
237
+ # @param [String] filter
238
+ # The standard list filter.
239
+ # @param [Fixnum] page_size
240
+ # The standard list page size.
241
+ # @param [String] page_token
242
+ # The standard list page token.
243
+ # @param [String] fields
244
+ # Selector specifying which fields to include in a partial response.
245
+ # @param [String] quota_user
246
+ # Available to use for quota purposes for server-side applications. Can be any
247
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
248
+ # @param [Google::Apis::RequestOptions] options
249
+ # Request-specific options
250
+ #
251
+ # @yield [result, err] Result & error if block supplied
252
+ # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleLongrunningListOperationsResponse] parsed result object
253
+ # @yieldparam err [StandardError] error object if request failed
254
+ #
255
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleLongrunningListOperationsResponse]
256
+ #
257
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
258
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
259
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
260
+ def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
261
+ command = make_simple_command(:get, 'v1beta3/{+name}', options)
262
+ command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleLongrunningListOperationsResponse::Representation
263
+ command.response_class = Google::Apis::DocumentaiV1beta3::GoogleLongrunningListOperationsResponse
264
+ command.params['name'] = name unless name.nil?
265
+ command.query['filter'] = filter unless filter.nil?
266
+ command.query['pageSize'] = page_size unless page_size.nil?
267
+ command.query['pageToken'] = page_token unless page_token.nil?
268
+ command.query['fields'] = fields unless fields.nil?
269
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
270
+ execute_or_queue_command(command, &block)
271
+ end
272
+
158
273
  # LRO endpoint to batch process many documents. The output is written to Cloud
159
274
  # Storage as JSON in the [Document] format.
160
275
  # @param [String] name
@@ -192,6 +307,178 @@ module Google
192
307
  execute_or_queue_command(command, &block)
193
308
  end
194
309
 
310
+ # Creates a processor from the type processor that the user chose. The processor
311
+ # will be at "ENABLED" state by default after its creation.
312
+ # @param [String] parent
313
+ # Required. The parent (project and location) under which to create the
314
+ # processor. Format: projects/`project`/locations/`location`
315
+ # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor] google_cloud_documentai_v1beta3_processor_object
316
+ # @param [String] fields
317
+ # Selector specifying which fields to include in a partial response.
318
+ # @param [String] quota_user
319
+ # Available to use for quota purposes for server-side applications. Can be any
320
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
321
+ # @param [Google::Apis::RequestOptions] options
322
+ # Request-specific options
323
+ #
324
+ # @yield [result, err] Result & error if block supplied
325
+ # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor] parsed result object
326
+ # @yieldparam err [StandardError] error object if request failed
327
+ #
328
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor]
329
+ #
330
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
331
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
332
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
333
+ def create_project_location_processor(parent, google_cloud_documentai_v1beta3_processor_object = nil, fields: nil, quota_user: nil, options: nil, &block)
334
+ command = make_simple_command(:post, 'v1beta3/{+parent}/processors', options)
335
+ command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor::Representation
336
+ command.request_object = google_cloud_documentai_v1beta3_processor_object
337
+ command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor::Representation
338
+ command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor
339
+ command.params['parent'] = parent unless parent.nil?
340
+ command.query['fields'] = fields unless fields.nil?
341
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
342
+ execute_or_queue_command(command, &block)
343
+ end
344
+
345
+ # Deletes the processor, unloads all deployed model artifacts if it was enabled
346
+ # and then deletes all artifacts associated with this processor.
347
+ # @param [String] name
348
+ # Required. The processor resource name to be deleted.
349
+ # @param [String] fields
350
+ # Selector specifying which fields to include in a partial response.
351
+ # @param [String] quota_user
352
+ # Available to use for quota purposes for server-side applications. Can be any
353
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
354
+ # @param [Google::Apis::RequestOptions] options
355
+ # Request-specific options
356
+ #
357
+ # @yield [result, err] Result & error if block supplied
358
+ # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] parsed result object
359
+ # @yieldparam err [StandardError] error object if request failed
360
+ #
361
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation]
362
+ #
363
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
364
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
365
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
366
+ def delete_project_location_processor(name, fields: nil, quota_user: nil, options: nil, &block)
367
+ command = make_simple_command(:delete, 'v1beta3/{+name}', options)
368
+ command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation::Representation
369
+ command.response_class = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation
370
+ command.params['name'] = name unless name.nil?
371
+ command.query['fields'] = fields unless fields.nil?
372
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
373
+ execute_or_queue_command(command, &block)
374
+ end
375
+
376
+ # Disables a processor
377
+ # @param [String] name
378
+ # Required. The processor resource name to be disabled.
379
+ # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DisableProcessorRequest] google_cloud_documentai_v1beta3_disable_processor_request_object
380
+ # @param [String] fields
381
+ # Selector specifying which fields to include in a partial response.
382
+ # @param [String] quota_user
383
+ # Available to use for quota purposes for server-side applications. Can be any
384
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
385
+ # @param [Google::Apis::RequestOptions] options
386
+ # Request-specific options
387
+ #
388
+ # @yield [result, err] Result & error if block supplied
389
+ # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] parsed result object
390
+ # @yieldparam err [StandardError] error object if request failed
391
+ #
392
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation]
393
+ #
394
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
395
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
396
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
397
+ def disable_project_location_processor(name, google_cloud_documentai_v1beta3_disable_processor_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
398
+ command = make_simple_command(:post, 'v1beta3/{+name}:disable', options)
399
+ command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DisableProcessorRequest::Representation
400
+ command.request_object = google_cloud_documentai_v1beta3_disable_processor_request_object
401
+ command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation::Representation
402
+ command.response_class = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation
403
+ command.params['name'] = name unless name.nil?
404
+ command.query['fields'] = fields unless fields.nil?
405
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
406
+ execute_or_queue_command(command, &block)
407
+ end
408
+
409
+ # Enables a processor
410
+ # @param [String] name
411
+ # Required. The processor resource name to be enabled.
412
+ # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EnableProcessorRequest] google_cloud_documentai_v1beta3_enable_processor_request_object
413
+ # @param [String] fields
414
+ # Selector specifying which fields to include in a partial response.
415
+ # @param [String] quota_user
416
+ # Available to use for quota purposes for server-side applications. Can be any
417
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
418
+ # @param [Google::Apis::RequestOptions] options
419
+ # Request-specific options
420
+ #
421
+ # @yield [result, err] Result & error if block supplied
422
+ # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] parsed result object
423
+ # @yieldparam err [StandardError] error object if request failed
424
+ #
425
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation]
426
+ #
427
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
428
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
429
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
430
+ def enable_project_location_processor(name, google_cloud_documentai_v1beta3_enable_processor_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
431
+ command = make_simple_command(:post, 'v1beta3/{+name}:enable', options)
432
+ command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3EnableProcessorRequest::Representation
433
+ command.request_object = google_cloud_documentai_v1beta3_enable_processor_request_object
434
+ command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation::Representation
435
+ command.response_class = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation
436
+ command.params['name'] = name unless name.nil?
437
+ command.query['fields'] = fields unless fields.nil?
438
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
439
+ execute_or_queue_command(command, &block)
440
+ end
441
+
442
+ # Lists all processors which belong to this project.
443
+ # @param [String] parent
444
+ # Required. The parent (project and location) which owns this collection of
445
+ # Processors. Format: projects/`project`/locations/`location`
446
+ # @param [Fixnum] page_size
447
+ # The maximum number of processors to return. If unspecified, at most 50
448
+ # processors will be returned. The maximum value is 100; values above 100 will
449
+ # be coerced to 100.
450
+ # @param [String] page_token
451
+ # We will return the processors sorted by creation time. The page token will
452
+ # point to the next processor.
453
+ # @param [String] fields
454
+ # Selector specifying which fields to include in a partial response.
455
+ # @param [String] quota_user
456
+ # Available to use for quota purposes for server-side applications. Can be any
457
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
458
+ # @param [Google::Apis::RequestOptions] options
459
+ # Request-specific options
460
+ #
461
+ # @yield [result, err] Result & error if block supplied
462
+ # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListProcessorsResponse] parsed result object
463
+ # @yieldparam err [StandardError] error object if request failed
464
+ #
465
+ # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListProcessorsResponse]
466
+ #
467
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
468
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
469
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
470
+ def list_project_location_processors(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
471
+ command = make_simple_command(:get, 'v1beta3/{+parent}/processors', options)
472
+ command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListProcessorsResponse::Representation
473
+ command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListProcessorsResponse
474
+ command.params['parent'] = parent unless parent.nil?
475
+ command.query['pageSize'] = page_size unless page_size.nil?
476
+ command.query['pageToken'] = page_token unless page_token.nil?
477
+ command.query['fields'] = fields unless fields.nil?
478
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
479
+ execute_or_queue_command(command, &block)
480
+ end
481
+
195
482
  # Processes a single document.
196
483
  # @param [String] name
197
484
  # Required. The resource name of the Processor or ProcessorVersion to use for