Class: SDM::Cockroach

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bind_interface: nil, database: nil, egress_filter: nil, healthy: nil, hostname: nil, id: nil, name: nil, override_database: nil, password: nil, port: nil, port_override: nil, secret_store_id: nil, subdomain: nil, tags: nil, username: nil) ⇒ Cockroach

Returns a new instance of Cockroach.



3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
 
# File 'lib/models/porcelain.rb', line 3766

def initialize(
  bind_interface: nil,
  database: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  name: nil,
  override_database: nil,
  password: nil,
  port: nil,
  port_override: nil,
  secret_store_id: nil,
  subdomain: nil,
  tags: nil,
  username: nil
)
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @database = database == nil ? "" : database
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @healthy = healthy == nil ? false : healthy
  @hostname = hostname == nil ? "" : hostname
  @id = id == nil ? "" : id
  @name = name == nil ? "" : name
  @override_database = override_database == nil ? false : override_database
  @password = password == nil ? "" : password
  @port = port == nil ? 0 : port
  @port_override = port_override == nil ? 0 : port_override
  @secret_store_id = secret_store_id == nil ? "" : secret_store_id
  @subdomain = subdomain == nil ? "" : subdomain
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
  @username = username == nil ? "" : username
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.



3736
3737
3738
 
# File 'lib/models/porcelain.rb', line 3736

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.



3738
3739
3740
 
# File 'lib/models/porcelain.rb', line 3738

def database
  @database
end

#egress_filter ⇒ Object

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



3740
3741
3742
 
# File 'lib/models/porcelain.rb', line 3740

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



3742
3743
3744
 
# File 'lib/models/porcelain.rb', line 3742

def healthy
  @healthy
end

#hostname ⇒ Object

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



3744
3745
3746
 
# File 'lib/models/porcelain.rb', line 3744

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



3746
3747
3748
 
# File 'lib/models/porcelain.rb', line 3746

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



3748
3749
3750
 
# File 'lib/models/porcelain.rb', line 3748

def name
  @name
end

#override_database ⇒ Object

If set, the database configured cannot be changed by users. This setting is not recommended for most use cases, as some clients will insist their database has changed when it has not, leading to user confusion.



3750
3751
3752
 
# File 'lib/models/porcelain.rb', line 3750

def override_database
  @override_database
end

#password ⇒ Object

The password to authenticate with.



3752
3753
3754
 
# File 'lib/models/porcelain.rb', line 3752

def password
  @password
end

#port ⇒ Object

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



3754
3755
3756
 
# File 'lib/models/porcelain.rb', line 3754

def port
  @port
end

#port_override ⇒ Object

The local port used by clients to connect to this resource.



3756
3757
3758
 
# File 'lib/models/porcelain.rb', line 3756

def port_override
  @port_override
end

#secret_store_id ⇒ Object

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



3758
3759
3760
 
# File 'lib/models/porcelain.rb', line 3758

def secret_store_id
  @secret_store_id
end

#subdomain ⇒ Object

Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)



3760
3761
3762
 
# File 'lib/models/porcelain.rb', line 3760

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



3762
3763
3764
 
# File 'lib/models/porcelain.rb', line 3762

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



3764
3765
3766
 
# File 'lib/models/porcelain.rb', line 3764

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



3800
3801
3802
3803
3804
3805
3806
 
# File 'lib/models/porcelain.rb', line 3800

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