1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Contentwarehouse
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsDocumentsReferenceId

ProjectsLocationsDocumentsReferenceId

class ProjectsLocationsDocumentsReferenceId extends Resource (View source)

The "referenceId" collection of methods.

Typical usage is:

 $contentwarehouseService = new Google\Service\Contentwarehouse(...);
 $referenceId = $contentwarehouseService->projects_locations_documents_referenceId;

Methods

GoogleProtobufEmpty
delete(string $name, GoogleCloudContentwarehouseV1DeleteDocumentRequest $postBody, array $optParams = [])

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

GoogleCloudContentwarehouseV1Document
get(string $name, GoogleCloudContentwarehouseV1GetDocumentRequest $postBody, array $optParams = [])

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

GoogleCloudContentwarehouseV1UpdateDocumentResponse
patch(string $name, GoogleCloudContentwarehouseV1UpdateDocumentRequest $postBody, array $optParams = [])

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

Details

at line 50
GoogleProtobufEmpty delete(string $name, GoogleCloudContentwarehouseV1DeleteDocumentRequest $postBody, array $optParams = [])

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

(referenceId.delete)

Parameters

string $name

Required. The name of the document to delete. Format: projects/{project_number}/locations/{location}/documents/{document_id} or pro jects/{projectnumber}/locations/{location}/documents/referenceId/{reference id}.
GoogleCloudContentwarehouseV1DeleteDocumentRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

at line 69
GoogleCloudContentwarehouseV1Document get(string $name, GoogleCloudContentwarehouseV1GetDocumentRequest $postBody, array $optParams = [])

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

(referenceId.get)

Parameters

string $name

Required. The name of the document to retrieve. Format: projects/{project_number}/locations/{location}/documents/{document_id} or pro jects/{projectnumber}/locations/{location}/documents/referenceId/{reference id}.
GoogleCloudContentwarehouseV1GetDocumentRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudContentwarehouseV1Document

Exceptions

Exception

at line 88
GoogleCloudContentwarehouseV1UpdateDocumentResponse patch(string $name, GoogleCloudContentwarehouseV1UpdateDocumentRequest $postBody, array $optParams = [])

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

Parameters

string $name

Required. The name of the document to update. Format: projects/{project_number}/locations/{location}/documents/{document_id} or pro jects/{projectnumber}/locations/{location}/documents/referenceId/{reference id}.
GoogleCloudContentwarehouseV1UpdateDocumentRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudContentwarehouseV1UpdateDocumentResponse

Exceptions

Exception