Class: Google::Apis::BigqueryconnectionV1::CloudSpannerProperties

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

Overview

Connection properties specific to Cloud Spanner.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CloudSpannerProperties

Returns a new instance of CloudSpannerProperties.



374
375
376
 
# File 'lib/google/apis/bigqueryconnection_v1/classes.rb', line 374

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

Instance Attribute Details

#database ⇒ String

Cloud Spanner database in the form project/instance/database' Corresponds to the JSON propertydatabase`

Returns:

  • (String) 


332
333
334
 
# File 'lib/google/apis/bigqueryconnection_v1/classes.rb', line 332

def database
  @database
end

#database_role ⇒ String

Optional. Cloud Spanner database role for fine-grained access control. The Cloud Spanner admin should have provisioned the database role with appropriate permissions, such as SELECT and INSERT. Other users should only use roles provided by their Cloud Spanner admins. For more details, see About fine- grained access control. REQUIRES: The database role name must start with a letter, and can only contain letters, numbers, and underscores. Corresponds to the JSON property databaseRole

Returns:

  • (String) 


343
344
345
 
# File 'lib/google/apis/bigqueryconnection_v1/classes.rb', line 343

def database_role
  @database_role
end

#max_parallelism ⇒ Fixnum

Allows setting max parallelism per query when executing on Spanner independent compute resources. If unspecified, default values of parallelism are chosen that are dependent on the Cloud Spanner instance configuration. REQUIRES: use_parallelism must be set. REQUIRES: use_data_boost must be set. Corresponds to the JSON property maxParallelism

Returns:

  • (Fixnum) 


351
352
353
 
# File 'lib/google/apis/bigqueryconnection_v1/classes.rb', line 351

def max_parallelism
  @max_parallelism
end

#use_data_boost ⇒ Boolean Also known as: use_data_boost?

If set, the request will be executed via Spanner independent compute resources. REQUIRES: use_parallelism must be set. Corresponds to the JSON property useDataBoost

Returns:

  • (Boolean) 


357
358
359
 
# File 'lib/google/apis/bigqueryconnection_v1/classes.rb', line 357

def use_data_boost
  @use_data_boost
end

#use_parallelism ⇒ Boolean Also known as: use_parallelism?

If parallelism should be used when reading from Cloud Spanner Corresponds to the JSON property useParallelism

Returns:

  • (Boolean) 


363
364
365
 
# File 'lib/google/apis/bigqueryconnection_v1/classes.rb', line 363

def use_parallelism
  @use_parallelism
end

#use_serverless_analytics ⇒ Boolean Also known as: use_serverless_analytics?

Deprecated: prefer use_data_boost instead. If the serverless analytics service should be used to read data from Cloud Spanner. Note: use_parallelism must be set when using serverless analytics. Corresponds to the JSON property useServerlessAnalytics

Returns:

  • (Boolean) 


371
372
373
 
# File 'lib/google/apis/bigqueryconnection_v1/classes.rb', line 371

def use_serverless_analytics
  @use_serverless_analytics
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



379
380
381
382
383
384
385
386
 
# File 'lib/google/apis/bigqueryconnection_v1/classes.rb', line 379

def update!(**args)
  @database = args[:database] if args.key?(:database)
  @database_role = args[:database_role] if args.key?(:database_role)
  @max_parallelism = args[:max_parallelism] if args.key?(:max_parallelism)
  @use_data_boost = args[:use_data_boost] if args.key?(:use_data_boost)
  @use_parallelism = args[:use_parallelism] if args.key?(:use_parallelism)
  @use_serverless_analytics = args[:use_serverless_analytics] if args.key?(:use_serverless_analytics)
end