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.



3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
# File 'lib/models/porcelain.rb', line 3218

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.



3188
3189
3190
# File 'lib/models/porcelain.rb', line 3188

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.



3190
3191
3192
# File 'lib/models/porcelain.rb', line 3190

def database
  @database
end

#egress_filterObject

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



3192
3193
3194
# File 'lib/models/porcelain.rb', line 3192

def egress_filter
  @egress_filter
end

#healthyObject

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



3194
3195
3196
# File 'lib/models/porcelain.rb', line 3194

def healthy
  @healthy
end

#hostnameObject

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



3196
3197
3198
# File 'lib/models/porcelain.rb', line 3196

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



3198
3199
3200
# File 'lib/models/porcelain.rb', line 3198

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



3200
3201
3202
# File 'lib/models/porcelain.rb', line 3200

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.



3202
3203
3204
# File 'lib/models/porcelain.rb', line 3202

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



3204
3205
3206
# File 'lib/models/porcelain.rb', line 3204

def password
  @password
end

#portObject

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



3206
3207
3208
# File 'lib/models/porcelain.rb', line 3206

def port
  @port
end

#port_overrideObject

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



3208
3209
3210
# File 'lib/models/porcelain.rb', line 3208

def port_override
  @port_override
end

#secret_store_idObject

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



3210
3211
3212
# File 'lib/models/porcelain.rb', line 3210

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)



3212
3213
3214
# File 'lib/models/porcelain.rb', line 3212

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



3214
3215
3216
# File 'lib/models/porcelain.rb', line 3214

def tags
  @tags
end

#usernameObject

The username to authenticate with.



3216
3217
3218
# File 'lib/models/porcelain.rb', line 3216

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



3252
3253
3254
3255
3256
3257
3258
# File 'lib/models/porcelain.rb', line 3252

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