Class ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource
The "documents" collection of methods.
Inheritance
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1alpha
Assembly: Google.Apis.DiscoveryEngine.v1alpha.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 |
Properties
Chunks
Gets the Chunks resource.
Declaration
public virtual ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.ChunksResource Chunks { get; }
Property Value
Type | Description |
---|---|
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.ChunksResource |
Methods
Create(GoogleCloudDiscoveryengineV1alphaDocument, string)
Creates a Document.
Declaration
public virtual ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.CreateRequest Create(GoogleCloudDiscoveryengineV1alphaDocument body, string parent)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudDiscoveryengineV1alphaDocument | 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 |
GetProcessedDocument(string)
Gets the parsed layout information for a Document.
Declaration
public virtual ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.GetProcessedDocumentRequest GetProcessedDocument(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. Full resource name of Document, such as
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.GetProcessedDocumentRequest |
Import(GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest, 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(GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest body, string parent)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest | 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(GoogleCloudDiscoveryengineV1alphaDocument, string)
Updates a Document.
Declaration
public virtual ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.PatchRequest Patch(GoogleCloudDiscoveryengineV1alphaDocument body, string name)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudDiscoveryengineV1alphaDocument | 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(GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest, 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(GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest body, string parent)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest | body | The body of the request. |
string | parent | Required. The parent resource name, such as
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.PurgeRequest |