@swamp/gcp/contentwarehouse
v2026.04.04.1
Google Cloud contentwarehouse infrastructure models
Labels
gcpgoogle-cloudcontentwarehousecloudinfrastructure
Contents
Install
$ swamp extension pull @swamp/gcp/contentwarehouseRelease Notes
- Updated: documentschemas, documents, documents_referenceid, rulesets
@swamp/gcp/contentwarehouse/documentsv2026.04.04.1documents.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| cloudAiDocumentOption? | object | Request Option for processing Cloud AI Document in CW Document. |
| createMask? | string | Field mask for creating Document fields. If mask path is empty, it means all fields are masked. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. |
| document? | object | Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. |
| contentCategory? | enum | Indicates the category (image, audio, video etc.) of the original content. |
| createTime? | string | Output only. The time when the document is created. |
| creator? | string | The user who creates the document. |
| displayName? | string | Required. Display name of the document given by the user. This name will be displayed in the UI. Customer can populate this field with the name of the document. This differs from the 'title' field as 'title' is optional and stores the top heading in the document. |
| displayUri? | string | Uri to display the document, for example, in the UI. |
| dispositionTime? | string | Output only. If linked to a Collection with RetentionPolicy, the date when the document becomes mutable. |
| documentSchemaName? | string | The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. |
| inlineRawDocument? | string | Raw document content. |
| legalHold? | boolean | Output only. Indicates if the document has a legal hold on it. |
| name? | string | The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document. |
| plainText? | string | Other document format, such as PPTX, XLXS |
| properties? | array | List of values that are user supplied metadata. |
| rawDocumentFileType? | enum | This is used when DocAI was not used to load the document and parsing/ extracting is needed for the inline_raw_document. For example, if inline_raw_document is the byte representation of a PDF file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF. |
| rawDocumentPath? | string | Raw document file in Cloud Storage path. |
| referenceId? | string | The reference ID set by customers. Must be unique per project and location. |
| textExtractionDisabled? | boolean | If true, text extraction will not be performed. |
| textExtractionEnabled? | boolean | If true, text extraction will be performed. |
| title? | string | Title that describes the document. This can be the top heading or text that describes the document. |
| updateTime? | string | Output only. The time when the document is last updated. |
| updater? | string | The user who lastly updates the document. |
| policy? | object | An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also |
| requestMetadata? | object | Meta information is used to improve the performance of the service. |
| updateOptions? | object | Options for Update operations. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a documents
getGet a documents
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the documents |
updateUpdate documents attributes
deleteDelete the documents
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the documents |
syncSync documents state from GCP
fetch_aclfetch acl
| Argument | Type | Description |
|---|---|---|
| projectOwner? | any | |
| requestMetadata? | any |
linked_sourceslinked sources
| Argument | Type | Description |
|---|---|---|
| pageSize? | any | |
| pageToken? | any | |
| requestMetadata? | any |
linked_targetslinked targets
| Argument | Type | Description |
|---|---|---|
| requestMetadata? | any |
locklock
| Argument | Type | Description |
|---|---|---|
| collectionId? | any | |
| lockingUser? | any |
searchsearch
| Argument | Type | Description |
|---|---|---|
| documentQuery? | any | |
| histogramQueries? | any | |
| offset? | any | |
| orderBy? | any | |
| pageSize? | any | |
| pageToken? | any | |
| qaSizeLimit? | any | |
| requestMetadata? | any | |
| requireTotalSize? | any | |
| totalResultSize? | any |
set_aclset acl
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| projectOwner? | any | |
| requestMetadata? | any |
Resources
state(infinite)— Defines the structure for content warehouse document proto.
@swamp/gcp/contentwarehouse/documents-referenceidv2026.04.04.1documents_referenceid.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| cloudAiDocumentOption? | object | Request Option for processing Cloud AI Document in CW Document. |
| document? | object | Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. |
| contentCategory? | enum | Indicates the category (image, audio, video etc.) of the original content. |
| createTime? | string | Output only. The time when the document is created. |
| creator? | string | The user who creates the document. |
| displayName? | string | Required. Display name of the document given by the user. This name will be displayed in the UI. Customer can populate this field with the name of the document. This differs from the 'title' field as 'title' is optional and stores the top heading in the document. |
| displayUri? | string | Uri to display the document, for example, in the UI. |
| dispositionTime? | string | Output only. If linked to a Collection with RetentionPolicy, the date when the document becomes mutable. |
| documentSchemaName? | string | The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. |
| inlineRawDocument? | string | Raw document content. |
| legalHold? | boolean | Output only. Indicates if the document has a legal hold on it. |
| name? | string | The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document. |
| plainText? | string | Other document format, such as PPTX, XLXS |
| properties? | array | List of values that are user supplied metadata. |
| rawDocumentFileType? | enum | This is used when DocAI was not used to load the document and parsing/ extracting is needed for the inline_raw_document. For example, if inline_raw_document is the byte representation of a PDF file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF. |
| rawDocumentPath? | string | Raw document file in Cloud Storage path. |
| referenceId? | string | The reference ID set by customers. Must be unique per project and location. |
| textExtractionDisabled? | boolean | If true, text extraction will not be performed. |
| textExtractionEnabled? | boolean | If true, text extraction will be performed. |
| title? | string | Title that describes the document. This can be the top heading or text that describes the document. |
| updateTime? | string | Output only. The time when the document is last updated. |
| updater? | string | The user who lastly updates the document. |
| requestMetadata? | object | Meta information is used to improve the performance of the service. |
| updateOptions? | object | Options for Update operations. |
getGet a referenceId
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the referenceId |
updateUpdate referenceId attributes
deleteDelete the referenceId
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the referenceId |
syncSync referenceId state from GCP
Resources
state(infinite)— Defines the structure for content warehouse document proto.
@swamp/gcp/contentwarehouse/documentschemasv2026.04.04.1documentschemas.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| description? | string | Schema description. |
| displayName? | string | Required. Name of the schema given by the user. Must be unique per project. |
| documentIsFolder? | boolean | Document Type, true refers the document is a folder, otherwise it is a typical document. |
| name? | 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? | array | Document details. |
| documentSchema? | object | A document schema used to define document structure. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a documentSchemas
getGet a documentSchemas
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the documentSchemas |
updateUpdate documentSchemas attributes
deleteDelete the documentSchemas
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the documentSchemas |
syncSync documentSchemas state from GCP
Resources
state(infinite)— A document schema used to define document structure.
@swamp/gcp/contentwarehouse/rulesetsv2026.04.04.1rulesets.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| description? | string | Short description of the rule-set. |
| name? | string | The resource name of the rule set. Managed internally. Format: projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}. The name is ignored when creating a rule set. |
| rules? | array | List of rules given by the customer. |
| source? | string | Source of the rules i.e., customer name. |
| ruleSet? | object | Represents a set of rules from a single customer. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a ruleSets
getGet a ruleSets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the ruleSets |
updateUpdate ruleSets attributes
deleteDelete the ruleSets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the ruleSets |
syncSync ruleSets state from GCP
Resources
state(infinite)— Represents a set of rules from a single customer.
@swamp/gcp/contentwarehouse/synonymsetsv2026.04.03.3synonymsets.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| context? | string | This is a freeform field. Example contexts can be "sales," "engineering," "real estate," "accounting," etc. The context can be supplied during search requests. |
| name? | string | The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}. |
| synonyms? | array | List of Synonyms for the context. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a synonymSets
getGet a synonymSets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the synonymSets |
updateUpdate synonymSets attributes
deleteDelete the synonymSets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the synonymSets |
syncSync synonymSets state from GCP
Resources
state(infinite)— Represents a list of synonyms for a given context. For example a context "sal...
2026.04.03.3196.2 KBApr 3, 2026
Google Cloud contentwarehouse infrastructure models
Release Notes
- Updated: documentschemas, documents, documents_referenceid, rulesets, synonymsets
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudcontentwarehousecloudinfrastructure
2026.04.03.1195.5 KBApr 3, 2026
Google Cloud contentwarehouse infrastructure models
Release Notes
- Updated: documentschemas, documents, documents_referenceid, rulesets, synonymsets
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudcontentwarehousecloudinfrastructure
2026.04.02.2195.5 KBApr 2, 2026
Google Cloud contentwarehouse infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudcontentwarehousecloudinfrastructure
2026.03.27.1196.1 KBMar 27, 2026
Google Cloud contentwarehouse infrastructure models
Release Notes
- Added: documentschemas, documents, documents_referenceid, rulesets, synonymsets
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudcontentwarehousecloudinfrastructure