Class ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource
The "documents" collection of methods.
Inheritance
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1beta
Assembly: Google.Apis.DiscoveryEngine.v1beta.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(GoogleCloudDiscoveryengineV1betaDocument, string)
Creates a Document.
Declaration
public virtual ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.CreateRequest Create(GoogleCloudDiscoveryengineV1betaDocument body, string parent)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudDiscoveryengineV1betaDocument | body | The body of the request. |
string | parent | Required. The parent resource name, such as
|
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
|
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
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.GetRequest |
Import(GoogleCloudDiscoveryengineV1betaImportDocumentsRequest, 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(GoogleCloudDiscoveryengineV1betaImportDocumentsRequest body, string parent)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudDiscoveryengineV1betaImportDocumentsRequest | body | The body of the request. |
string | parent | Required. The parent branch resource name, such as
|
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
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.ListRequest |
Patch(GoogleCloudDiscoveryengineV1betaDocument, string)
Updates a Document.
Declaration
public virtual ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.PatchRequest Patch(GoogleCloudDiscoveryengineV1betaDocument body, string name)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudDiscoveryengineV1betaDocument | body | The body of the request. |
string | name | Immutable. The full resource name of the document. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.PatchRequest |
Purge(GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest, 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(GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest body, string parent)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest | body | The body of the request. |
string | parent | Required. The parent resource name, such as
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.PurgeRequest |