Class ProjectsResource.LocationsResource.DocumentsResource

The "documents" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.DocumentsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Contentwarehouse.v1

Assembly: Google.Apis.Contentwarehouse.v1.dll

Syntax

public class ProjectsResource.LocationsResource.DocumentsResource

Constructors

DocumentsResource(IClientService)

Constructs a new resource.

Declaration

public DocumentsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

DocumentLinks

Gets the DocumentLinks resource.

Declaration

public virtual ProjectsResource.LocationsResource.DocumentsResource.DocumentLinksResource DocumentLinks { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DocumentsResource.DocumentLinksResource

ReferenceId

Gets the ReferenceId resource.

Declaration

public virtual ProjectsResource.LocationsResource.DocumentsResource.ReferenceIdResource ReferenceId { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DocumentsResource.ReferenceIdResource

Methods

ContentwarehouseLock(GoogleCloudContentwarehouseV1LockDocumentRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.DocumentsResource.ContentwarehouseLockRequest ContentwarehouseLock(GoogleCloudContentwarehouseV1LockDocumentRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudContentwarehouseV1LockDocumentRequest	body	The body of the request.
string	name	Required. The name of the document to lock. Format: projects/{project_number}/locations/{location}/documents/{document}.

Returns

Type	Description
ProjectsResource.LocationsResource.DocumentsResource.ContentwarehouseLockRequest

Create(GoogleCloudContentwarehouseV1CreateDocumentRequest, string)

Creates a document.

Declaration

public virtual ProjectsResource.LocationsResource.DocumentsResource.CreateRequest Create(GoogleCloudContentwarehouseV1CreateDocumentRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudContentwarehouseV1CreateDocumentRequest	body	The body of the request.
string	parent	Required. The parent name. Format: projects/{project_number}/locations/{location}.

Returns

Type	Description
ProjectsResource.LocationsResource.DocumentsResource.CreateRequest

Delete(GoogleCloudContentwarehouseV1DeleteDocumentRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.DocumentsResource.DeleteRequest Delete(GoogleCloudContentwarehouseV1DeleteDocumentRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudContentwarehouseV1DeleteDocumentRequest	body	The body of the request.
string	name	Required. The name of the document to delete. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}.

Returns

Type	Description
ProjectsResource.LocationsResource.DocumentsResource.DeleteRequest

FetchAcl(GoogleCloudContentwarehouseV1FetchAclRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.DocumentsResource.FetchAclRequest FetchAcl(GoogleCloudContentwarehouseV1FetchAclRequest body, string resource)

Parameters

Type	Name	Description
GoogleCloudContentwarehouseV1FetchAclRequest	body	The body of the request.
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}.

Returns

Type	Description
ProjectsResource.LocationsResource.DocumentsResource.FetchAclRequest

Get(GoogleCloudContentwarehouseV1GetDocumentRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.DocumentsResource.GetRequest Get(GoogleCloudContentwarehouseV1GetDocumentRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudContentwarehouseV1GetDocumentRequest	body	The body of the request.
string	name	Required. The name of the document to retrieve. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}.

Returns

Type	Description
ProjectsResource.LocationsResource.DocumentsResource.GetRequest

LinkedSources(GoogleCloudContentwarehouseV1ListLinkedSourcesRequest, string)

Return all source document-links from the document.

Declaration

public virtual ProjectsResource.LocationsResource.DocumentsResource.LinkedSourcesRequest LinkedSources(GoogleCloudContentwarehouseV1ListLinkedSourcesRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudContentwarehouseV1ListLinkedSourcesRequest	body	The body of the request.
string	parent	Required. The name of the document, for which all source links are returned. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}.

Returns

Type	Description
ProjectsResource.LocationsResource.DocumentsResource.LinkedSourcesRequest

LinkedTargets(GoogleCloudContentwarehouseV1ListLinkedTargetsRequest, string)

Return all target document-links from the document.

Declaration

public virtual ProjectsResource.LocationsResource.DocumentsResource.LinkedTargetsRequest LinkedTargets(GoogleCloudContentwarehouseV1ListLinkedTargetsRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudContentwarehouseV1ListLinkedTargetsRequest	body	The body of the request.
string	parent	Required. The name of the document, for which all target links are returned. Format: projects/{project_number}/locations/{location}/documents/{target_document_id}.

Returns

Type	Description
ProjectsResource.LocationsResource.DocumentsResource.LinkedTargetsRequest

Patch(GoogleCloudContentwarehouseV1UpdateDocumentRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.DocumentsResource.PatchRequest Patch(GoogleCloudContentwarehouseV1UpdateDocumentRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudContentwarehouseV1UpdateDocumentRequest	body	The body of the request.
string	name	Required. The name of the document to update. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}.

Returns

Type	Description
ProjectsResource.LocationsResource.DocumentsResource.PatchRequest

Search(GoogleCloudContentwarehouseV1SearchDocumentsRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.DocumentsResource.SearchRequest Search(GoogleCloudContentwarehouseV1SearchDocumentsRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudContentwarehouseV1SearchDocumentsRequest	body	The body of the request.
string	parent	Required. The parent, which owns this collection of documents. Format: projects/{project_number}/locations/{location}.

Returns

Type	Description
ProjectsResource.LocationsResource.DocumentsResource.SearchRequest

SetAcl(GoogleCloudContentwarehouseV1SetAclRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.DocumentsResource.SetAclRequest SetAcl(GoogleCloudContentwarehouseV1SetAclRequest body, string resource)

Parameters

Type	Name	Description
GoogleCloudContentwarehouseV1SetAclRequest	body	The body of the request.
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}.

Returns

Type	Description
ProjectsResource.LocationsResource.DocumentsResource.SetAclRequest