| <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="documentai_v1.html">Cloud Document AI API</a> . <a href="documentai_v1.projects.html">projects</a> . <a href="documentai_v1.projects.locations.html">locations</a> . <a href="documentai_v1.projects.locations.schemas.html">schemas</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="documentai_v1.projects.locations.schemas.schemaVersions.html">schemaVersions()</a></code> |
| </p> |
| <p class="firstline">Returns the schemaVersions Resource.</p> |
| |
| <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 schema.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a schema.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets a schema.</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 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, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates a schema. Editable fields are: - `display_name` - `labels`</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 schema. |
| |
| Args: |
| parent: string, Required. The parent (project and location) under which to create the Schema. Format: `projects/{project}/locations/{location}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # NextSchema is a collection of SchemaVersions. |
| "createTime": "A String", # Output only. The time when the Schema was created. |
| "displayName": "A String", # Optional. The user-defined name of the Schema. |
| "labels": { # Optional. The GCP labels for the Schema. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}` |
| "updateTime": "A String", # Output only. The time when the Schema was last updated. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # NextSchema is a collection of SchemaVersions. |
| "createTime": "A String", # Output only. The time when the Schema was created. |
| "displayName": "A String", # Optional. The user-defined name of the Schema. |
| "labels": { # Optional. The GCP labels for the Schema. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}` |
| "updateTime": "A String", # Output only. The time when the Schema was last updated. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code> |
| <pre>Deletes a schema. |
| |
| Args: |
| name: string, Required. The name of the Schema to be deleted. Format: `projects/{project}/locations/{location}/schemas/{schema}` (required) |
| force: boolean, Optional. If set to true, any child resources of this Schema will also be deleted. (Otherwise, the request will only work if the Schema has no child resources.) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets a schema. |
| |
| Args: |
| name: string, Required. The name of the Schema to get. Format: `projects/{project}/locations/{location}/schemas/{schema}` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # NextSchema is a collection of SchemaVersions. |
| "createTime": "A String", # Output only. The time when the Schema was created. |
| "displayName": "A String", # Optional. The user-defined name of the Schema. |
| "labels": { # Optional. The GCP labels for the Schema. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}` |
| "updateTime": "A String", # Output only. The time when the Schema was last updated. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists Schemas. |
| |
| Args: |
| parent: string, Required. Format: `projects/{project}/locations/{location}` (required) |
| pageSize: integer, Optional. The maximum number of schema groups to return. If unspecified, at most `10` Schema will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`. |
| pageToken: string, Optional. We will return the schema groups sorted by creation time. The page token will point to the next Schema. |
| 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 ListSchemas. |
| "nextPageToken": "A String", # Points to the next Schema, otherwise empty. |
| "schemas": [ # The list of Schemas. |
| { # NextSchema is a collection of SchemaVersions. |
| "createTime": "A String", # Output only. The time when the Schema was created. |
| "displayName": "A String", # Optional. The user-defined name of the Schema. |
| "labels": { # Optional. The GCP labels for the Schema. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}` |
| "updateTime": "A String", # Output only. The time when the Schema was last updated. |
| }, |
| ], |
| }</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, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates a schema. Editable fields are: - `display_name` - `labels` |
| |
| Args: |
| name: string, Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # NextSchema is a collection of SchemaVersions. |
| "createTime": "A String", # Output only. The time when the Schema was created. |
| "displayName": "A String", # Optional. The user-defined name of the Schema. |
| "labels": { # Optional. The GCP labels for the Schema. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}` |
| "updateTime": "A String", # Output only. The time when the Schema was last updated. |
| } |
| |
| updateMask: string, Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # NextSchema is a collection of SchemaVersions. |
| "createTime": "A String", # Output only. The time when the Schema was created. |
| "displayName": "A String", # Optional. The user-defined name of the Schema. |
| "labels": { # Optional. The GCP labels for the Schema. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}` |
| "updateTime": "A String", # Output only. The time when the Schema was last updated. |
| }</pre> |
| </div> |
| |
| </body></html> |
