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.



3025
3026
3027
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
# File 'lib/models/porcelain.rb', line 3025

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.



2995
2996
2997
# File 'lib/models/porcelain.rb', line 2995

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.



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

def database
  @database
end

#egress_filterObject

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



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

def egress_filter
  @egress_filter
end

#healthyObject

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



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

def healthy
  @healthy
end

#hostnameObject

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



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

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



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

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



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

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.



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

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



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

def password
  @password
end

#portObject

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



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

def port
  @port
end

#port_overrideObject

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



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

def port_override
  @port_override
end

#secret_store_idObject

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



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

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)



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

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



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

def tags
  @tags
end

#usernameObject

The username to authenticate with.



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

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



3059
3060
3061
3062
3063
3064
3065
# File 'lib/models/porcelain.rb', line 3059

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