Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.QueuesResource.TasksResource.RunRequest

Forces a task to run now. When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED. This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched now. The dispatched task is returned. That is, the task that is returned contains the status after the task is dispatched but before the task is received by its target. If Cloud Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus the retry delay specified in the queue's RetryConfig. RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed. RunTask cannot be called on a pull task.

Inheritance
System.Object
Google.Apis.Requests.ClientServiceRequest
Google.Apis.Requests.ClientServiceRequest<Task>
CloudTasksBaseServiceRequest<Task>
ProjectsResource.LocationsResource.QueuesResource.TasksResource.RunRequest
Implements
Google.Apis.Requests.IClientServiceRequest<Task>
Google.Apis.Requests.IClientServiceRequest
Inherited Members
CloudTasksBaseServiceRequest<Task>.Xgafv
CloudTasksBaseServiceRequest<Task>.AccessToken
CloudTasksBaseServiceRequest<Task>.Alt
CloudTasksBaseServiceRequest<Task>.Callback
CloudTasksBaseServiceRequest<Task>.Fields
CloudTasksBaseServiceRequest<Task>.Key
CloudTasksBaseServiceRequest<Task>.OauthToken
CloudTasksBaseServiceRequest<Task>.PrettyPrint
CloudTasksBaseServiceRequest<Task>.QuotaUser
CloudTasksBaseServiceRequest<Task>.UploadType
CloudTasksBaseServiceRequest<Task>.UploadProtocol
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Task>.Execute()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Task>.ExecuteAsStream()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Task>.ExecuteAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Task>.ExecuteAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Task>.ExecuteAsStreamAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Task>.ExecuteAsStreamAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Task>.CreateRequest(System.Nullable<System.Boolean>)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Task>.GenerateRequestUri()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Task>.GetDefaultETagAction(System.String)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Task>.ETagAction
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Task>.ModifyRequest
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Task>.ValidateParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Task>.RequestParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudTasks.v2beta2.Data.Task>.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 RunRequest : CloudTasksBaseServiceRequest<Task>, IClientServiceRequest<Task>, IClientServiceRequest

Constructors

RunRequest(IClientService, RunTaskRequest, String)

Constructs a new Run request.

Declaration
public RunRequest(IClientService service, RunTaskRequest body, string name)
Parameters
Type Name Description
Google.Apis.Services.IClientService service
RunTaskRequest 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.Task>.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.Task>.MethodName

Name

Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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.Task>.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.Task>.GetBody()

InitParameters()

Initializes Run parameter list.

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

Implements

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