Class: SDM::Citus

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) ⇒ Citus

Returns a new instance of Citus.



3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
# File 'lib/models/porcelain.rb', line 3611

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.



3581
3582
3583
# File 'lib/models/porcelain.rb', line 3581

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.



3583
3584
3585
# File 'lib/models/porcelain.rb', line 3583

def database
  @database
end

#egress_filterObject

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



3585
3586
3587
# File 'lib/models/porcelain.rb', line 3585

def egress_filter
  @egress_filter
end

#healthyObject

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



3587
3588
3589
# File 'lib/models/porcelain.rb', line 3587

def healthy
  @healthy
end

#hostnameObject

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



3589
3590
3591
# File 'lib/models/porcelain.rb', line 3589

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



3591
3592
3593
# File 'lib/models/porcelain.rb', line 3591

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



3593
3594
3595
# File 'lib/models/porcelain.rb', line 3593

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.



3595
3596
3597
# File 'lib/models/porcelain.rb', line 3595

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



3597
3598
3599
# File 'lib/models/porcelain.rb', line 3597

def password
  @password
end

#portObject

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



3599
3600
3601
# File 'lib/models/porcelain.rb', line 3599

def port
  @port
end

#port_overrideObject

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



3601
3602
3603
# File 'lib/models/porcelain.rb', line 3601

def port_override
  @port_override
end

#secret_store_idObject

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



3603
3604
3605
# File 'lib/models/porcelain.rb', line 3603

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)



3605
3606
3607
# File 'lib/models/porcelain.rb', line 3605

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



3607
3608
3609
# File 'lib/models/porcelain.rb', line 3607

def tags
  @tags
end

#usernameObject

The username to authenticate with.



3609
3610
3611
# File 'lib/models/porcelain.rb', line 3609

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



3645
3646
3647
3648
3649
3650
3651
# File 'lib/models/porcelain.rb', line 3645

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