-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
contentwarehouse_v1.projects.locations.documentSchemas.html
469 lines (426 loc) 路 29.5 KB
/
contentwarehouse_v1.projects.locations.documentSchemas.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="contentwarehouse_v1.html">Document AI Warehouse API</a> . <a href="contentwarehouse_v1.projects.html">projects</a> . <a href="contentwarehouse_v1.projects.locations.html">locations</a> . <a href="contentwarehouse_v1.projects.locations.documentSchemas.html">documentSchemas</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a document schema.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a document schema. Returns NOT_FOUND if the document schema does not exist. Returns BAD_REQUEST if the document schema has documents depending on it.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a document schema. Returns NOT_FOUND if the document schema does not exist.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists document schemas.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the Document Schema is non-empty and does not equal the existing name. Supports only appending new properties, adding new ENUM possible values, and updating the EnumTypeOptions.validation_check_disabled flag for ENUM possible values. Updating existing properties will result into INVALID_ARGUMENT.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a document schema.
Args:
parent: string, Required. The parent name. (required)
body: object, The request body.
The object takes the form of:
{ # A document schema used to define document structure.
"createTime": "A String", # Output only. The time when the document schema is created.
"description": "A String", # Schema description.
"displayName": "A String", # Required. Name of the schema given by the user. Must be unique per project.
"documentIsFolder": True or False, # Document Type, true refers the document is a folder, otherwise it is a typical document.
"name": "A String", # The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. The name is ignored when creating a document schema.
"propertyDefinitions": [ # Document details.
{ # Defines the metadata for a schema property.
"dateTimeTypeOptions": { # Configurations for a date time property. # Date time property. It is not supported by CMEK compliant deployment.
},
"displayName": "A String", # The display-name for the property, used for front-end.
"enumTypeOptions": { # Configurations for an enum/categorical property. # Enum/categorical property.
"possibleValues": [ # Required. List of possible enum values.
"A String",
],
"validationCheckDisabled": True or False, # Make sure the Enum property value provided in the document is in the possile value list during document creation. The validation check runs by default.
},
"floatTypeOptions": { # Configurations for a float property. # Float property.
},
"integerTypeOptions": { # Configurations for an integer property. # Integer property.
},
"isFilterable": True or False, # Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
"isMetadata": True or False, # Whether the property is user supplied metadata. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.
"isRepeatable": True or False, # Whether the property can have multiple values.
"isRequired": True or False, # Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.
"isSearchable": True or False, # Indicates that the property should be included in a global search.
"mapTypeOptions": { # Configurations for a Map property. # Map property.
},
"name": "A String", # Required. The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .
"propertyTypeOptions": { # Configurations for a nested structured data property. # Nested structured data property.
"propertyDefinitions": [ # Required. List of property definitions.
# Object with schema name: GoogleCloudContentwarehouseV1PropertyDefinition
],
},
"textTypeOptions": { # Configurations for a text property. # Text/string property.
},
"timestampTypeOptions": { # Configurations for a timestamp property. # Timestamp property. It is not supported by CMEK compliant deployment.
},
},
],
"updateTime": "A String", # Output only. The time when the document schema is last updated.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A document schema used to define document structure.
"createTime": "A String", # Output only. The time when the document schema is created.
"description": "A String", # Schema description.
"displayName": "A String", # Required. Name of the schema given by the user. Must be unique per project.
"documentIsFolder": True or False, # Document Type, true refers the document is a folder, otherwise it is a typical document.
"name": "A String", # The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. The name is ignored when creating a document schema.
"propertyDefinitions": [ # Document details.
{ # Defines the metadata for a schema property.
"dateTimeTypeOptions": { # Configurations for a date time property. # Date time property. It is not supported by CMEK compliant deployment.
},
"displayName": "A String", # The display-name for the property, used for front-end.
"enumTypeOptions": { # Configurations for an enum/categorical property. # Enum/categorical property.
"possibleValues": [ # Required. List of possible enum values.
"A String",
],
"validationCheckDisabled": True or False, # Make sure the Enum property value provided in the document is in the possile value list during document creation. The validation check runs by default.
},
"floatTypeOptions": { # Configurations for a float property. # Float property.
},
"integerTypeOptions": { # Configurations for an integer property. # Integer property.
},
"isFilterable": True or False, # Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
"isMetadata": True or False, # Whether the property is user supplied metadata. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.
"isRepeatable": True or False, # Whether the property can have multiple values.
"isRequired": True or False, # Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.
"isSearchable": True or False, # Indicates that the property should be included in a global search.
"mapTypeOptions": { # Configurations for a Map property. # Map property.
},
"name": "A String", # Required. The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .
"propertyTypeOptions": { # Configurations for a nested structured data property. # Nested structured data property.
"propertyDefinitions": [ # Required. List of property definitions.
# Object with schema name: GoogleCloudContentwarehouseV1PropertyDefinition
],
},
"textTypeOptions": { # Configurations for a text property. # Text/string property.
},
"timestampTypeOptions": { # Configurations for a timestamp property. # Timestamp property. It is not supported by CMEK compliant deployment.
},
},
],
"updateTime": "A String", # Output only. The time when the document schema is last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a document schema. Returns NOT_FOUND if the document schema does not exist. Returns BAD_REQUEST if the document schema has documents depending on it.
Args:
name: string, Required. The name of the document schema to delete. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a document schema. Returns NOT_FOUND if the document schema does not exist.
Args:
name: string, Required. The name of the document schema to retrieve. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A document schema used to define document structure.
"createTime": "A String", # Output only. The time when the document schema is created.
"description": "A String", # Schema description.
"displayName": "A String", # Required. Name of the schema given by the user. Must be unique per project.
"documentIsFolder": True or False, # Document Type, true refers the document is a folder, otherwise it is a typical document.
"name": "A String", # The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. The name is ignored when creating a document schema.
"propertyDefinitions": [ # Document details.
{ # Defines the metadata for a schema property.
"dateTimeTypeOptions": { # Configurations for a date time property. # Date time property. It is not supported by CMEK compliant deployment.
},
"displayName": "A String", # The display-name for the property, used for front-end.
"enumTypeOptions": { # Configurations for an enum/categorical property. # Enum/categorical property.
"possibleValues": [ # Required. List of possible enum values.
"A String",
],
"validationCheckDisabled": True or False, # Make sure the Enum property value provided in the document is in the possile value list during document creation. The validation check runs by default.
},
"floatTypeOptions": { # Configurations for a float property. # Float property.
},
"integerTypeOptions": { # Configurations for an integer property. # Integer property.
},
"isFilterable": True or False, # Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
"isMetadata": True or False, # Whether the property is user supplied metadata. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.
"isRepeatable": True or False, # Whether the property can have multiple values.
"isRequired": True or False, # Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.
"isSearchable": True or False, # Indicates that the property should be included in a global search.
"mapTypeOptions": { # Configurations for a Map property. # Map property.
},
"name": "A String", # Required. The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .
"propertyTypeOptions": { # Configurations for a nested structured data property. # Nested structured data property.
"propertyDefinitions": [ # Required. List of property definitions.
# Object with schema name: GoogleCloudContentwarehouseV1PropertyDefinition
],
},
"textTypeOptions": { # Configurations for a text property. # Text/string property.
},
"timestampTypeOptions": { # Configurations for a timestamp property. # Timestamp property. It is not supported by CMEK compliant deployment.
},
},
],
"updateTime": "A String", # Output only. The time when the document schema is last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists document schemas.
Args:
parent: string, Required. The parent, which owns this collection of document schemas. Format: projects/{project_number}/locations/{location}. (required)
pageSize: integer, The maximum number of document schemas to return. The service may return fewer than this value. If unspecified, at most 50 document schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, A page token, received from a previous `ListDocumentSchemas` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDocumentSchemas` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for DocumentSchemaService.ListDocumentSchemas.
"documentSchemas": [ # The document schemas from the specified parent.
{ # A document schema used to define document structure.
"createTime": "A String", # Output only. The time when the document schema is created.
"description": "A String", # Schema description.
"displayName": "A String", # Required. Name of the schema given by the user. Must be unique per project.
"documentIsFolder": True or False, # Document Type, true refers the document is a folder, otherwise it is a typical document.
"name": "A String", # The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. The name is ignored when creating a document schema.
"propertyDefinitions": [ # Document details.
{ # Defines the metadata for a schema property.
"dateTimeTypeOptions": { # Configurations for a date time property. # Date time property. It is not supported by CMEK compliant deployment.
},
"displayName": "A String", # The display-name for the property, used for front-end.
"enumTypeOptions": { # Configurations for an enum/categorical property. # Enum/categorical property.
"possibleValues": [ # Required. List of possible enum values.
"A String",
],
"validationCheckDisabled": True or False, # Make sure the Enum property value provided in the document is in the possile value list during document creation. The validation check runs by default.
},
"floatTypeOptions": { # Configurations for a float property. # Float property.
},
"integerTypeOptions": { # Configurations for an integer property. # Integer property.
},
"isFilterable": True or False, # Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
"isMetadata": True or False, # Whether the property is user supplied metadata. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.
"isRepeatable": True or False, # Whether the property can have multiple values.
"isRequired": True or False, # Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.
"isSearchable": True or False, # Indicates that the property should be included in a global search.
"mapTypeOptions": { # Configurations for a Map property. # Map property.
},
"name": "A String", # Required. The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .
"propertyTypeOptions": { # Configurations for a nested structured data property. # Nested structured data property.
"propertyDefinitions": [ # Required. List of property definitions.
# Object with schema name: GoogleCloudContentwarehouseV1PropertyDefinition
],
},
"textTypeOptions": { # Configurations for a text property. # Text/string property.
},
"timestampTypeOptions": { # Configurations for a timestamp property. # Timestamp property. It is not supported by CMEK compliant deployment.
},
},
],
"updateTime": "A String", # Output only. The time when the document schema is last updated.
},
],
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
<pre>Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the Document Schema is non-empty and does not equal the existing name. Supports only appending new properties, adding new ENUM possible values, and updating the EnumTypeOptions.validation_check_disabled flag for ENUM possible values. Updating existing properties will result into INVALID_ARGUMENT.
Args:
name: string, Required. The name of the document schema to update. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for DocumentSchemaService.UpdateDocumentSchema.
"documentSchema": { # A document schema used to define document structure. # Required. The document schema to update with.
"createTime": "A String", # Output only. The time when the document schema is created.
"description": "A String", # Schema description.
"displayName": "A String", # Required. Name of the schema given by the user. Must be unique per project.
"documentIsFolder": True or False, # Document Type, true refers the document is a folder, otherwise it is a typical document.
"name": "A String", # The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. The name is ignored when creating a document schema.
"propertyDefinitions": [ # Document details.
{ # Defines the metadata for a schema property.
"dateTimeTypeOptions": { # Configurations for a date time property. # Date time property. It is not supported by CMEK compliant deployment.
},
"displayName": "A String", # The display-name for the property, used for front-end.
"enumTypeOptions": { # Configurations for an enum/categorical property. # Enum/categorical property.
"possibleValues": [ # Required. List of possible enum values.
"A String",
],
"validationCheckDisabled": True or False, # Make sure the Enum property value provided in the document is in the possile value list during document creation. The validation check runs by default.
},
"floatTypeOptions": { # Configurations for a float property. # Float property.
},
"integerTypeOptions": { # Configurations for an integer property. # Integer property.
},
"isFilterable": True or False, # Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
"isMetadata": True or False, # Whether the property is user supplied metadata. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.
"isRepeatable": True or False, # Whether the property can have multiple values.
"isRequired": True or False, # Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.
"isSearchable": True or False, # Indicates that the property should be included in a global search.
"mapTypeOptions": { # Configurations for a Map property. # Map property.
},
"name": "A String", # Required. The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .
"propertyTypeOptions": { # Configurations for a nested structured data property. # Nested structured data property.
"propertyDefinitions": [ # Required. List of property definitions.
# Object with schema name: GoogleCloudContentwarehouseV1PropertyDefinition
],
},
"textTypeOptions": { # Configurations for a text property. # Text/string property.
},
"timestampTypeOptions": { # Configurations for a timestamp property. # Timestamp property. It is not supported by CMEK compliant deployment.
},
},
],
"updateTime": "A String", # Output only. The time when the document schema is last updated.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A document schema used to define document structure.
"createTime": "A String", # Output only. The time when the document schema is created.
"description": "A String", # Schema description.
"displayName": "A String", # Required. Name of the schema given by the user. Must be unique per project.
"documentIsFolder": True or False, # Document Type, true refers the document is a folder, otherwise it is a typical document.
"name": "A String", # The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. The name is ignored when creating a document schema.
"propertyDefinitions": [ # Document details.
{ # Defines the metadata for a schema property.
"dateTimeTypeOptions": { # Configurations for a date time property. # Date time property. It is not supported by CMEK compliant deployment.
},
"displayName": "A String", # The display-name for the property, used for front-end.
"enumTypeOptions": { # Configurations for an enum/categorical property. # Enum/categorical property.
"possibleValues": [ # Required. List of possible enum values.
"A String",
],
"validationCheckDisabled": True or False, # Make sure the Enum property value provided in the document is in the possile value list during document creation. The validation check runs by default.
},
"floatTypeOptions": { # Configurations for a float property. # Float property.
},
"integerTypeOptions": { # Configurations for an integer property. # Integer property.
},
"isFilterable": True or False, # Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
"isMetadata": True or False, # Whether the property is user supplied metadata. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.
"isRepeatable": True or False, # Whether the property can have multiple values.
"isRequired": True or False, # Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.
"isSearchable": True or False, # Indicates that the property should be included in a global search.
"mapTypeOptions": { # Configurations for a Map property. # Map property.
},
"name": "A String", # Required. The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .
"propertyTypeOptions": { # Configurations for a nested structured data property. # Nested structured data property.
"propertyDefinitions": [ # Required. List of property definitions.
# Object with schema name: GoogleCloudContentwarehouseV1PropertyDefinition
],
},
"textTypeOptions": { # Configurations for a text property. # Text/string property.
},
"timestampTypeOptions": { # Configurations for a timestamp property. # Timestamp property. It is not supported by CMEK compliant deployment.
},
},
],
"updateTime": "A String", # Output only. The time when the document schema is last updated.
}</pre>
</div>
</body></html>