Class: SDM::GoogleSpanner

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

Overview

GoogleSpanner is currently unstable, and its API may change, or it may be removed, without a major version bump.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bind_interface: nil, database: nil, egress_filter: nil, endpoint: nil, healthy: nil, id: nil, instance: nil, name: nil, port: nil, port_override: nil, project: nil, proxy_cluster_id: nil, secret_store_id: nil, service_account_to_impersonate: nil, subdomain: nil, tags: nil) ⇒ GoogleSpanner

Returns a new instance of GoogleSpanner.



7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
 
# File 'lib/models/porcelain.rb', line 7609

def initialize(
  bind_interface: nil,
  database: nil,
  egress_filter: nil,
  endpoint: nil,
  healthy: nil,
  id: nil,
  instance: nil,
  name: nil,
  port: nil,
  port_override: nil,
  project: nil,
  proxy_cluster_id: nil,
  secret_store_id: nil,
  service_account_to_impersonate: nil,
  subdomain: nil,
  tags: nil
)
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @database = database == nil ? "" : database
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @endpoint = endpoint == nil ? "" : endpoint
  @healthy = healthy == nil ? false : healthy
  @id = id == nil ? "" : id
  @instance = instance == nil ? "" : instance
  @name = name == nil ? "" : name
  @port = port == nil ? 0 : port
  @port_override = port_override == nil ? 0 : port_override
  @project = project == nil ? "" : project
  @proxy_cluster_id = proxy_cluster_id == nil ? "" : proxy_cluster_id
  @secret_store_id = secret_store_id == nil ? "" : secret_store_id
  @service_account_to_impersonate =  == nil ? "" : 
  @subdomain = subdomain == nil ? "" : subdomain
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
end

Instance Attribute Details

#bind_interface ⇒ Object

The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided and may also be set to one of the ResourceIPAllocationMode constants to select between VNM, loopback, or default allocation.



7574
7575
7576
 
# File 'lib/models/porcelain.rb', line 7574

def bind_interface
  @bind_interface
end

#database ⇒ Object

The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.



7576
7577
7578
 
# File 'lib/models/porcelain.rb', line 7576

def database
  @database
end

#egress_filter ⇒ Object

A filter applied to the routing logic to pin datasource to nodes.



7578
7579
7580
 
# File 'lib/models/porcelain.rb', line 7578

def egress_filter
  @egress_filter
end

#endpoint ⇒ Object

The endpoint to dial e.g. spanner.googleapis.com



7580
7581
7582
 
# File 'lib/models/porcelain.rb', line 7580

def endpoint
  @endpoint
end

#healthy ⇒ Object

True if the datasource is reachable and the credentials are valid.



7582
7583
7584
 
# File 'lib/models/porcelain.rb', line 7582

def healthy
  @healthy
end

#id ⇒ Object

Unique identifier of the Resource.



7584
7585
7586
 
# File 'lib/models/porcelain.rb', line 7584

def id
  @id
end

#instance ⇒ Object

The Spanner instance ID within the GCP project.



7586
7587
7588
 
# File 'lib/models/porcelain.rb', line 7586

def instance
  @instance
end

#name ⇒ Object

Unique human-readable name of the Resource.



7588
7589
7590
 
# File 'lib/models/porcelain.rb', line 7588

def name
  @name
end

#port ⇒ Object

The port to dial to initiate a connection from the egress node to this resource.



7590
7591
7592
 
# File 'lib/models/porcelain.rb', line 7590

def port
  @port
end

#port_override ⇒ Object

The local port used by clients to connect to this resource. It is automatically generated if not provided on create and may be re-generated on update by specifying a value of -1.



7592
7593
7594
 
# File 'lib/models/porcelain.rb', line 7592

def port_override
  @port_override
end

#project ⇒ Object

The GCP project ID containing the Spanner database.



7594
7595
7596
 
# File 'lib/models/porcelain.rb', line 7594

def project
  @project
end

#proxy_cluster_id ⇒ Object

ID of the proxy cluster for this resource, if any.



7596
7597
7598
 
# File 'lib/models/porcelain.rb', line 7596

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

ID of the secret store containing credentials for this resource, if any.



7598
7599
7600
 
# File 'lib/models/porcelain.rb', line 7598

def secret_store_id
  @secret_store_id
end

#service_account_to_impersonate ⇒ Object

Optional service account email to impersonate. When set, the relay's Application Default Credentials will impersonate this service account to access Spanner. This allows role separation where the relay uses one service account but operates as another.



7603
7604
7605
 
# File 'lib/models/porcelain.rb', line 7603

def 
  @service_account_to_impersonate
end

#subdomain ⇒ Object

DNS subdomain through which this resource may be accessed on clients. (e.g. "app-prod1" allows the resource to be accessed at "app-prod1.your-org-name.sdm-proxy-domain"). Only applicable to HTTP-based resources or resources using virtual networking mode.



7605
7606
7607
 
# File 'lib/models/porcelain.rb', line 7605

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



7607
7608
7609
 
# File 'lib/models/porcelain.rb', line 7607

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



7645
7646
7647
7648
7649
7650
7651
 
# File 'lib/models/porcelain.rb', line 7645

def to_json(options = {})
  hash = {}
  self.instance_variables.each do |var|
    hash[var.id2name.delete_prefix("@")] = self.instance_variable_get var
  end
  hash.to_json
end