bigquery  v2
Public Types | Public Member Functions | Protected Member Functions | Properties | List of all members
Google.Apis.Bigquery.v2.JobsResource.ListRequest Class Reference

Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property. More...

Inheritance diagram for Google.Apis.Bigquery.v2.JobsResource.ListRequest:
Google.Apis.Bigquery.v2.BigqueryBaseServiceRequest< Google.Apis.Bigquery.v2.Data.JobList >

Public Types

enum  StateFilterEnum { StateFilterEnum.Done, StateFilterEnum.Pending, StateFilterEnum.Running }
 Filter for job state More...
 
enum  ProjectionEnum { ProjectionEnum.Full, ProjectionEnum.Minimal }
 Restrict information returned to a set of selected fields More...
 

Public Member Functions

 ListRequest (Google.Apis.Services.IClientService service, string projectId)
 Constructs a new List request. More...
 

Protected Member Functions

override void InitParameters ()
 Initializes List parameter list. More...
 
- Protected Member Functions inherited from Google.Apis.Bigquery.v2.BigqueryBaseServiceRequest< Google.Apis.Bigquery.v2.Data.JobList >
 BigqueryBaseServiceRequest (Google.Apis.Services.IClientService service)
 Constructs a new BigqueryBaseServiceRequest instance. More...
 
override void InitParameters ()
 Initializes Bigquery parameter list. More...
 

Properties

virtual string ProjectId [get]
 Project ID of the jobs to list More...
 
virtual string ParentJobId [get, set]
 If set, retrieves only jobs whose parent is this job. Otherwise, retrieves only jobs which have no parent More...
 
virtual System.Nullable< ulong > MinCreationTime [get, set]
 Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned More...
 
virtual string PageToken [get, set]
 Page token, returned by a previous call, to request the next page of results More...
 
virtual System.Nullable< bool > AllUsers [get, set]
 Whether to display jobs owned by all users in the project. Default false More...
 
virtual System.Nullable< long > MaxResults [get, set]
 Maximum number of results to return More...
 
virtual System.Nullable< ulong > MaxCreationTime [get, set]
 Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned More...
 
virtual System.Nullable< StateFilterEnumStateFilter [get, set]
 Filter for job state More...
 
virtual System.Nullable< ProjectionEnumProjection [get, set]
 Restrict information returned to a set of selected fields More...
 
override string MethodName [get]
 Gets the method name. More...
 
override string HttpMethod [get]
 summary>Gets the REST path. More...
 
override string RestPath [get]
 
- Properties inherited from Google.Apis.Bigquery.v2.BigqueryBaseServiceRequest< Google.Apis.Bigquery.v2.Data.JobList >
virtual System.Nullable< AltEnum > Alt [get, set]
 Data format for the response. More...
 
virtual string Fields [get, set]
 Selector specifying which fields to include in a partial response. More...
 
virtual string Key [get, set]
 API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. More...
 
virtual string OauthToken [get, set]
 OAuth 2.0 token for the current user. More...
 
virtual System.Nullable< bool > PrettyPrint [get, set]
 Returns response with indentations and line breaks. More...
 
virtual string QuotaUser [get, set]
 An opaque string that represents a user for quota purposes. Must not exceed 40 characters. More...
 
virtual string UserIp [get, set]
 Deprecated. Please use quotaUser instead. More...
 

Detailed Description

Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.

Member Enumeration Documentation

◆ ProjectionEnum

Restrict information returned to a set of selected fields

Enumerator
Full 

Includes all job data

Minimal 

Does not include the job configuration

◆ StateFilterEnum

Filter for job state

Enumerator
Done 

Finished jobs

Pending 

Pending jobs

Running 

Running jobs

Constructor & Destructor Documentation

◆ ListRequest()

Google.Apis.Bigquery.v2.JobsResource.ListRequest.ListRequest ( Google.Apis.Services.IClientService  service,
string  projectId 
)
inline

Constructs a new List request.

Member Function Documentation

◆ InitParameters()

override void Google.Apis.Bigquery.v2.JobsResource.ListRequest.InitParameters ( )
inlineprotected

Initializes List parameter list.

Property Documentation

◆ AllUsers

virtual System.Nullable<bool> Google.Apis.Bigquery.v2.JobsResource.ListRequest.AllUsers
getset

Whether to display jobs owned by all users in the project. Default false

◆ HttpMethod

override string Google.Apis.Bigquery.v2.JobsResource.ListRequest.HttpMethod
get

summary>Gets the REST path.

◆ MaxCreationTime

virtual System.Nullable<ulong> Google.Apis.Bigquery.v2.JobsResource.ListRequest.MaxCreationTime
getset

Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned

◆ MaxResults

virtual System.Nullable<long> Google.Apis.Bigquery.v2.JobsResource.ListRequest.MaxResults
getset

Maximum number of results to return

◆ MethodName

override string Google.Apis.Bigquery.v2.JobsResource.ListRequest.MethodName
get

Gets the method name.

summary>Gets the HTTP method.

◆ MinCreationTime

virtual System.Nullable<ulong> Google.Apis.Bigquery.v2.JobsResource.ListRequest.MinCreationTime
getset

Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned

◆ PageToken

virtual string Google.Apis.Bigquery.v2.JobsResource.ListRequest.PageToken
getset

Page token, returned by a previous call, to request the next page of results

◆ ParentJobId

virtual string Google.Apis.Bigquery.v2.JobsResource.ListRequest.ParentJobId
getset

If set, retrieves only jobs whose parent is this job. Otherwise, retrieves only jobs which have no parent

◆ ProjectId

virtual string Google.Apis.Bigquery.v2.JobsResource.ListRequest.ProjectId
get

Project ID of the jobs to list

◆ Projection

virtual System.Nullable<ProjectionEnum> Google.Apis.Bigquery.v2.JobsResource.ListRequest.Projection
getset

Restrict information returned to a set of selected fields

◆ StateFilter

virtual System.Nullable<StateFilterEnum> Google.Apis.Bigquery.v2.JobsResource.ListRequest.StateFilter
getset

Filter for job state


The documentation for this class was generated from the following file: