Package Classes (0.7.12)

Summary of entries of Classes for contentwarehouse.

Classes

DocumentLinkServiceAsyncClient

This service lets you manage document-links. Document-Links are treated as sub-resources under source documents.

DocumentLinkServiceClient

This service lets you manage document-links. Document-Links are treated as sub-resources under source documents.

ListLinkedSourcesAsyncPager

A pager for iterating through list_linked_sources requests.

This class thinly wraps an initial ListLinkedSourcesResponse object, and provides an __aiter__ method to iterate through its document_links field.

If there are more pages, the __aiter__ method will make additional ListLinkedSources requests and continue to iterate through the document_links field on the corresponding responses.

All the usual ListLinkedSourcesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListLinkedSourcesPager

A pager for iterating through list_linked_sources requests.

This class thinly wraps an initial ListLinkedSourcesResponse object, and provides an __iter__ method to iterate through its document_links field.

If there are more pages, the __iter__ method will make additional ListLinkedSources requests and continue to iterate through the document_links field on the corresponding responses.

All the usual ListLinkedSourcesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

DocumentSchemaServiceAsyncClient

This service lets you manage document schema.

DocumentSchemaServiceClient

This service lets you manage document schema.

ListDocumentSchemasAsyncPager

A pager for iterating through list_document_schemas requests.

This class thinly wraps an initial ListDocumentSchemasResponse object, and provides an __aiter__ method to iterate through its document_schemas field.

If there are more pages, the __aiter__ method will make additional ListDocumentSchemas requests and continue to iterate through the document_schemas field on the corresponding responses.

All the usual ListDocumentSchemasResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDocumentSchemasPager

A pager for iterating through list_document_schemas requests.

This class thinly wraps an initial ListDocumentSchemasResponse object, and provides an __iter__ method to iterate through its document_schemas field.

If there are more pages, the __iter__ method will make additional ListDocumentSchemas requests and continue to iterate through the document_schemas field on the corresponding responses.

All the usual ListDocumentSchemasResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchDocumentsAsyncPager

A pager for iterating through search_documents requests.

This class thinly wraps an initial SearchDocumentsResponse object, and provides an __aiter__ method to iterate through its matching_documents field.

If there are more pages, the __aiter__ method will make additional SearchDocuments requests and continue to iterate through the matching_documents field on the corresponding responses.

All the usual SearchDocumentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchDocumentsPager

A pager for iterating through search_documents requests.

This class thinly wraps an initial SearchDocumentsResponse object, and provides an __iter__ method to iterate through its matching_documents field.

If there are more pages, the __iter__ method will make additional SearchDocuments requests and continue to iterate through the matching_documents field on the corresponding responses.

All the usual SearchDocumentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

RuleSetServiceAsyncClient

Service to manage customer specific RuleSets.

RuleSetServiceClient

Service to manage customer specific RuleSets.

ListRuleSetsAsyncPager

A pager for iterating through list_rule_sets requests.

This class thinly wraps an initial ListRuleSetsResponse object, and provides an __aiter__ method to iterate through its rule_sets field.

If there are more pages, the __aiter__ method will make additional ListRuleSets requests and continue to iterate through the rule_sets field on the corresponding responses.

All the usual ListRuleSetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListRuleSetsPager

A pager for iterating through list_rule_sets requests.

This class thinly wraps an initial ListRuleSetsResponse object, and provides an __iter__ method to iterate through its rule_sets field.

If there are more pages, the __iter__ method will make additional ListRuleSets requests and continue to iterate through the rule_sets field on the corresponding responses.

All the usual ListRuleSetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SynonymSetServiceAsyncClient

A Service that manage/custom customer specified SynonymSets.

SynonymSetServiceClient

A Service that manage/custom customer specified SynonymSets.

ListSynonymSetsAsyncPager

A pager for iterating through list_synonym_sets requests.

This class thinly wraps an initial ListSynonymSetsResponse object, and provides an __aiter__ method to iterate through its synonym_sets field.

If there are more pages, the __aiter__ method will make additional ListSynonymSets requests and continue to iterate through the synonym_sets field on the corresponding responses.

All the usual ListSynonymSetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListSynonymSetsPager

A pager for iterating through list_synonym_sets requests.

This class thinly wraps an initial ListSynonymSetsResponse object, and provides an __iter__ method to iterate through its synonym_sets field.

If there are more pages, the __iter__ method will make additional ListSynonymSets requests and continue to iterate through the synonym_sets field on the corresponding responses.

All the usual ListSynonymSetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AccessControlAction

Represents the action responsible for access control list management operations.

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.

State

Represents execution state of the action.

AddToFolderAction

Represents the action responsible for adding document under a folder.

CloudAIDocumentOption

Request Option for processing Cloud AI Document in CW Document.

CustomizedEntitiesPropertiesConversionsEntry

The abstract base class for a message.

ContentCategory

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

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.

EntriesEntry

The abstract base class for a message.

DataValidationAction

Represents the action responsible for data validation operations.

ConditionsEntry

The abstract base class for a message.

DatabaseType

Type of database used by the customer

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.

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

DocumentCreatorDefaultRole

The default role of the document creator.

DocumentLink

A document-link between source and target document.

State

The state of a document-link.

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.

FileType

Representation of the types of files.

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

HistogramYAxis

The result of the histogram query count('FilterableProperties') using HISTOGRAM_YAXIS_DOCUMENT will be: invoice_id: 2 address: 1 payment_method: 2 line_item_description: 1

HistogramQueryResult

Histogram result that matches HistogramQuery specified in searches.

HistogramEntry

The abstract base class for a message.

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.

FieldsEntry

The abstract base class for a message.

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.

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

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

RetrievalImportance

Stores the retrieval importance.

SchemaSource

The schema source information.

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.

Highlight

A text span in the search text snippet that represents a highlighted section (answer context, highly relevant sentence, etc.).

RawDocumentFileType

When a raw document is supplied, this indicates the 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.

TriggerType

The trigger types for actions.

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.

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

ExportToCdwPipelineMetadata

The metadata message for Export-to-CDW pipeline.

GcsIngestPipelineMetadata

The metadata message for GcsIngest pipeline.

IndividualDocumentStatus

The status of processing a document.

ProcessWithDocAiPipelineMetadata

The metadata message for Process-with-DocAi pipeline.

RunPipelineRequest

Request message for DocumentService.RunPipeline.

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

TotalResultSize

The total number of matching documents.

SearchDocumentsResponse

Response message for DocumentService.SearchDocuments.

MatchingDocument

Document entry with metadata inside SearchDocumentsResponse

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

Synonym

Represents a list of words given by the customer All these words are synonyms of each other.

TextArray

String/text values.

TextTypeOptions

Configurations for a text property.

TimeFilter

Filter on create timestamp or update timestamp of documents.

TimeField

Time field used in TimeFilter.

TimestampArray

Timestamp values.

TimestampTypeOptions

Configurations for a timestamp property.

TimestampValue

Timestamp value type.

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

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.

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

WeightedSchemaProperty

Specifies the schema property name.