Show / Hide Table of Contents

Class JobsResource

The "jobs" collection of methods.

Inheritance
System.Object
JobsResource
Inherited Members
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.Bigquery.v2
Assembly: Google.Apis.Bigquery.v2.dll
Syntax
public class JobsResource

Constructors

JobsResource(IClientService)

Constructs a new resource.

Declaration
public JobsResource(IClientService service)
Parameters
Type Name Description
Google.Apis.Services.IClientService service

Methods

Cancel(String, String)

Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs.

Declaration
public virtual JobsResource.CancelRequest Cancel(string projectId, string jobId)
Parameters
Type Name Description
System.String projectId

[Required] Project ID of the job to cancel

System.String jobId

[Required] Job ID of the job to cancel

Returns
Type Description
JobsResource.CancelRequest

Delete(String, String)

Requests the deletion of the metadata of a job. This call returns when the job's metadata is deleted.

Declaration
public virtual JobsResource.DeleteRequest Delete(string projectId, string jobId)
Parameters
Type Name Description
System.String projectId

Required. Project ID of the job for which metadata is to be deleted.

System.String jobId

Required. Job ID of the job for which metadata is to be deleted. If this is a parent job which has child jobs, the metadata from all child jobs will be deleted as well. Direct deletion of the metadata of child jobs is not allowed.

Returns
Type Description
JobsResource.DeleteRequest

Get(String, String)

Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role.

Declaration
public virtual JobsResource.GetRequest Get(string projectId, string jobId)
Parameters
Type Name Description
System.String projectId

[Required] Project ID of the requested job

System.String jobId

[Required] Job ID of the requested job

Returns
Type Description
JobsResource.GetRequest

GetQueryResults(String, String)

Retrieves the results of a query job.

Declaration
public virtual JobsResource.GetQueryResultsRequest GetQueryResults(string projectId, string jobId)
Parameters
Type Name Description
System.String projectId

[Required] Project ID of the query job

System.String jobId

[Required] Job ID of the query job

Returns
Type Description
JobsResource.GetQueryResultsRequest

Insert(Job, String)

Starts a new asynchronous job. Requires the Can View project role.

Declaration
public virtual JobsResource.InsertRequest Insert(Job body, string projectId)
Parameters
Type Name Description
Job body

The body of the request.

System.String projectId

Project ID of the project that will be billed for the job

Returns
Type Description
JobsResource.InsertRequest

Insert(Job, String, Stream, String)

Starts a new asynchronous job. Requires the Can View project role.

Declaration
public virtual JobsResource.InsertMediaUpload Insert(Job body, string projectId, Stream stream, string contentType)
Parameters
Type Name Description
Job body

The body of the request.

System.String projectId

Project ID of the project that will be billed for the job

System.IO.Stream stream

The stream to upload. See remarks for further information.

System.String contentType

The content type of the stream to upload.

Returns
Type Description
JobsResource.InsertMediaUpload
Remarks

Considerations regarding stream:

  • If stream is seekable, then the stream position will be reset to 0 before reading commences. If stream is not seekable, then it will be read from its current position
  • Caller is responsible for maintaining the stream open until the upload is completed
  • Caller is responsible for closing the stream

List(String)

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.

Declaration
public virtual JobsResource.ListRequest List(string projectId)
Parameters
Type Name Description
System.String projectId

Project ID of the jobs to list

Returns
Type Description
JobsResource.ListRequest

Query(QueryRequest, String)

Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.

Declaration
public virtual JobsResource.QueryRequest Query(QueryRequest body, string projectId)
Parameters
Type Name Description
QueryRequest body

The body of the request.

System.String projectId

Project ID of the project billed for the query

Returns
Type Description
JobsResource.QueryRequest
In This Article
Back to top