Class ProjectsResource.LocationsResource.QueuesResource.PurgeRequest

Purges a queue by deleting all of its tasks. All tasks created before this method is called are permanently deleted. Purge operations can take up to one minute to take effect. Tasks might be dispatched before the purge takes effect. A purge is irreversible.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Queue>
CloudTasksBaseServiceRequest<Queue>
ProjectsResource.LocationsResource.QueuesResource.PurgeRequest
Implements
Inherited Members
Namespace: Google.Apis.CloudTasks.v2
Assembly: Google.Apis.CloudTasks.v2.dll
Syntax
public class ProjectsResource.LocationsResource.QueuesResource.PurgeRequest : CloudTasksBaseServiceRequest<Queue>, IClientServiceRequest<Queue>, IClientServiceRequest

Constructors

PurgeRequest(IClientService, PurgeQueueRequest, string)

Constructs a new Purge request.

Declaration
public PurgeRequest(IClientService service, PurgeQueueRequest body, string name)
Parameters
Type Name Description
IClientService service
PurgeQueueRequest body
string name

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

Name

Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID

Declaration
[RequestParameter("name", RequestParameterType.Path)]
public virtual string Name { 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