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.



3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
# File 'lib/models/porcelain.rb', line 3064

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.



3034
3035
3036
# File 'lib/models/porcelain.rb', line 3034

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.



3036
3037
3038
# File 'lib/models/porcelain.rb', line 3036

def database
  @database
end

#egress_filterObject

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



3038
3039
3040
# File 'lib/models/porcelain.rb', line 3038

def egress_filter
  @egress_filter
end

#healthyObject

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



3040
3041
3042
# File 'lib/models/porcelain.rb', line 3040

def healthy
  @healthy
end

#hostnameObject

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



3042
3043
3044
# File 'lib/models/porcelain.rb', line 3042

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



3044
3045
3046
# File 'lib/models/porcelain.rb', line 3044

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



3046
3047
3048
# File 'lib/models/porcelain.rb', line 3046

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.



3048
3049
3050
# File 'lib/models/porcelain.rb', line 3048

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



3050
3051
3052
# File 'lib/models/porcelain.rb', line 3050

def password
  @password
end

#portObject

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



3052
3053
3054
# File 'lib/models/porcelain.rb', line 3052

def port
  @port
end

#port_overrideObject

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



3054
3055
3056
# File 'lib/models/porcelain.rb', line 3054

def port_override
  @port_override
end

#secret_store_idObject

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



3056
3057
3058
# File 'lib/models/porcelain.rb', line 3056

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)



3058
3059
3060
# File 'lib/models/porcelain.rb', line 3058

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



3060
3061
3062
# File 'lib/models/porcelain.rb', line 3060

def tags
  @tags
end

#usernameObject

The username to authenticate with.



3062
3063
3064
# File 'lib/models/porcelain.rb', line 3062

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



3098
3099
3100
3101
3102
3103
3104
# File 'lib/models/porcelain.rb', line 3098

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