Package types (0.4.1)

Represents the action responsible for access control list management operations.

Access Control Mode.

Values: ACL_MODE_UNKNOWN (0): This value is required by protobuf best practices ACL_MODE_UNIVERSAL_ACCESS (1): Universal Access: No document level access control. ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID (2): Document level access control with customer own Identity Service. ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI (3): Document level access control using Google Cloud Identity.

Represents the action triggered by Rule Engine when the rule is true.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents the output of the Action Executor.

Represents the result of executing an action.

Represents the action responsible for adding document under a folder.

Request Option for processing Cloud AI Document in CW Document.

Request message for DocumentLinkService.CreateDocumentLink.

Metadata object for CreateDocument request (currently empty).

Request message for DocumentService.CreateDocument.

Response message for DocumentService.CreateDocument.

Request message for DocumentSchemaService.CreateDocumentSchema.

Request message for RuleSetService.CreateRuleSet.

Request message for SynonymSetService.CreateSynonymSet.

Represents the action responsible for properties update operations.

Represents the action responsible for data validation operations.

Type of database used by the customer

Values: DB_UNKNOWN (0): This value is required by protobuf best practices DB_INFRA_SPANNER (1): Internal Spanner DB_CLOUD_SQL_POSTGRES (2): Cloud Sql with a Postgres Sql instance

DateTime values.

Configurations for a date time property.

Represents the action responsible for deleting the document.

Request message for DocumentLinkService.DeleteDocumentLink.

Request message for DocumentService.DeleteDocument.

Request message for DocumentSchemaService.DeleteDocumentSchema.

Request message for RuleSetService.DeleteRuleSet.

Request message for SynonymSetService.DeleteSynonymSet.

Defines the structure for content warehouse document proto.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A document-link between source and target document.

References to the documents.

A document schema used to define document structure.

Enum values.

Configurations for an enum/categorical property.

Represents the string value of the enum field.

Request message for DocumentService.FetchAcl

Response message for DocumentService.FetchAcl.

Filter for the specific types of documents returned.

Float values.

Configurations for a float property.

Request message for DocumentService.GetDocument.

Request message for DocumentSchemaService.GetDocumentSchema.

Request message for RuleSetService.GetRuleSet.

Request message for SynonymSetService.GetSynonymSet. Will return synonymSet for a certain context.

The histogram request.

Histogram result that matches HistogramQuery specified in searches.

Integer values.

Configurations for an integer property.

A triggered rule that failed the validation check(s) after parsing.

Request message for DocumentSchemaService.ListDocumentSchemas.

Response message for DocumentSchemaService.ListDocumentSchemas.

Response message for DocumentLinkService.ListLinkedSources.

Response message for DocumentLinkService.ListLinkedSources.

Request message for DocumentLinkService.ListLinkedTargets.

Response message for DocumentLinkService.ListLinkedTargets.

Request message for RuleSetService.ListRuleSets.

Response message for RuleSetService.ListRuleSets.

Request message for SynonymSetService.ListSynonymSets. Will return all synonymSets belonging to the customer project.

Response message for SynonymSetService.ListSynonymSets.

Map property value. Represents a structured entries of key value pairs, consisting of field names which map to dynamically typed values.

Configurations for a Map property.

Options for merging updated fields.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Property of a document.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Property values.

Defines the metadata for a schema property.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Configurations for a nested structured data property.

Represents the action responsible for publishing messages to a Pub/Sub topic.

Additional result info for the question-answering feature.

When a raw document is supplied, this indicates the file format

Values: RAW_DOCUMENT_FILE_TYPE_UNSPECIFIED (0): No raw document specified or it is non-parsable RAW_DOCUMENT_FILE_TYPE_PDF (1): Adobe PDF format RAW_DOCUMENT_FILE_TYPE_DOCX (2): Microsoft Word format RAW_DOCUMENT_FILE_TYPE_XLSX (3): Microsoft Excel format RAW_DOCUMENT_FILE_TYPE_PPTX (4): Microsoft Powerpoint format RAW_DOCUMENT_FILE_TYPE_TEXT (5): UTF-8 encoded text format

Represents the action responsible for remove a document from a specific folder.

Meta information is used to improve the performance of the service.

Additional information returned to client, such as debugging information.

Represents the rule for a content warehouse trigger.

Represents a rule and outputs of associated actions.

Records the output of Rule Engine including rule evaluation and actions result.

Represents the output of the Rule Evaluator.

Represents a set of rules from a single customer.

Request message for DocumentService.SearchDocuments.

Response message for DocumentService.SearchDocuments.

Request message for DocumentService.SetAcl.

Response message for DocumentService.SetAcl.

Represents a list of synonyms for a given context. For example a context "sales" could contain: Synonym 1: sale, invoice, bill, order Synonym 2: money, credit, finance, payment Synonym 3: shipping, freight, transport Each SynonymSets should be disjoint

String/text values.

Configurations for a text property.

Filter on create timestamp or update timestamp of documents.

Timestamp values.

Configurations for a timestamp property.

Timestamp value type.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Metadata object for UpdateDocument request (currently empty).

Request message for DocumentService.UpdateDocument.

Response message for DocumentService.UpdateDocument.

Request message for DocumentSchemaService.UpdateDocumentSchema.

Options for Update operations.

Request message for RuleSetService.UpdateRuleSet.

Request message for SynonymSetService.UpdateSynonymSet. Removes the SynonymSet for the specified context and replaces it with the SynonymSet in this request.

Update type of the requests.

Values: UPDATE_TYPE_UNSPECIFIED (0): Defaults to full replace behavior, ie. FULL_REPLACE. UPDATE_TYPE_REPLACE (1): Fully replace all the fields. Any field masks will be ignored. UPDATE_TYPE_MERGE (2): Merge the fields into the existing entities. UPDATE_TYPE_INSERT_PROPERTIES_BY_NAMES (3): Inserts the properties by names. UPDATE_TYPE_REPLACE_PROPERTIES_BY_NAMES (4): Replace the properties by names. UPDATE_TYPE_DELETE_PROPERTIES_BY_NAMES (5): Delete the properties by names.

Value represents a dynamically typed value which can be either be a float, a integer, a string, or a datetime value. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields