create(parent, body=None, x__xgafv=None)

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.
}

delete(name, force=None, x__xgafv=None)

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.
},
}

get(name, x__xgafv=None)

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.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

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.
    },
  ],
}

list_next()

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.

patch(name, body=None, updateMask=None, x__xgafv=None)

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.
}

Cloud Document AI API . projects . locations . schemas

Instance Methods

Method Details