Package types (0.7.6)

API documentation for contentwarehouse_v1.types package.

Classes

AccessControlAction

Represents the action responsible for access control list management operations.

AccessControlMode

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.

Action

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

ActionExecutorOutput

Represents the output of the Action Executor.

ActionOutput

Represents the result of executing an action.

AddToFolderAction

Represents the action responsible for adding document under a folder.

CloudAIDocumentOption

Request Option for processing Cloud AI Document in CW Document.

ContentCategory

When a raw document or structured content is supplied, this stores the content category.

Values: CONTENT_CATEGORY_UNSPECIFIED (0): No category is specified. CONTENT_CATEGORY_IMAGE (1): Content is of image type. CONTENT_CATEGORY_AUDIO (2): Content is of audio type. CONTENT_CATEGORY_VIDEO (3): Content is of video type.

CreateDocumentLinkRequest

Request message for DocumentLinkService.CreateDocumentLink.

CreateDocumentMetadata

Metadata object for CreateDocument request (currently empty).

CreateDocumentRequest

Request message for DocumentService.CreateDocument.

CreateDocumentResponse

Response message for DocumentService.CreateDocument.

CreateDocumentSchemaRequest

Request message for DocumentSchemaService.CreateDocumentSchema.

CreateRuleSetRequest

Request message for RuleSetService.CreateRuleSet.

CreateSynonymSetRequest

Request message for SynonymSetService.CreateSynonymSet.

CustomWeightsMetadata

To support the custom weighting across document schemas.

DataUpdateAction

Represents the action responsible for properties update operations.

DataValidationAction

Represents the action responsible for data validation operations.

DatabaseType

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

DateTimeArray

DateTime values.

DateTimeTypeOptions

Configurations for a date time property.

DeleteDocumentAction

Represents the action responsible for deleting the document.

DeleteDocumentLinkRequest

Request message for DocumentLinkService.DeleteDocumentLink.

DeleteDocumentRequest

Request message for DocumentService.DeleteDocument.

DeleteDocumentSchemaRequest

Request message for DocumentSchemaService.DeleteDocumentSchema.

DeleteRuleSetRequest

Request message for RuleSetService.DeleteRuleSet.

DeleteSynonymSetRequest

Request message for SynonymSetService.DeleteSynonymSet.

Document

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

DocumentCreatorDefaultRole

The default role of the document creator.

Values: DOCUMENT_CREATOR_DEFAULT_ROLE_UNSPECIFIED (0): Unspecified, will be default to document admin role. DOCUMENT_ADMIN (1): Document Admin, same as contentwarehouse.googleapis.com/documentAdmin. DOCUMENT_EDITOR (2): Document Editor, same as contentwarehouse.googleapis.com/documentEditor. DOCUMENT_VIEWER (3): Document Viewer, same as contentwarehouse.googleapis.com/documentViewer.

A document-link between source and target document.

DocumentQuery

DocumentReference

References to the documents.

DocumentSchema

A document schema used to define document structure.

EnumArray

Enum values.

EnumTypeOptions

Configurations for an enum/categorical property.

EnumValue

Represents the string value of the enum field.

ExportToCdwPipeline

The configuration of exporting documents from the Document Warehouse to CDW pipeline.

FetchAclRequest

Request message for DocumentService.FetchAcl

FetchAclResponse

Response message for DocumentService.FetchAcl.

FileTypeFilter

Filter for the specific types of documents returned.

FloatArray

Float values.

FloatTypeOptions

Configurations for a float property.

GcsIngestPipeline

The configuration of the Cloud Storage Ingestion pipeline.

GcsIngestWithDocAiProcessorsPipeline

The configuration of the Cloud Storage Ingestion with DocAI Processors pipeline.

GetDocumentRequest

Request message for DocumentService.GetDocument.

GetDocumentSchemaRequest

Request message for DocumentSchemaService.GetDocumentSchema.

GetRuleSetRequest

Request message for RuleSetService.GetRuleSet.

GetSynonymSetRequest

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

HistogramQuery

The histogram request.

HistogramQueryPropertyNameFilter

HistogramQueryResult

Histogram result that matches HistogramQuery specified in searches.

IngestPipelineConfig

The ingestion pipeline config.

IntegerArray

Integer values.

IntegerTypeOptions

Configurations for an integer property.

InvalidRule

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

ListDocumentSchemasRequest

Request message for DocumentSchemaService.ListDocumentSchemas.

ListDocumentSchemasResponse

Response message for DocumentSchemaService.ListDocumentSchemas.

ListLinkedSourcesRequest

Response message for DocumentLinkService.ListLinkedSources.

ListLinkedSourcesResponse

Response message for DocumentLinkService.ListLinkedSources.

ListLinkedTargetsRequest

Request message for DocumentLinkService.ListLinkedTargets.

ListLinkedTargetsResponse

Response message for DocumentLinkService.ListLinkedTargets.

ListRuleSetsRequest

Request message for RuleSetService.ListRuleSets.

ListRuleSetsResponse

Response message for RuleSetService.ListRuleSets.

ListSynonymSetsRequest

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

ListSynonymSetsResponse

Response message for SynonymSetService.ListSynonymSets.

LockDocumentRequest

Request message for DocumentService.LockDocument.

MapProperty

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

MapTypeOptions

Configurations for a Map property.

MergeFieldsOptions

Options for merging updated fields.

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

ProcessWithDocAiPipeline

The configuration of processing documents in Document Warehouse with DocAi processors pipeline.

ProcessorInfo

The DocAI processor information.

Property

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

PropertyArray

Property values.

PropertyDefinition

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

PropertyFilter

PropertyTypeOptions

Configurations for a nested structured data property.

PublishAction

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

QAResult

Additional result info for the question-answering feature.

RawDocumentFileType

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 RAW_DOCUMENT_FILE_TYPE_TIFF (6): TIFF or TIF image file format

RemoveFromFolderAction

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

RequestMetadata

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

ResponseMetadata

Additional information returned to client, such as debugging information.

Rule

Represents the rule for a content warehouse trigger.

RuleActionsPair

Represents a rule and outputs of associated actions.

RuleEngineOutput

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

RuleEvaluatorOutput

Represents the output of the Rule Evaluator.

RuleSet

Represents a set of rules from a single customer.

RunPipelineMetadata

Metadata message of RunPipeline method.

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

RunPipelineRequest

Request message for DocumentService.RunPipeline.

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

RunPipelineResponse

Response message of RunPipeline method.

SearchDocumentsRequest

Request message for DocumentService.SearchDocuments.

SearchDocumentsResponse

Response message for DocumentService.SearchDocuments.

SetAclRequest

Request message for DocumentService.SetAcl.

SetAclResponse

Response message for DocumentService.SetAcl.

SynonymSet

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

TextArray

String/text values.

TextTypeOptions

Configurations for a text property.

TimeFilter

Filter on create timestamp or update timestamp of documents.

TimestampArray

Timestamp values.

TimestampTypeOptions

Configurations for a timestamp property.

TimestampValue

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

UpdateDocumentMetadata

Metadata object for UpdateDocument request (currently empty).

UpdateDocumentRequest

Request message for DocumentService.UpdateDocument.

UpdateDocumentResponse

Response message for DocumentService.UpdateDocument.

UpdateDocumentSchemaRequest

Request message for DocumentSchemaService.UpdateDocumentSchema.

UpdateOptions

Options for Update operations.

UpdateRuleSetRequest

Request message for RuleSetService.UpdateRuleSet.

UpdateSynonymSetRequest

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

UpdateType

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 (including previously linked raw document). 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. UPDATE_TYPE_MERGE_AND_REPLACE_OR_INSERT_PROPERTIES_BY_NAMES (6): For each of the property, replaces the property if the it exists, otherwise inserts a new property. And for the rest of the fields, merge them based on update mask and merge fields options.

UserInfo

The user information.

Value

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

WeightedSchemaProperty

Specifies the schema property name.