google_api_big_query v0.13.0 GoogleApi.BigQuery.V2.Api.Jobs View Source
API calls for all endpoints tagged Jobs
.
Link to this section Summary
Functions
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.
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.
Retrieves the results of a query job.
Starts a new asynchronous job. Requires the Can View project role.
Starts a new asynchronous job. Requires the Can View project role.
Starts a new asynchronous job. Requires the Can View project role.
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.
Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.
Link to this section Functions
bigquery_jobs_cancel(connection, project_id, job_id, optional_params \\ [], opts \\ []) View Source
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.
Parameters
- connection (GoogleApi.BigQuery.V2.Connection): Connection to server
- project_id (String.t): [Required] Project ID of the job to cancel
- job_id (String.t): [Required] Job ID of the job to cancel
optional_params (keyword()): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :location (String.t): The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
Returns
{:ok, %GoogleApi.BigQuery.V2.Model.JobCancelResponse{}} on success {:error, info} on failure
bigquery_jobs_get(connection, project_id, job_id, optional_params \\ [], opts \\ []) View Source
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.
Parameters
- connection (GoogleApi.BigQuery.V2.Connection): Connection to server
- project_id (String.t): [Required] Project ID of the requested job
- job_id (String.t): [Required] Job ID of the requested job
optional_params (keyword()): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :location (String.t): The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
Returns
{:ok, %GoogleApi.BigQuery.V2.Model.Job{}} on success {:error, info} on failure
bigquery_jobs_get_query_results(connection, project_id, job_id, optional_params \\ [], opts \\ []) View Source
Retrieves the results of a query job.
Parameters
- connection (GoogleApi.BigQuery.V2.Connection): Connection to server
- project_id (String.t): [Required] Project ID of the query job
- job_id (String.t): [Required] Job ID of the query job
optional_params (keyword()): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :location (String.t): The geographic location where the job should run. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
- :maxResults (integer()): Maximum number of results to read
- :pageToken (String.t): Page token, returned by a previous call, to request the next page of results
- :startIndex (String.t): Zero-based index of the starting row
- :timeoutMs (integer()): How long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, the 'jobComplete' field in the response will be false
Returns
{:ok, %GoogleApi.BigQuery.V2.Model.GetQueryResultsResponse{}} on success {:error, info} on failure
bigquery_jobs_insert(connection, project_id, optional_params \\ [], opts \\ []) View Source
Starts a new asynchronous job. Requires the Can View project role.
Parameters
- connection (GoogleApi.BigQuery.V2.Connection): Connection to server
- project_id (String.t): Project ID of the project that will be billed for the job
optional_params (keyword()): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :body (GoogleApi.BigQuery.V2.Model.Job.t):
Returns
{:ok, %GoogleApi.BigQuery.V2.Model.Job{}} on success {:error, info} on failure
bigquery_jobs_insert_resumable(connection, project_id, upload_type, optional_params \\ [], opts \\ []) View Source
Starts a new asynchronous job. Requires the Can View project role.
Parameters
- connection (GoogleApi.BigQuery.V2.Connection): Connection to server
- project_id (String.t): Project ID of the project that will be billed for the job
- upload_type (String.t): Upload type. Must be "resumable".
optional_params (keyword()): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :body (GoogleApi.BigQuery.V2.Model.Job.t):
Returns
{:ok, %{}} on success {:error, info} on failure
bigquery_jobs_insert_simple(connection, project_id, upload_type, metadata, data, optional_params \\ [], opts \\ []) View Source
Starts a new asynchronous job. Requires the Can View project role.
Parameters
- connection (GoogleApi.BigQuery.V2.Connection): Connection to server
- project_id (String.t): Project ID of the project that will be billed for the job
- upload_type (String.t): Upload type. Must be "multipart".
- metadata (GoogleApi.BigQuery.V2.Model.Job.t): object metadata
- data (String.t): Path to file
optional_params (keyword()): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
Returns
{:ok, %GoogleApi.BigQuery.V2.Model.Job{}} on success {:error, info} on failure
bigquery_jobs_list(connection, project_id, optional_params \\ [], opts \\ []) View Source
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.
Parameters
- connection (GoogleApi.BigQuery.V2.Connection): Connection to server
- project_id (String.t): Project ID of the jobs to list
optional_params (keyword()): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :allUsers (boolean()): Whether to display jobs owned by all users in the project. Default false
- :maxCreationTime (String.t): 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 (integer()): Maximum number of results to return
- :minCreationTime (String.t): 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 (String.t): Page token, returned by a previous call, to request the next page of results
- :projection (String.t): Restrict information returned to a set of selected fields
- :stateFilter (list(String.t)): Filter for job state
Returns
{:ok, %GoogleApi.BigQuery.V2.Model.JobList{}} on success {:error, info} on failure
bigquery_jobs_query(connection, project_id, optional_params \\ [], opts \\ []) View Source
Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.
Parameters
- connection (GoogleApi.BigQuery.V2.Connection): Connection to server
- project_id (String.t): Project ID of the project billed for the query
optional_params (keyword()): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :body (GoogleApi.BigQuery.V2.Model.QueryRequest.t):
Returns
{:ok, %GoogleApi.BigQuery.V2.Model.QueryResponse{}} on success {:error, info} on failure