Debian Codegraph @

docs/dyn/contentwarehouse_v1.projects.locations.documentSchemas.html

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