* $contentwarehouseService = new Google\Service\Contentwarehouse(...); * $documents = $contentwarehouseService->projects_locations_documents; * */ class ProjectsLocationsDocuments extends \Google\Service\Resource { /** * Creates a document. (documents.create) * * @param string $parent Required. The parent name. Format: * projects/{project_number}/locations/{location}. * @param GoogleCloudContentwarehouseV1CreateDocumentRequest $postBody * @param array $optParams Optional parameters. * @return GoogleCloudContentwarehouseV1CreateDocumentResponse * @throws \Google\Service\Exception */ public function create($parent, GoogleCloudContentwarehouseV1CreateDocumentRequest $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], GoogleCloudContentwarehouseV1CreateDocumentResponse::class); } /** * Deletes a document. Returns NOT_FOUND if the document does not exist. * (documents.delete) * * @param string $name Required. The name of the document to delete. Format: * projects/{project_number}/locations/{location}/documents/{document_id} or pro * jects/{project_number}/locations/{location}/documents/referenceId/{reference_ * id}. * @param GoogleCloudContentwarehouseV1DeleteDocumentRequest $postBody * @param array $optParams Optional parameters. * @return GoogleProtobufEmpty * @throws \Google\Service\Exception */ public function delete($name, GoogleCloudContentwarehouseV1DeleteDocumentRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('delete', [$params], GoogleProtobufEmpty::class); } /** * 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. (documents.fetchAcl) * * @param string $resource Required. REQUIRED: The resource for which the policy * is being requested. Format for document: * projects/{project_number}/locations/{location}/documents/{document_id}. * Format for collection: * projects/{project_number}/locations/{location}/collections/{collection_id}. * Format for project: projects/{project_number}. * @param GoogleCloudContentwarehouseV1FetchAclRequest $postBody * @param array $optParams Optional parameters. * @return GoogleCloudContentwarehouseV1FetchAclResponse * @throws \Google\Service\Exception */ public function fetchAcl($resource, GoogleCloudContentwarehouseV1FetchAclRequest $postBody, $optParams = []) { $params = ['resource' => $resource, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('fetchAcl', [$params], GoogleCloudContentwarehouseV1FetchAclResponse::class); } /** * Gets a document. Returns NOT_FOUND if the document does not exist. * (documents.get) * * @param string $name Required. The name of the document to retrieve. Format: * projects/{project_number}/locations/{location}/documents/{document_id} or pro * jects/{project_number}/locations/{location}/documents/referenceId/{reference_ * id}. * @param GoogleCloudContentwarehouseV1GetDocumentRequest $postBody * @param array $optParams Optional parameters. * @return GoogleCloudContentwarehouseV1Document * @throws \Google\Service\Exception */ public function get($name, GoogleCloudContentwarehouseV1GetDocumentRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('get', [$params], GoogleCloudContentwarehouseV1Document::class); } /** * Return all source document-links from the document. (documents.linkedSources) * * @param string $parent Required. The name of the document, for which all * source links are returned. Format: projects/{project_number}/locations/{locat * ion}/documents/{source_document_id}. * @param GoogleCloudContentwarehouseV1ListLinkedSourcesRequest $postBody * @param array $optParams Optional parameters. * @return GoogleCloudContentwarehouseV1ListLinkedSourcesResponse * @throws \Google\Service\Exception */ public function linkedSources($parent, GoogleCloudContentwarehouseV1ListLinkedSourcesRequest $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('linkedSources', [$params], GoogleCloudContentwarehouseV1ListLinkedSourcesResponse::class); } /** * Return all target document-links from the document. (documents.linkedTargets) * * @param string $parent Required. The name of the document, for which all * target links are returned. Format: projects/{project_number}/locations/{locat * ion}/documents/{target_document_id}. * @param GoogleCloudContentwarehouseV1ListLinkedTargetsRequest $postBody * @param array $optParams Optional parameters. * @return GoogleCloudContentwarehouseV1ListLinkedTargetsResponse * @throws \Google\Service\Exception */ public function linkedTargets($parent, GoogleCloudContentwarehouseV1ListLinkedTargetsRequest $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('linkedTargets', [$params], GoogleCloudContentwarehouseV1ListLinkedTargetsResponse::class); } /** * Lock the document so the document cannot be updated by other users. * (documents.lock) * * @param string $name Required. The name of the document to lock. Format: * projects/{project_number}/locations/{location}/documents/{document}. * @param GoogleCloudContentwarehouseV1LockDocumentRequest $postBody * @param array $optParams Optional parameters. * @return GoogleCloudContentwarehouseV1Document * @throws \Google\Service\Exception */ public function lock($name, GoogleCloudContentwarehouseV1LockDocumentRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('lock', [$params], GoogleCloudContentwarehouseV1Document::class); } /** * Updates a document. Returns INVALID_ARGUMENT if the name of the document is * non-empty and does not equal the existing name. (documents.patch) * * @param string $name Required. The name of the document to update. Format: * projects/{project_number}/locations/{location}/documents/{document_id} or pro * jects/{project_number}/locations/{location}/documents/referenceId/{reference_ * id}. * @param GoogleCloudContentwarehouseV1UpdateDocumentRequest $postBody * @param array $optParams Optional parameters. * @return GoogleCloudContentwarehouseV1UpdateDocumentResponse * @throws \Google\Service\Exception */ public function patch($name, GoogleCloudContentwarehouseV1UpdateDocumentRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('patch', [$params], GoogleCloudContentwarehouseV1UpdateDocumentResponse::class); } /** * Searches for documents using provided SearchDocumentsRequest. This call only * returns documents that the caller has permission to search against. * (documents.search) * * @param string $parent Required. The parent, which owns this collection of * documents. Format: projects/{project_number}/locations/{location}. * @param GoogleCloudContentwarehouseV1SearchDocumentsRequest $postBody * @param array $optParams Optional parameters. * @return GoogleCloudContentwarehouseV1SearchDocumentsResponse * @throws \Google\Service\Exception */ public function search($parent, GoogleCloudContentwarehouseV1SearchDocumentsRequest $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('search', [$params], GoogleCloudContentwarehouseV1SearchDocumentsResponse::class); } /** * Sets the access control policy for a resource. Replaces any existing policy. * (documents.setAcl) * * @param string $resource Required. REQUIRED: The resource for which the policy * is being requested. Format for document: * projects/{project_number}/locations/{location}/documents/{document_id}. * Format for collection: * projects/{project_number}/locations/{location}/collections/{collection_id}. * Format for project: projects/{project_number}. * @param GoogleCloudContentwarehouseV1SetAclRequest $postBody * @param array $optParams Optional parameters. * @return GoogleCloudContentwarehouseV1SetAclResponse * @throws \Google\Service\Exception */ public function setAcl($resource, GoogleCloudContentwarehouseV1SetAclRequest $postBody, $optParams = []) { $params = ['resource' => $resource, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('setAcl', [$params], GoogleCloudContentwarehouseV1SetAclResponse::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(ProjectsLocationsDocuments::class, 'Google_Service_Contentwarehouse_Resource_ProjectsLocationsDocuments');