BigQuery Storage API - Module Google::Cloud::Bigquery::Storage (v1.6.0)

Reference documentation and code samples for the BigQuery Storage API module Google::Cloud::Bigquery::Storage.

Methods

.big_query_read

def self.big_query_read(version: :v1, &block) -> ::Object

Create a new client object for BigQueryRead.

By default, this returns an instance of Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the BigQueryRead service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

Raises an exception if the currently installed versioned client gem for the given API version does not support the BigQueryRead service. You can determine whether the method will succeed by calling Storage.big_query_read_available?.

About BigQueryRead

BigQuery Read API.

The Read API can be used to read data from BigQuery.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.big_query_read_available?

def self.big_query_read_available?(version: :v1) -> boolean

Determines whether the BigQueryRead service is supported by the current client. If true, you can retrieve a client object by calling Storage.big_query_read. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the BigQueryRead service, or if the versioned client gem needs an update to support the BigQueryRead service.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (boolean) — Whether the service is available.

.big_query_write

def self.big_query_write(version: :v1, &block) -> ::Object

Create a new client object for BigQueryWrite.

By default, this returns an instance of Google::Cloud::Bigquery::Storage::V1::BigQueryWrite::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the BigQueryWrite service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

Raises an exception if the currently installed versioned client gem for the given API version does not support the BigQueryWrite service. You can determine whether the method will succeed by calling Storage.big_query_write_available?.

About BigQueryWrite

BigQuery Write API.

The Write API can be used to write data to BigQuery.

For supplementary information about the Write API, see: https://cloud.google.com/bigquery/docs/write-api

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (::Object) — A client object for the specified version.

.big_query_write_available?

def self.big_query_write_available?(version: :v1) -> boolean

Determines whether the BigQueryWrite service is supported by the current client. If true, you can retrieve a client object by calling Storage.big_query_write. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the BigQueryWrite service, or if the versioned client gem needs an update to support the BigQueryWrite service.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (boolean) — Whether the service is available.

.configure

def self.configure() -> ::Google::Cloud::Config

Configure the google-cloud-bigquery-storage library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.
Yields
  • (::Google::Cloud.configure.bigquery_storage)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

Constants

VERSION

value: "1.6.0"