Class Job (5.7.1)

Job objects are returned from various places in the BigQuery API:

They can be used to check the status of a running job or fetching the results of a previously-executed one.

Inheritance

Operation > Job

Package

@google-cloud/bigquery!

Constructors

(constructor)(bigQuery, id, options)

constructor(bigQuery: BigQuery, id: string, options?: JobOptions);

Constructs a new instance of the Job class

Parameters

Name	Description
bigQuery	`BigQuery`
id	`string`
options	`JobOptions`

Properties

bigQuery

bigQuery: BigQuery;

Property Value

Type	Description
BigQuery

getQueryResultsStream

getQueryResultsStream: (options?: QueryResultsOptions) => ResourceStream<RowMetadata>;

Property Value

Type	Description
(options?: QueryResultsOptions) => ResourceStream<RowMetadata>

location

location?: string;

Property Value

Type	Description
string

Methods

cancel()

cancel(): Promise<CancelResponse>;

Returns

Type	Description
Promise<CancelResponse>

cancel(callback)

cancel(callback: CancelCallback): void;

Parameter

Name	Description
callback	`CancelCallback`

Returns

Type	Description
void

getQueryResults(options)

getQueryResults(options?: QueryResultsOptions): Promise<QueryRowsResponse>;

Parameter

Name	Description
options	`QueryResultsOptions`

Returns

Type	Description
Promise<QueryRowsResponse>

getQueryResults(options, callback)

getQueryResults(options: QueryResultsOptions, callback: QueryRowsCallback): void;

Parameters

Name	Description
options	`QueryResultsOptions`
callback	`QueryRowsCallback`

Returns

Type	Description
void

getQueryResults(callback)

getQueryResults(callback: QueryRowsCallback): void;

Parameter

Name	Description
callback	`QueryRowsCallback`

Returns

Type	Description
void

getQueryResultsAsStream_(options, callback)

getQueryResultsAsStream_(options: QueryResultsOptions, callback: QueryRowsCallback): void;

This method will be called by getQueryResultsStream(). It is required to properly set the autoPaginate option value.

Parameters

Name	Description
options	`QueryResultsOptions`
callback	`QueryRowsCallback`

Returns

Type	Description
void

poll_(callback)

poll_(callback: MetadataCallback): void;

Poll for a status update. Execute the callback:

callback(err): Job failed - callback(): Job incomplete - callback(null, metadata): Job complete

Parameter

Name	Description
callback	`MetadataCallback`

Returns

Type	Description
void