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.



3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
# File 'lib/models/porcelain.rb', line 3028

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.



2998
2999
3000
# File 'lib/models/porcelain.rb', line 2998

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.



3000
3001
3002
# File 'lib/models/porcelain.rb', line 3000

def database
  @database
end

#egress_filterObject

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



3002
3003
3004
# File 'lib/models/porcelain.rb', line 3002

def egress_filter
  @egress_filter
end

#healthyObject

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



3004
3005
3006
# File 'lib/models/porcelain.rb', line 3004

def healthy
  @healthy
end

#hostnameObject

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



3006
3007
3008
# File 'lib/models/porcelain.rb', line 3006

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



3008
3009
3010
# File 'lib/models/porcelain.rb', line 3008

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



3010
3011
3012
# File 'lib/models/porcelain.rb', line 3010

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.



3012
3013
3014
# File 'lib/models/porcelain.rb', line 3012

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



3014
3015
3016
# File 'lib/models/porcelain.rb', line 3014

def password
  @password
end

#portObject

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



3016
3017
3018
# File 'lib/models/porcelain.rb', line 3016

def port
  @port
end

#port_overrideObject

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



3018
3019
3020
# File 'lib/models/porcelain.rb', line 3018

def port_override
  @port_override
end

#secret_store_idObject

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



3020
3021
3022
# File 'lib/models/porcelain.rb', line 3020

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)



3022
3023
3024
# File 'lib/models/porcelain.rb', line 3022

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



3024
3025
3026
# File 'lib/models/porcelain.rb', line 3024

def tags
  @tags
end

#usernameObject

The username to authenticate with.



3026
3027
3028
# File 'lib/models/porcelain.rb', line 3026

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



3062
3063
3064
3065
3066
3067
3068
# File 'lib/models/porcelain.rb', line 3062

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