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.



3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
# File 'lib/models/porcelain.rb', line 3790

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_interfaceObject

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.



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

def bind_interface
  @bind_interface
end

#databaseObject

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



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

def database
  @database
end

#egress_filterObject

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



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

def egress_filter
  @egress_filter
end

#healthyObject

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



3766
3767
3768
# File 'lib/models/porcelain.rb', line 3766

def healthy
  @healthy
end

#hostnameObject

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



3768
3769
3770
# File 'lib/models/porcelain.rb', line 3768

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



3770
3771
3772
# File 'lib/models/porcelain.rb', line 3770

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



3772
3773
3774
# File 'lib/models/porcelain.rb', line 3772

def name
  @name
end

#override_databaseObject

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.



3774
3775
3776
# File 'lib/models/porcelain.rb', line 3774

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



3776
3777
3778
# File 'lib/models/porcelain.rb', line 3776

def password
  @password
end

#portObject

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



3778
3779
3780
# File 'lib/models/porcelain.rb', line 3778

def port
  @port
end

#port_overrideObject

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



3780
3781
3782
# File 'lib/models/porcelain.rb', line 3780

def port_override
  @port_override
end

#secret_store_idObject

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



3782
3783
3784
# File 'lib/models/porcelain.rb', line 3782

def secret_store_id
  @secret_store_id
end

#subdomainObject

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



3784
3785
3786
# File 'lib/models/porcelain.rb', line 3784

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



3786
3787
3788
# File 'lib/models/porcelain.rb', line 3786

def tags
  @tags
end

#usernameObject

The username to authenticate with.



3788
3789
3790
# File 'lib/models/porcelain.rb', line 3788

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



3824
3825
3826
3827
3828
3829
3830
# File 'lib/models/porcelain.rb', line 3824

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