Struct JobService 

pub struct JobService { /* private fields */ }

Implements a client for the BigQuery API.

Example

async fn sample(
) -> anyhow::Result<()> {
    let client = JobService::builder().build().await?;
    let response = client.cancel_job()
        /* set fields */
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}

Service Description

Configuration

To configure JobService use the with_* methods in the type returned by builder(). The default configuration should work for most applications. Common configuration changes include

• with_endpoint(): by default this client uses the global default endpoint (https://bigquery.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured with Private Google Access with VPC Service Controls) may want to override this default.
• with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.

Pooling and Cloning

JobService holds a connection pool internally, it is advised to create one and reuse it. You do not need to wrap JobService in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations

impl JobService

pub fn builder() -> ClientBuilder

Returns a builder for JobService.

let client = JobService::builder().build().await?;

pub fn from_stub<T>(stub: impl Into<Arc<T>>) -> Self

where T: JobService + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is in tests mocking the client’s behavior.

pub fn cancel_job(&self) -> CancelJob

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.

IAM Permissions

Requires the bigquery.jobs.update permission on the job resource. If the user matches the creator of the job, the bigquery.jobs.create permission on the project is required instead.

Example

use google_cloud_bigquery_v2::Result;
async fn sample(
   client: &JobService
) -> Result<()> {
    let response = client.cancel_job()
        /* set fields */
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}

pub fn get_job(&self) -> GetJob

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.

IAM Permissions

Requires the bigquery.jobs.get permission on the job resource. If the user matches the creator of the job, the bigquery.jobs.create permission on the project is required instead.

Example

use google_cloud_bigquery_v2::Result;
async fn sample(
   client: &JobService
) -> Result<()> {
    let response = client.get_job()
        /* set fields */
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}

pub fn insert_job(&self) -> InsertJob

Starts a new asynchronous job.

This API has two different kinds of endpoint URIs, as this method supports a variety of use cases.

• The Metadata URI is used for most interactions, as it accepts the job configuration directly.
• The Upload URI is ONLY for the case when you’re sending both a load job configuration and a data stream together. In this case, the Upload URI accepts the job configuration and the data as two distinct multipart MIME parts.

IAM Permissions

Requires the bigquery.jobs.create permission on the project resource.

Additional permissions are required depending on the job type:

• Load, Export, and Copy jobs: Generally require data-level permissions such as bigquery.tables.export or access to external storage.
• Query jobs: Permissions are dependent on the SQL statement. Complex queries (DDL, DCL) may require additional permissions to create reservations, modify IAM policies, or update project settings.

Example

use google_cloud_bigquery_v2::Result;
async fn sample(
   client: &JobService
) -> Result<()> {
    let response = client.insert_job()
        /* set fields */
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}

pub fn delete_job(&self) -> DeleteJob

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

IAM Permissions

Requires the bigquery.jobs.delete permission on the job resource.

Example

use google_cloud_bigquery_v2::Result;
async fn sample(
   client: &JobService
) -> Result<()> {
    client.delete_job()
        /* set fields */
        .send().await?;
    Ok(())
}

pub fn list_jobs(&self) -> ListJobs

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.

IAM Permissions

Requires no specific IAM permission(s) to use this method. Users are able to list the jobs they created.

Additional access is granted based on the following permissions:

• Users with the bigquery.jobs.listAll permission can list all jobs with all metadata.
• Users with the bigquery.jobs.list permission can list all jobs, but with redacted information for jobs they did not create.

Example

use google_cloud_gax::paginator::ItemPaginator as _;
use google_cloud_bigquery_v2::Result;
async fn sample(
   client: &JobService
) -> Result<()> {
    let mut list = client.list_jobs()
        /* set fields */
        .by_item();
    while let Some(item) = list.next().await.transpose()? {
        println!("{:?}", item);
    }
    Ok(())
}

pub fn get_query_results(&self) -> GetQueryResults

RPC to get the results of a query job.

IAM Permissions

Requires the following IAM permission(s) to use this method:

• bigquery.jobs.get on the job.
• bigquery.tables.getData on the destination table.

If the user matches the creator of the job, the following IAM permission(s) are required instead:

• bigquery.jobs.create on the project.
• bigquery.tables.getData on the destination table.

Example

use google_cloud_bigquery_v2::Result;
async fn sample(
   client: &JobService
) -> Result<()> {
    let response = client.get_query_results()
        /* set fields */
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}

pub fn query(&self) -> Query

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

IAM Permissions

Requires the bigquery.jobs.create permission on the project resource.

Data-level permissions are highly dependent on the SQL statement being executed. While standard queries require data access (such as bigquery.tables.getData), complex operations like DDL or DCL may require permissions to manage reservations, IAM policies, or project settings.

Example

use google_cloud_bigquery_v2::Result;
async fn sample(
   client: &JobService
) -> Result<()> {
    let response = client.query()
        /* set fields */
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}

Trait Implementations

impl Clone for JobService

fn clone(&self) -> JobService

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for JobService

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.