Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.QueuesResource.TasksResource.ListRequest

Lists the tasks in a queue. By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned. The tasks may be returned in any order. The ordering may change at any time.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListTasksResponse>
CloudTasksBaseServiceRequest<ListTasksResponse>
ProjectsResource.LocationsResource.QueuesResource.TasksResource.ListRequest
Implements
IClientServiceRequest<ListTasksResponse>
IClientServiceRequest
Inherited Members
CloudTasksBaseServiceRequest<ListTasksResponse>.Xgafv
CloudTasksBaseServiceRequest<ListTasksResponse>.AccessToken
CloudTasksBaseServiceRequest<ListTasksResponse>.Alt
CloudTasksBaseServiceRequest<ListTasksResponse>.Callback
CloudTasksBaseServiceRequest<ListTasksResponse>.Fields
CloudTasksBaseServiceRequest<ListTasksResponse>.Key
CloudTasksBaseServiceRequest<ListTasksResponse>.OauthToken
CloudTasksBaseServiceRequest<ListTasksResponse>.PrettyPrint
CloudTasksBaseServiceRequest<ListTasksResponse>.QuotaUser
CloudTasksBaseServiceRequest<ListTasksResponse>.UploadType
CloudTasksBaseServiceRequest<ListTasksResponse>.UploadProtocol
ClientServiceRequest<ListTasksResponse>.Execute()
ClientServiceRequest<ListTasksResponse>.ExecuteAsStream()
ClientServiceRequest<ListTasksResponse>.ExecuteAsync()
ClientServiceRequest<ListTasksResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<ListTasksResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<ListTasksResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<ListTasksResponse>.CreateRequest(bool?)
ClientServiceRequest<ListTasksResponse>.GenerateRequestUri()
ClientServiceRequest<ListTasksResponse>.GetBody()
ClientServiceRequest<ListTasksResponse>.GetDefaultETagAction(string)
ClientServiceRequest<ListTasksResponse>.ETagAction
ClientServiceRequest<ListTasksResponse>.ModifyRequest
ClientServiceRequest<ListTasksResponse>.ValidateParameters
ClientServiceRequest<ListTasksResponse>.ApiVersion
ClientServiceRequest<ListTasksResponse>.RequestParameters
ClientServiceRequest<ListTasksResponse>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudTasks.v2beta3
Assembly: Google.Apis.CloudTasks.v2beta3.dll
Syntax
public class ProjectsResource.LocationsResource.QueuesResource.TasksResource.ListRequest : CloudTasksBaseServiceRequest<ListTasksResponse>, IClientServiceRequest<ListTasksResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type Name Description
IClientService service
string parent

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<ListTasksResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<ListTasksResponse>.MethodName

PageSize

Maximum page size. Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist. The maximum page size is 1000. If unspecified, the page size will be the maximum.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListTasks method. The page token is valid for only 2 hours.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Parent

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

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

ResponseView

The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

Declaration
[RequestParameter("responseView", RequestParameterType.Query)]
public virtual ProjectsResource.LocationsResource.QueuesResource.TasksResource.ListRequest.ResponseViewEnum? ResponseView { get; set; }
Property Value
Type Description
ProjectsResource.LocationsResource.QueuesResource.TasksResource.ListRequest.ResponseViewEnum?

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<ListTasksResponse>.RestPath

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
CloudTasksBaseServiceRequest<ListTasksResponse>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX