Class ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.PurgeRequest

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.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GoogleLongrunningOperation>
DiscoveryEngineBaseServiceRequest<GoogleLongrunningOperation>
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.PurgeRequest
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1
Assembly: Google.Apis.DiscoveryEngine.v1.dll
Syntax
public class ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.PurgeRequest : DiscoveryEngineBaseServiceRequest<GoogleLongrunningOperation>, IClientServiceRequest<GoogleLongrunningOperation>, IClientServiceRequest

Constructors

PurgeRequest(IClientService, GoogleCloudDiscoveryengineV1PurgeDocumentsRequest, string)

Constructs a new Purge request.

Declaration
public PurgeRequest(IClientService service, GoogleCloudDiscoveryengineV1PurgeDocumentsRequest body, string parent)
Parameters
Type Name Description
IClientService service
GoogleCloudDiscoveryengineV1PurgeDocumentsRequest body
string parent

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

Parent

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides

InitParameters()

Initializes Purge parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements