Summary of entries of Classes for contentwarehouse.
Classes DocumentLinkServiceAsyncClientThis service lets you manage document-links. Document-Links are treated as sub-resources under source documents.
DocumentLinkServiceClientThis service lets you manage document-links. Document-Links are treated as sub-resources under source documents.
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.
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.
DocumentSchemaServiceAsyncClientThis service lets you manage document schema.
DocumentSchemaServiceClientThis service lets you manage document schema.
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.
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.
DocumentServiceAsyncClientThis service lets you manage document.
DocumentServiceClientThis service lets you manage document.
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.
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.
PipelineServiceAsyncClientThis service lets you manage pipelines.
PipelineServiceClientThis service lets you manage pipelines.
RuleSetServiceAsyncClientService to manage customer specific RuleSets.
RuleSetServiceClientService to manage customer specific RuleSets.
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.
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.
SynonymSetServiceAsyncClientA Service that manage/custom customer specified SynonymSets.
SynonymSetServiceClientA Service that manage/custom customer specified SynonymSets.
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.
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.
AccessControlActionRepresents the action responsible for access control list management operations.
OperationTypeType of ACL modification operation.
AccessControlModeAccess Control Mode.
ActionRepresents 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
ActionExecutorOutputRepresents the output of the Action Executor.
ActionOutputRepresents the result of executing an action.
StateRepresents execution state of the action.
AddToFolderActionRepresents the action responsible for adding document under a folder.
CloudAIDocumentOptionRequest Option for processing Cloud AI Document in CW Document.
CustomizedEntitiesPropertiesConversionsEntryThe abstract base class for a message.
ContentCategoryWhen a raw document or structured content is supplied, this stores the content category.
CreateDocumentLinkRequestRequest message for DocumentLinkService.CreateDocumentLink.
CreateDocumentMetadataMetadata object for CreateDocument request (currently empty).
CreateDocumentRequestRequest message for DocumentService.CreateDocument.
CreateDocumentResponseResponse message for DocumentService.CreateDocument.
CreateDocumentSchemaRequestRequest message for DocumentSchemaService.CreateDocumentSchema.
CreateRuleSetRequestRequest message for RuleSetService.CreateRuleSet.
CreateSynonymSetRequestRequest message for SynonymSetService.CreateSynonymSet.
CustomWeightsMetadataTo support the custom weighting across document schemas.
DataUpdateActionRepresents the action responsible for properties update operations.
EntriesEntryThe abstract base class for a message.
DataValidationActionRepresents the action responsible for data validation operations.
ConditionsEntryThe abstract base class for a message.
DatabaseTypeType of database used by the customer
DateTimeArrayDateTime values.
DateTimeTypeOptionsConfigurations for a date time property.
DeleteDocumentActionRepresents the action responsible for deleting the document.
DeleteDocumentLinkRequestRequest message for DocumentLinkService.DeleteDocumentLink.
DeleteDocumentRequestRequest message for DocumentService.DeleteDocument.
DeleteDocumentSchemaRequestRequest message for DocumentSchemaService.DeleteDocumentSchema.
DeleteRuleSetRequestRequest message for RuleSetService.DeleteRuleSet.
DeleteSynonymSetRequestRequest message for SynonymSetService.DeleteSynonymSet.
DocumentDefines 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
DocumentCreatorDefaultRoleThe default role of the document creator.
DocumentLinkA document-link between source and target document.
StateThe state of a document-link.
DocumentQuery DocumentReferenceReferences to the documents.
DocumentSchemaA document schema used to define document structure.
EnumArrayEnum values.
EnumTypeOptionsConfigurations for an enum/categorical property.
EnumValueRepresents the string value of the enum field.
ExportToCdwPipelineThe configuration of exporting documents from the Document Warehouse to CDW pipeline.
FetchAclRequestRequest message for DocumentService.FetchAcl
FetchAclResponseResponse message for DocumentService.FetchAcl.
FileTypeFilterFilter for the specific types of documents returned.
FileTypeRepresentation of the types of files.
FloatArrayFloat values.
FloatTypeOptionsConfigurations for a float property.
GcsIngestPipelineThe configuration of the Cloud Storage Ingestion pipeline.
GcsIngestWithDocAiProcessorsPipelineThe configuration of the Cloud Storage Ingestion with DocAI Processors pipeline.
GetDocumentRequestRequest message for DocumentService.GetDocument.
GetDocumentSchemaRequestRequest message for DocumentSchemaService.GetDocumentSchema.
GetRuleSetRequestRequest message for RuleSetService.GetRuleSet.
GetSynonymSetRequestRequest message for SynonymSetService.GetSynonymSet. Will return synonymSet for a certain context.
HistogramQueryThe histogram request.
HistogramQueryPropertyNameFilter HistogramYAxisThe 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
HistogramQueryResultHistogram result that matches HistogramQuery specified in searches.
HistogramEntryThe abstract base class for a message.
IngestPipelineConfigThe ingestion pipeline config.
IntegerArrayInteger values.
IntegerTypeOptionsConfigurations for an integer property.
InvalidRuleA triggered rule that failed the validation check(s) after parsing.
ListDocumentSchemasRequestRequest message for DocumentSchemaService.ListDocumentSchemas.
ListDocumentSchemasResponseResponse message for DocumentSchemaService.ListDocumentSchemas.
ListLinkedSourcesRequestResponse message for DocumentLinkService.ListLinkedSources.
ListLinkedSourcesResponseResponse message for DocumentLinkService.ListLinkedSources.
ListLinkedTargetsRequestRequest message for DocumentLinkService.ListLinkedTargets.
ListLinkedTargetsResponseResponse message for DocumentLinkService.ListLinkedTargets.
ListRuleSetsRequestRequest message for RuleSetService.ListRuleSets.
ListRuleSetsResponseResponse message for RuleSetService.ListRuleSets.
ListSynonymSetsRequestRequest message for SynonymSetService.ListSynonymSets. Will return all synonymSets belonging to the customer project.
ListSynonymSetsResponseResponse message for SynonymSetService.ListSynonymSets.
LockDocumentRequestRequest message for DocumentService.LockDocument.
MapPropertyMap property value. Represents a structured entries of key value pairs, consisting of field names which map to dynamically typed values.
FieldsEntryThe abstract base class for a message.
MapTypeOptionsConfigurations for a Map property.
MergeFieldsOptionsOptions for merging updated fields.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ProcessWithDocAiPipelineThe configuration of processing documents in Document Warehouse with DocAi processors pipeline.
ProcessorInfoThe DocAI processor information.
PropertyProperty 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
PropertyArrayProperty values.
PropertyDefinitionDefines 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
RetrievalImportanceStores the retrieval importance.
SchemaSourceThe schema source information.
PropertyFilter PropertyTypeOptionsConfigurations for a nested structured data property.
PublishActionRepresents the action responsible for publishing messages to a Pub/Sub topic.
QAResultAdditional result info for the question-answering feature.
HighlightA text span in the search text snippet that represents a highlighted section (answer context, highly relevant sentence, etc.).
RawDocumentFileTypeWhen a raw document is supplied, this indicates the file format
RemoveFromFolderActionRepresents the action responsible for remove a document from a specific folder.
RequestMetadataMeta information is used to improve the performance of the service.
ResponseMetadataAdditional information returned to client, such as debugging information.
RuleRepresents the rule for a content warehouse trigger.
TriggerTypeThe trigger types for actions.
RuleActionsPairRepresents a rule and outputs of associated actions.
RuleEngineOutputRecords the output of Rule Engine including rule evaluation and actions result.
RuleEvaluatorOutputRepresents the output of the Rule Evaluator.
RuleSetRepresents a set of rules from a single customer.
RunPipelineMetadataMetadata 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
ExportToCdwPipelineMetadataThe metadata message for Export-to-CDW pipeline.
GcsIngestPipelineMetadataThe metadata message for GcsIngest pipeline.
IndividualDocumentStatusThe status of processing a document.
ProcessWithDocAiPipelineMetadataThe metadata message for Process-with-DocAi pipeline.
RunPipelineRequestRequest 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
RunPipelineResponseResponse message of RunPipeline method.
SearchDocumentsRequestRequest message for DocumentService.SearchDocuments.
TotalResultSizeThe total number of matching documents.
SearchDocumentsResponseResponse message for DocumentService.SearchDocuments.
MatchingDocumentDocument entry with metadata inside SearchDocumentsResponse
SetAclRequestRequest message for DocumentService.SetAcl.
SetAclResponseResponse message for DocumentService.SetAcl.
SynonymSetRepresents 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
SynonymRepresents a list of words given by the customer All these words are synonyms of each other.
TextArrayString/text values.
TextTypeOptionsConfigurations for a text property.
TimeFilterFilter on create timestamp or update timestamp of documents.
TimeFieldTime field used in TimeFilter.
TimestampArrayTimestamp values.
TimestampTypeOptionsConfigurations for a timestamp property.
TimestampValueTimestamp 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
UpdateDocumentMetadataMetadata object for UpdateDocument request (currently empty).
UpdateDocumentRequestRequest message for DocumentService.UpdateDocument.
UpdateDocumentResponseResponse message for DocumentService.UpdateDocument.
UpdateDocumentSchemaRequestRequest message for DocumentSchemaService.UpdateDocumentSchema.
UpdateOptionsOptions for Update operations.
UpdateRuleSetRequestRequest message for RuleSetService.UpdateRuleSet.
UpdateSynonymSetRequestRequest message for SynonymSetService.UpdateSynonymSet. Removes the SynonymSet for the specified context and replaces it with the SynonymSet in this request.
UpdateTypeUpdate type of the requests.
UserInfoThe user information.
ValueValue
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
WeightedSchemaPropertySpecifies the schema property name.
ModulesAPI documentation for contentwarehouse_v1.services.document_link_service.pagers
module.
API documentation for contentwarehouse_v1.services.document_schema_service.pagers
module.
API documentation for contentwarehouse_v1.services.document_service.pagers
module.
API documentation for contentwarehouse_v1.services.rule_set_service.pagers
module.
API documentation for contentwarehouse_v1.services.synonym_set_service.pagers
module.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4