happygapi.contentwarehouse.projects — happygapi 0.4.9

Document AI Warehouse API: projects.

See: https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects

fetchAcl$ clj

(fetchAcl$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/fetchAcl

Required parameters: resource

Optional parameters: none

Body:

{:requestMetadata {:userInfo GoogleCloudContentwarehouseV1UserInfo}, :projectOwner boolean}

Gets the access control policy for a resource. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set.

locations-documents-create$ clj

(locations-documents-create$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/documents/create

Required parameters: parent

Optional parameters: none

Body:

{:cloudAiDocumentOption {:enableEntitiesConversions boolean, :customizedEntitiesPropertiesConversions {}}, :requestMetadata {:userInfo GoogleCloudContentwarehouseV1UserInfo}, :document {:properties [GoogleCloudContentwarehouseV1Property], :creator string, :rawDocumentPath string, :textExtractionDisabled boolean, :textExtractionEnabled boolean, :dispositionTime string, :displayName string, :documentSchemaName string, :name string, :cloudAiDocument GoogleCloudDocumentaiV1Document, :createTime string, :title string, :updateTime string, :contentCategory string, :rawDocumentFileType string, :updater string, :referenceId string, :displayUri string, :plainText string, :legalHold boolean, :inlineRawDocument string}, :createMask string, :policy {:auditConfigs [GoogleIamV1AuditConfig], :etag string, :bindings [GoogleIamV1Binding], :version integer}}

Creates a document.

locations-documents-delete$ clj

(locations-documents-delete$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/documents/delete

Required parameters: name

Optional parameters: none

Body:

{:requestMetadata {:userInfo GoogleCloudContentwarehouseV1UserInfo}}

Deletes a document. Returns NOT_FOUND if the document does not exist.

locations-documents-documentLinks-create$ clj

(locations-documents-documentLinks-create$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/documents/documentLinks/create

Required parameters: parent

Optional parameters: none

Body:

{:documentLink {:createTime string, :sourceDocumentReference GoogleCloudContentwarehouseV1DocumentReference, :targetDocumentReference GoogleCloudContentwarehouseV1DocumentReference, :name string, :description string, :updateTime string, :state string}, :requestMetadata {:userInfo GoogleCloudContentwarehouseV1UserInfo}}

Create a link between a source document and a target document.

locations-documents-documentLinks-delete$ clj

(locations-documents-documentLinks-delete$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/documents/documentLinks/delete

Required parameters: name

Optional parameters: none

Body:

{:requestMetadata {:userInfo GoogleCloudContentwarehouseV1UserInfo}}

Remove the link between the source and target documents.

locations-documents-fetchAcl$ clj

(locations-documents-fetchAcl$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/documents/fetchAcl

Required parameters: resource

Optional parameters: none

Body:

{:requestMetadata {:userInfo GoogleCloudContentwarehouseV1UserInfo}, :projectOwner boolean}

Gets the access control policy for a resource. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set.

locations-documents-get$ clj

(locations-documents-get$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/documents/get

Required parameters: name

Optional parameters: none

Body:

{:requestMetadata {:userInfo GoogleCloudContentwarehouseV1UserInfo}}

Gets a document. Returns NOT_FOUND if the document does not exist.

locations-documents-linkedSources$ clj

(locations-documents-linkedSources$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/documents/linkedSources

Required parameters: parent

Optional parameters: none

Body:

{:pageToken string, :requestMetadata {:userInfo GoogleCloudContentwarehouseV1UserInfo}, :pageSize integer}

Return all source document-links from the document.

locations-documents-linkedTargets$ clj

(locations-documents-linkedTargets$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/documents/linkedTargets

Required parameters: parent

Optional parameters: none

Body:

{:requestMetadata {:userInfo GoogleCloudContentwarehouseV1UserInfo}}

Return all target document-links from the document.

locations-documents-lock$ clj

(locations-documents-lock$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/documents/lock

Required parameters: name

Optional parameters: none

Body:

{:collectionId string, :lockingUser {:id string, :groupIds [string]}}

Lock the document so the document cannot be updated by other users.

locations-documents-patch$ clj

(locations-documents-patch$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/documents/patch

Required parameters: name

Optional parameters: none

Body:

{:updateOptions {:mergeFieldsOptions GoogleCloudContentwarehouseV1MergeFieldsOptions, :updateMask string, :updateType string}, :requestMetadata {:userInfo GoogleCloudContentwarehouseV1UserInfo}, :document {:properties [GoogleCloudContentwarehouseV1Property], :creator string, :rawDocumentPath string, :textExtractionDisabled boolean, :textExtractionEnabled boolean, :dispositionTime string, :displayName string, :documentSchemaName string, :name string, :cloudAiDocument GoogleCloudDocumentaiV1Document, :createTime string, :title string, :updateTime string, :contentCategory string, :rawDocumentFileType string, :updater string, :referenceId string, :displayUri string, :plainText string, :legalHold boolean, :inlineRawDocument string}, :cloudAiDocumentOption {:enableEntitiesConversions boolean, :customizedEntitiesPropertiesConversions {}}}

Updates a document. Returns INVALID_ARGUMENT if the name of the document is non-empty and does not equal the existing name.

locations-documents-referenceId-delete$ clj

(locations-documents-referenceId-delete$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/documents/referenceId/delete

Required parameters: name

Optional parameters: none

Body:

{:requestMetadata {:userInfo GoogleCloudContentwarehouseV1UserInfo}}

Deletes a document. Returns NOT_FOUND if the document does not exist.

locations-documents-referenceId-get$ clj

(locations-documents-referenceId-get$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/documents/referenceId/get

Required parameters: name

Optional parameters: none

Body:

{:requestMetadata {:userInfo GoogleCloudContentwarehouseV1UserInfo}}

Gets a document. Returns NOT_FOUND if the document does not exist.

locations-documents-referenceId-patch$ clj

(locations-documents-referenceId-patch$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/documents/referenceId/patch

Required parameters: name

Optional parameters: none

Body:

{:updateOptions {:mergeFieldsOptions GoogleCloudContentwarehouseV1MergeFieldsOptions, :updateMask string, :updateType string}, :requestMetadata {:userInfo GoogleCloudContentwarehouseV1UserInfo}, :document {:properties [GoogleCloudContentwarehouseV1Property], :creator string, :rawDocumentPath string, :textExtractionDisabled boolean, :textExtractionEnabled boolean, :dispositionTime string, :displayName string, :documentSchemaName string, :name string, :cloudAiDocument GoogleCloudDocumentaiV1Document, :createTime string, :title string, :updateTime string, :contentCategory string, :rawDocumentFileType string, :updater string, :referenceId string, :displayUri string, :plainText string, :legalHold boolean, :inlineRawDocument string}, :cloudAiDocumentOption {:enableEntitiesConversions boolean, :customizedEntitiesPropertiesConversions {}}}

Updates a document. Returns INVALID_ARGUMENT if the name of the document is non-empty and does not equal the existing name.

locations-documents-search$ clj

(locations-documents-search$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/documents/search

Required parameters: parent

Optional parameters: none

Body:

{:totalResultSize string, :offset integer, :histogramQueries [{:requirePreciseResultSize boolean, :filters GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter, :histogramQuery string}], :documentQuery {:documentSchemaNames [string], :customWeightsMetadata GoogleCloudContentwarehouseV1CustomWeightsMetadata, :isNlQuery boolean, :folderNameFilter string, :fileTypeFilter GoogleCloudContentwarehouseV1FileTypeFilter, :documentNameFilter [string], :propertyFilter [GoogleCloudContentwarehouseV1PropertyFilter], :query string, :timeFilters [GoogleCloudContentwarehouseV1TimeFilter], :queryContext [string], :documentCreatorFilter [string], :customPropertyFilter string}, :requestMetadata {:userInfo GoogleCloudContentwarehouseV1UserInfo}, :qaSizeLimit integer, :requireTotalSize boolean, :pageToken string, :pageSize integer, :orderBy string}

Searches for documents using provided SearchDocumentsRequest. This call only returns documents that the caller has permission to search against.

locations-documents-setAcl$ clj

(locations-documents-setAcl$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/documents/setAcl

Required parameters: resource

Optional parameters: none

Body:

{:projectOwner boolean, :policy {:auditConfigs [GoogleIamV1AuditConfig], :etag string, :bindings [GoogleIamV1Binding], :version integer}, :requestMetadata {:userInfo GoogleCloudContentwarehouseV1UserInfo}}

Sets the access control policy for a resource. Replaces any existing policy.

locations-documentSchemas-create$ clj

(locations-documentSchemas-create$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/documentSchemas/create

Required parameters: parent

Optional parameters: none

Body:

{:name string, :updateTime string, :propertyDefinitions [{:propertyTypeOptions GoogleCloudContentwarehouseV1PropertyTypeOptions, :enumTypeOptions GoogleCloudContentwarehouseV1EnumTypeOptions, :displayName string, :isFilterable boolean, :name string, :isSearchable boolean, :retrievalImportance string, :schemaSources [GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource], :isMetadata boolean, :integerTypeOptions GoogleCloudContentwarehouseV1IntegerTypeOptions, :textTypeOptions GoogleCloudContentwarehouseV1TextTypeOptions, :isRequired boolean, :timestampTypeOptions GoogleCloudContentwarehouseV1TimestampTypeOptions, :floatTypeOptions GoogleCloudContentwarehouseV1FloatTypeOptions, :dateTimeTypeOptions GoogleCloudContentwarehouseV1DateTimeTypeOptions, :mapTypeOptions GoogleCloudContentwarehouseV1MapTypeOptions, :isRepeatable boolean}], :description string, :displayName string, :documentIsFolder boolean, :createTime string}

Creates a document schema.

locations-documentSchemas-delete$ clj

(locations-documentSchemas-delete$ auth parameters)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/documentSchemas/delete

Required parameters: name

Optional parameters: none

Deletes a document schema. Returns NOT_FOUND if the document schema does not exist. Returns BAD_REQUEST if the document schema has documents depending on it.

locations-documentSchemas-get$ clj

(locations-documentSchemas-get$ auth parameters)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/documentSchemas/get

Required parameters: name

Optional parameters: none

Gets a document schema. Returns NOT_FOUND if the document schema does not exist.

locations-documentSchemas-list$ clj

(locations-documentSchemas-list$ auth parameters)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/documentSchemas/list

Required parameters: parent

Optional parameters: pageSize, pageToken

Lists document schemas.

locations-documentSchemas-patch$ clj

(locations-documentSchemas-patch$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/documentSchemas/patch

Required parameters: name

Optional parameters: none

Body:

{:documentSchema {:name string, :updateTime string, :propertyDefinitions [GoogleCloudContentwarehouseV1PropertyDefinition], :description string, :displayName string, :documentIsFolder boolean, :createTime string}}

Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the Document Schema is non-empty and does not equal the existing name. Supports only appending new properties, adding new ENUM possible values, and updating the EnumTypeOptions.validation_check_disabled flag for ENUM possible values. Updating existing properties will result into INVALID_ARGUMENT.

locations-getStatus$ clj

(locations-getStatus$ auth parameters)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/getStatus

Required parameters: location

Optional parameters: none

Get the project status.

locations-initialize$ clj

(locations-initialize$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/initialize

Required parameters: location

Optional parameters: none

Body:

{:documentCreatorDefaultRole string, :kmsKey string, :accessControlMode string, :enableCalUserEmailLogging boolean, :databaseType string}

Provisions resources for given tenant project. Returns a long running operation.

locations-operations-get$ clj

(locations-operations-get$ auth parameters)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/operations/get

Required parameters: name

Optional parameters: none

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

locations-ruleSets-create$ clj

(locations-ruleSets-create$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/ruleSets/create

Required parameters: parent

Optional parameters: none

Body:

{:source string, :rules [{:description string, :actions [GoogleCloudContentwarehouseV1Action], :condition string, :triggerType string, :ruleId string}], :description string, :name string}

Creates a ruleset.

locations-ruleSets-delete$ clj

(locations-ruleSets-delete$ auth parameters)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/ruleSets/delete

Required parameters: name

Optional parameters: none

Deletes a ruleset. Returns NOT_FOUND if the document does not exist.

locations-ruleSets-get$ clj

(locations-ruleSets-get$ auth parameters)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/ruleSets/get

Required parameters: name

Optional parameters: none

Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist.

locations-ruleSets-list$ clj

(locations-ruleSets-list$ auth parameters)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/ruleSets/list

Required parameters: parent

Optional parameters: pageSize, pageToken

Lists rulesets.

locations-ruleSets-patch$ clj

(locations-ruleSets-patch$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/ruleSets/patch

Required parameters: name

Optional parameters: none

Body:

{:ruleSet {:source string, :rules [GoogleCloudContentwarehouseV1Rule], :description string, :name string}}

Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset is non-empty and does not equal the existing name.

locations-runPipeline$ clj

(locations-runPipeline$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/runPipeline

Required parameters: name

Optional parameters: none

Body:

{:processWithDocAiPipeline {:exportFolderPath string, :documents [string], :processorInfo GoogleCloudContentwarehouseV1ProcessorInfo, :processorResultsFolderPath string}, :requestMetadata {:userInfo GoogleCloudContentwarehouseV1UserInfo}, :gcsIngestPipeline {:pipelineConfig GoogleCloudContentwarehouseV1IngestPipelineConfig, :schemaName string, :skipIngestedDocuments boolean, :processorType string, :inputPath string}, :exportCdwPipeline {:docAiDataset string, :trainingSplitRatio number, :documents [string], :exportFolderPath string}, :gcsIngestWithDocAiProcessorsPipeline {:pipelineConfig GoogleCloudContentwarehouseV1IngestPipelineConfig, :inputPath string, :skipIngestedDocuments boolean, :extractProcessorInfos [GoogleCloudContentwarehouseV1ProcessorInfo], :processorResultsFolderPath string, :splitClassifyProcessorInfo GoogleCloudContentwarehouseV1ProcessorInfo}}

Run a predefined pipeline.

locations-synonymSets-create$ clj

(locations-synonymSets-create$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/synonymSets/create

Required parameters: parent

Optional parameters: none

Body:

{:context string, :name string, :synonyms [{:words [string]}]}

Creates a SynonymSet for a single context. Throws an ALREADY_EXISTS exception if a synonymset already exists for the context.

locations-synonymSets-delete$ clj

(locations-synonymSets-delete$ auth parameters)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/synonymSets/delete

Required parameters: name

Optional parameters: none

Deletes a SynonymSet for a given context. Throws a NOT_FOUND exception if the SynonymSet is not found.

locations-synonymSets-get$ clj

(locations-synonymSets-get$ auth parameters)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/synonymSets/get

Required parameters: name

Optional parameters: none

Gets a SynonymSet for a particular context. Throws a NOT_FOUND exception if the Synonymset does not exist

locations-synonymSets-list$ clj

(locations-synonymSets-list$ auth parameters)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/synonymSets/list

Required parameters: parent

Optional parameters: pageSize, pageToken

Returns all SynonymSets (for all contexts) for the specified location.

locations-synonymSets-patch$ clj

(locations-synonymSets-patch$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/locations/synonymSets/patch

Required parameters: name

Optional parameters: none

Body:

{:context string, :name string, :synonyms [{:words [string]}]}

Remove the existing SynonymSet for the context and replaces it with a new one. Throws a NOT_FOUND exception if the SynonymSet is not found.

setAcl$ clj

(setAcl$ auth parameters body)

https://cloud.google.com/document-warehouseapi/reference/rest/v1/projects/setAcl

Required parameters: resource

Optional parameters: none

Body:

{:projectOwner boolean, :policy {:auditConfigs [GoogleIamV1AuditConfig], :etag string, :bindings [GoogleIamV1Binding], :version integer}, :requestMetadata {:userInfo GoogleCloudContentwarehouseV1UserInfo}}

Sets the access control policy for a resource. Replaces any existing policy.