Struct google_api_proto::google::cloud::bigquery::v2::GetQueryResultsRequest

pub struct GetQueryResultsRequest {
    pub project_id: String,
    pub job_id: String,
    pub start_index: Option<u64>,
    pub page_token: String,
    pub max_results: Option<u32>,
    pub timeout_ms: Option<u32>,
    pub location: String,
    pub format_options: Option<DataFormatOptions>,
}

Request object of GetQueryResults.

Fields

project_id: String

Required. Project ID of the query job.

job_id: String

Required. Job ID of the query job.

start_index: Option<u64>

Zero-based index of the starting row.

page_token: String

Page token, returned by a previous call, to request the next page of results.

max_results: Option<u32>

Maximum number of results to read.

timeout_ms: Option<u32>

Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing to wait for the query to complete. By default, this limit is 10 seconds (10,000 milliseconds). If the query is complete, the jobComplete field in the response is true. If the query has not yet completed, jobComplete is false.

You can request a longer timeout period in the timeoutMs field. However, the call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete.

If jobComplete is false, you can continue to wait for the query to complete by calling the getQueryResults method until the jobComplete field in the getQueryResults response is true.

location: String

The geographic location of the job. You must specify the location to run the job for the following scenarios:

• If the location to run a job is not in the us or the eu multi-regional location
• If the job’s location is in a single region (for example, us-central1)

For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

format_options: Option<DataFormatOptions>

Optional. Output format adjustments.

Trait Implementations

impl Clone for GetQueryResultsRequest

fn clone(&self) -> GetQueryResultsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetQueryResultsRequest

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

Formats the value using the given formatter.

impl Default for GetQueryResultsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for GetQueryResultsRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for GetQueryResultsRequest

fn eq(&self, other: &GetQueryResultsRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetQueryResultsRequest