Document AI Warehouse API . projects . locations . documentSchemas

close()

Close httplib2 connections.

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

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
        ],
      },
      "retrievalImportance": "A String", # The retrieval importance of the property during search.
      "schemaSources": [ # The mapping information between this property to another schema source.
        { # The schema source information.
          "name": "A String", # The schema name in the source.
          "processorType": "A String", # The Doc AI processor type name.
        },
      ],
      "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
        ],
      },
      "retrievalImportance": "A String", # The retrieval importance of the property during search.
      "schemaSources": [ # The mapping information between this property to another schema source.
        { # The schema source information.
          "name": "A String", # The schema name in the source.
          "processorType": "A String", # The Doc AI processor type name.
        },
      ],
      "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.
}

delete(name, x__xgafv=None)

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); }
}

get(name, x__xgafv=None)

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
        ],
      },
      "retrievalImportance": "A String", # The retrieval importance of the property during search.
      "schemaSources": [ # The mapping information between this property to another schema source.
        { # The schema source information.
          "name": "A String", # The schema name in the source.
          "processorType": "A String", # The Doc AI processor type name.
        },
      ],
      "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.
}

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

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
            ],
          },
          "retrievalImportance": "A String", # The retrieval importance of the property during search.
          "schemaSources": [ # The mapping information between this property to another schema source.
            { # The schema source information.
              "name": "A String", # The schema name in the source.
              "processorType": "A String", # The Doc AI processor type name.
            },
          ],
          "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.
}

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, x__xgafv=None)

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
          ],
        },
        "retrievalImportance": "A String", # The retrieval importance of the property during search.
        "schemaSources": [ # The mapping information between this property to another schema source.
          { # The schema source information.
            "name": "A String", # The schema name in the source.
            "processorType": "A String", # The Doc AI processor type name.
          },
        ],
        "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
        ],
      },
      "retrievalImportance": "A String", # The retrieval importance of the property during search.
      "schemaSources": [ # The mapping information between this property to another schema source.
        { # The schema source information.
          "name": "A String", # The schema name in the source.
          "processorType": "A String", # The Doc AI processor type name.
        },
      ],
      "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.
}