Class ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource

The "documents" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.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.DiscoveryEngine.v1

Assembly: Google.Apis.DiscoveryEngine.v1.dll

Syntax

public class ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource

Constructors

DocumentsResource(IClientService)

Constructs a new resource.

Declaration

public DocumentsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Create(GoogleCloudDiscoveryengineV1Document, string)

Creates a Document.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.CreateRequest Create(GoogleCloudDiscoveryengineV1Document body, string parent)

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1Document	body	The body of the request.
string	parent	Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

Returns

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.CreateRequest

Delete(string)

Deletes a Document.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. Full resource name of Document, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to delete does not exist, a NOT_FOUND error is returned.

Returns

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.DeleteRequest

Get(string)

Gets a Document.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. Full resource name of Document, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}. If the caller does not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Document does not exist, a NOT_FOUND error is returned.

Returns

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.GetRequest

Import(GoogleCloudDiscoveryengineV1ImportDocumentsRequest, string)

Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.ImportRequest Import(GoogleCloudDiscoveryengineV1ImportDocumentsRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1ImportDocumentsRequest	body	The body of the request.
string	parent	Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Requires create/update permission.

Returns

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.ImportRequest

List(string)

Gets a list of Documents.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Use default_branch as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

Returns

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.ListRequest

Patch(GoogleCloudDiscoveryengineV1Document, string)

Updates a Document.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.PatchRequest Patch(GoogleCloudDiscoveryengineV1Document body, string name)

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1Document	body	The body of the request.
string	name	Immutable. The full resource name of the document. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

Returns

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.PatchRequest

Purge(GoogleCloudDiscoveryengineV1PurgeDocumentsRequest, string)

Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.PurgeRequest Purge(GoogleCloudDiscoveryengineV1PurgeDocumentsRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1PurgeDocumentsRequest	body	The body of the request.
string	parent	Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

Returns

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.PurgeRequest