Type Definitions
BigQueryOptions :object
Properties:
Name | Type | Attributes | Default | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
projectId |
string |
<optional> |
The project ID from the Google Developer's
Console, e.g. 'grape-spaceship-123'. We will also check the environment
variable |
|||||||||||||
keyFilename |
string |
<optional> |
Full path to the a .json, .pem, or .p12 key
downloaded from the Google Developers Console. If you provide a path to a
JSON file, the |
|||||||||||||
token |
string |
<optional> |
An OAUTH access token. If provided, we will not manage fetching, re-using, and re-minting access tokens. |
|||||||||||||
email |
string |
<optional> |
Account email address. Required when using a .pem or .p12 keyFilename. |
|||||||||||||
credentials |
object |
<optional> |
Credentials object. Properties
|
|||||||||||||
autoRetry |
boolean |
<optional> |
true |
Automatically retry requests if the response is related to rate limits or certain intermittent server errors. We will exponentially backoff subsequent requests by default. |
||||||||||||
maxRetries |
number |
<optional> |
3 |
Maximum number of automatic retries attempted before returning the error. |
||||||||||||
promise |
Constructor |
<optional> |
Custom promise module to use instead of native Promises. |
|||||||||||||
location |
string |
<optional> |
The geographic location of all datasets and jobs referenced and created through the client. |
|||||||||||||
scopes |
Array.<string> |
<optional> |
Additional OAuth scopes to use in requests. For
example, to access an external data source, you may need the
|
|||||||||||||
apiEndpoint |
string |
<optional> |
The API endpoint of the service used to make requests. Defaults to |
- Source:
CreateRoutineCallback(errnullable, routine, response)
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
err |
Error |
<nullable> |
Request error, if any. |
routine |
Routine |
The newly created routine. |
|
response |
object |
The full API response body. |
- Source:
CreateRoutineResponse :array
Properties:
Name | Type | Description |
---|---|---|
0 |
Routine |
The newly created routine. |
1 |
object |
The full API response body. |
- Source:
DeleteRoutineCallback(errnullable, apiResponse)
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
err |
Error |
<nullable> |
Request error, if any. |
apiResponse |
object |
The full API response. |
- Source:
DeleteRoutineResponse :array
Properties:
Name | Type | Description |
---|---|---|
0 |
object |
The full API response. |
- Source:
GetRoutineCallback(errnullable, routine, apiResponse)
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
err |
Error |
<nullable> |
Request error, if any. |
routine |
Routine |
The routine. |
|
apiResponse |
object |
The full API response body. |
- Source:
GetRoutineMetadataCallback(errnullable, metadata, apiResponse)
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
err |
Error |
<nullable> |
Request error, if any. |
metadata |
object |
The routine metadata. |
|
apiResponse |
object |
The full API response. |
- Source:
GetRoutineMetadataResponse :array
Properties:
Name | Type | Description |
---|---|---|
0 |
object |
The routine metadata. |
1 |
object |
The full API response. |
- Source:
GetRoutineResponse :array
Properties:
Name | Type | Description |
---|---|---|
0 |
Routine |
The routine. |
1 |
object |
The full API response body. |
- Source:
GetRoutinesCallback(errnullable, routines, nextQuery, response)
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
err |
Error |
<nullable> |
Request error, if any. |
routines |
Array.<Routine> |
List of routine objects. |
|
nextQuery |
GetRoutinesOptions |
If |
|
response |
object |
The full API response. |
- Source:
GetRoutinesOptions :object
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
autoPaginate |
boolean |
<optional> |
true |
Have pagination handled automatically. |
maxApiCalls |
number |
<optional> |
Maximum number of API calls to make. |
|
maxResults |
number |
<optional> |
Maximum number of results to return. |
|
pageToken |
string |
<optional> |
Token returned from a previous call, to request the next page of results. |
- Source:
GetRoutinesResponse :array
Properties:
Name | Type | Description |
---|---|---|
0 |
Array.<Routine> |
List of routine objects. |
1 |
GetRoutinesOptions |
If |
2 |
object |
The full API response. |
- Source:
ManualQueryResultsCallback(errnullable, rows, nextQuerynullable, apiResponse)
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
err |
Error |
<nullable> |
An error returned while making this request. |
rows |
array |
The results of the job. |
|
nextQuery |
object |
<nullable> |
A pre-made configuration object for your next
request. This will be |
apiResponse |
object |
The full API response. |
QueryResultsCallback(errnullable, rows)
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
err |
Error |
<nullable> |
An error returned while making this request. |
rows |
array |
The results of the job. |
RoutineExistsCallback(errnullable, exists)
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
err |
Error |
<nullable> |
Request error, if any. |
exists |
boolean |
Indicates if the routine exists. |
- Source:
RoutineExistsResponse :array
Properties:
Name | Type | Description |
---|---|---|
0 |
boolean |
Indicates if the routine exists. |
- Source:
SetRoutineMetadataCallback(errnullable, metadata, apiResponse)
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
err |
Error |
<nullable> |
Request error, if any. |
metadata |
object |
The routine metadata. |
|
apiResponse |
object |
The full API response. |
- Source:
SetRoutineMetadataResponse :array
Properties:
Name | Type | Description |
---|---|---|
0 |
object |
The routine metadata. |
1 |
object |
The full API response. |
- Source: