Class: Google::Apis::BigqueryV2::QueryRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/bigquery_v2/classes.rb,
generated/google/apis/bigquery_v2/representations.rb,
generated/google/apis/bigquery_v2/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ QueryRequest

Returns a new instance of QueryRequest.


4781
4782
4783
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4781

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#connection_propertiesArray<Google::Apis::BigqueryV2::ConnectionProperty>

Connection properties. Corresponds to the JSON property connectionProperties


4652
4653
4654
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4652

def connection_properties
  @connection_properties
end

#default_datasetGoogle::Apis::BigqueryV2::DatasetReference

[Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'. Corresponds to the JSON property defaultDataset


4659
4660
4661
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4659

def default_dataset
  @default_dataset
end

#dry_runBoolean Also known as: dry_run?

[Optional] If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false. Corresponds to the JSON property dryRun

Returns:

  • (Boolean)

4667
4668
4669
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4667

def dry_run
  @dry_run
end

#kindString

The resource type of the request. Corresponds to the JSON property kind

Returns:

  • (String)

4673
4674
4675
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4673

def kind
  @kind
end

#labelsHash<String,String>

The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>)

4682
4683
4684
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4682

def labels
  @labels
end

#locationString

The geographic location where the job should run. See details at https://cloud. google.com/bigquery/docs/locations#specifying_your_location. Corresponds to the JSON property location

Returns:

  • (String)

4688
4689
4690
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4688

def location
  @location
end

#max_resultsFixnum

[Optional] The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies. Corresponds to the JSON property maxResults

Returns:

  • (Fixnum)

4697
4698
4699
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4697

def max_results
  @max_results
end

#maximum_bytes_billedFixnum

[Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default. Corresponds to the JSON property maximumBytesBilled

Returns:

  • (Fixnum)

4704
4705
4706
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4704

def maximum_bytes_billed
  @maximum_bytes_billed
end

#parameter_modeString

Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. Corresponds to the JSON property parameterMode

Returns:

  • (String)

4710
4711
4712
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4710

def parameter_mode
  @parameter_mode
end

#preserve_nullsBoolean Also known as: preserve_nulls?

[Deprecated] This property is deprecated. Corresponds to the JSON property preserveNulls

Returns:

  • (Boolean)

4715
4716
4717
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4715

def preserve_nulls
  @preserve_nulls
end

#queryString

[Required] A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId] ". Corresponds to the JSON property query

Returns:

  • (String)

4723
4724
4725
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4723

def query
  @query
end

#query_parametersArray<Google::Apis::BigqueryV2::QueryParameter>

Query parameters for Standard SQL queries. Corresponds to the JSON property queryParameters


4728
4729
4730
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4728

def query_parameters
  @query_parameters
end

#request_idString

A unique user provided identifier to ensure idempotent behavior for queries. Note that this is different from the job_id. It has the following properties:

  1. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is recommended. 2. Read only queries can ignore this token since they are nullipotent by definition. 3. For the purposes of idempotency ensured by the request_id, a request is considered duplicate of another only if they have the same request_id and are actually duplicates. When determining whether a request is a duplicate of the previous request, all parameters in the request that may affect the behavior are considered. For example, query, connection_properties, query_parameters, use_legacy_sql are parameters that affect the result and are considered when determining whether a request is a duplicate, but properties like timeout_ms don't affect the result and are thus not considered. Dry run query requests are never considered duplicate of another request. 4. When a duplicate mutating query request is detected, it returns: a. the results of the mutation if it completes successfully within the timeout. b. the running operation if it is still in progress at the end of the timeout. 5. Its lifetime is limited to 15 minutes. In other words, if two requests are sent with the same request_id, but more than 15 minutes apart, idempotency is not guaranteed. Corresponds to the JSON property requestId

Returns:

  • (String)

4751
4752
4753
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4751

def request_id
  @request_id
end

#timeout_msFixnum

[Optional] How long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the 'jobComplete' flag set to false. You can call GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds). Corresponds to the JSON property timeoutMs

Returns:

  • (Fixnum)

4761
4762
4763
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4761

def timeout_ms
  @timeout_ms
end

#use_legacy_sqlBoolean Also known as: use_legacy_sql?

Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false. Corresponds to the JSON property useLegacySql

Returns:

  • (Boolean)

4770
4771
4772
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4770

def use_legacy_sql
  @use_legacy_sql
end

#use_query_cacheBoolean Also known as: use_query_cache?

[Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true. Corresponds to the JSON property useQueryCache

Returns:

  • (Boolean)

4778
4779
4780
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4778

def use_query_cache
  @use_query_cache
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4786

def update!(**args)
  @connection_properties = args[:connection_properties] if args.key?(:connection_properties)
  @default_dataset = args[:default_dataset] if args.key?(:default_dataset)
  @dry_run = args[:dry_run] if args.key?(:dry_run)
  @kind = args[:kind] if args.key?(:kind)
  @labels = args[:labels] if args.key?(:labels)
  @location = args[:location] if args.key?(:location)
  @max_results = args[:max_results] if args.key?(:max_results)
  @maximum_bytes_billed = args[:maximum_bytes_billed] if args.key?(:maximum_bytes_billed)
  @parameter_mode = args[:parameter_mode] if args.key?(:parameter_mode)
  @preserve_nulls = args[:preserve_nulls] if args.key?(:preserve_nulls)
  @query = args[:query] if args.key?(:query)
  @query_parameters = args[:query_parameters] if args.key?(:query_parameters)
  @request_id = args[:request_id] if args.key?(:request_id)
  @timeout_ms = args[:timeout_ms] if args.key?(:timeout_ms)
  @use_legacy_sql = args[:use_legacy_sql] if args.key?(:use_legacy_sql)
  @use_query_cache = args[:use_query_cache] if args.key?(:use_query_cache)
end