Show / Hide Table of Contents

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
System.Object
Google.Apis.Requests.ClientServiceRequest
Google.Apis.Requests.ClientServiceRequest<Queue>
CloudTasksBaseServiceRequest<Queue>
ProjectsResource.LocationsResource.QueuesResource.PurgeRequest
Implements
Google.Apis.Requests.IClientServiceRequest<Queue>
Google.Apis.Requests.IClientServiceRequest
Inherited Members
CloudTasksBaseServiceRequest<Queue>.Xgafv
CloudTasksBaseServiceRequest<Queue>.AccessToken
CloudTasksBaseServiceRequest<Queue>.Alt
CloudTasksBaseServiceRequest<Queue>.Callback
CloudTasksBaseServiceRequest<Queue>.Fields
CloudTasksBaseServiceRequest<Queue>.Key
CloudTasksBaseServiceRequest<Queue>.OauthToken
CloudTasksBaseServiceRequest<Queue>.PrettyPrint
CloudTasksBaseServiceRequest<Queue>.QuotaUser
CloudTasksBaseServiceRequest<Queue>.UploadType
CloudTasksBaseServiceRequest<Queue>.UploadProtocol
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Queue>.Execute()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Queue>.ExecuteAsStream()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Queue>.ExecuteAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Queue>.ExecuteAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Queue>.ExecuteAsStreamAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Queue>.ExecuteAsStreamAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Queue>.CreateRequest(System.Nullable<System.Boolean>)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Queue>.GenerateRequestUri()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Queue>.GetDefaultETagAction(System.String)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Queue>.ETagAction
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Queue>.ModifyRequest
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Queue>.ValidateParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Queue>.RequestParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Queue>.Service
Google.Apis.Requests.ClientServiceRequest._unsuccessfulResponseHandlers
Google.Apis.Requests.ClientServiceRequest._exceptionHandlers
Google.Apis.Requests.ClientServiceRequest._executeInterceptors
Google.Apis.Requests.ClientServiceRequest.AddUnsuccessfulResponseHandler(Google.Apis.Http.IHttpUnsuccessfulResponseHandler)
Google.Apis.Requests.ClientServiceRequest.AddExceptionHandler(Google.Apis.Http.IHttpExceptionHandler)
Google.Apis.Requests.ClientServiceRequest.AddExecuteInterceptor(Google.Apis.Http.IHttpExecuteInterceptor)
Google.Apis.Requests.ClientServiceRequest.Credential
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.CloudTasks.v2beta2
Assembly: Google.Apis.CloudTasks.v2beta2.dll
Syntax
public class 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
Google.Apis.Services.IClientService service
PurgeQueueRequest body
System.String name

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Queue>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Queue>.MethodName

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
System.String

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Queue>.RestPath

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
System.Object
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Queue>.GetBody()

InitParameters()

Initializes Purge parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.CloudTasks.v2beta2.CloudTasksBaseServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Queue>.InitParameters()

Implements

Google.Apis.Requests.IClientServiceRequest<TResponse>
Google.Apis.Requests.IClientServiceRequest
In This Article
Back to top