Class: SDM::HTTPBasicAuth

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, custom_headers: nil, default_path: nil, egress_filter: nil, headers_blacklist: nil, healthcheck_path: nil, healthy: nil, host_override: nil, id: nil, name: nil, password: nil, port_override: nil, proxy_cluster_id: nil, secret_store_id: nil, subdomain: nil, tags: nil, url: nil, username: nil) ⇒ HTTPBasicAuth

Returns a new instance of HTTPBasicAuth.



8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
 
# File 'lib/models/porcelain.rb', line 8472

def initialize(
  bind_interface: nil,
  custom_headers: nil,
  default_path: nil,
  egress_filter: nil,
  headers_blacklist: nil,
  healthcheck_path: nil,
  healthy: nil,
  host_override: nil,
  id: nil,
  name: nil,
  password: nil,
  port_override: nil,
  proxy_cluster_id: nil,
  secret_store_id: nil,
  subdomain: nil,
  tags: nil,
  url: nil,
  username: nil
)
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @custom_headers = custom_headers == nil ? nil : custom_headers
  @default_path = default_path == nil ? "" : default_path
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @headers_blacklist = headers_blacklist == nil ? "" : headers_blacklist
  @healthcheck_path = healthcheck_path == nil ? "" : healthcheck_path
  @healthy = healthy == nil ? false : healthy
  @host_override = host_override == nil ? "" : host_override
  @id = id == nil ? "" : id
  @name = name == nil ? "" : name
  @password = password == nil ? "" : password
  @port_override = port_override == nil ? 0 : port_override
  @proxy_cluster_id = proxy_cluster_id == nil ? "" : proxy_cluster_id
  @secret_store_id = secret_store_id == nil ? "" : secret_store_id
  @subdomain = subdomain == nil ? "" : subdomain
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
  @url = url == nil ? "" : url
  @username = username == nil ? "" : username
end

Instance Attribute Details

#bind_interface ⇒ Object

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 and may also be set to one of the ResourceIPAllocationMode constants to select between VNM, loopback, or default allocation.



8436
8437
8438
 
# File 'lib/models/porcelain.rb', line 8436

def bind_interface
  @bind_interface
end

#custom_headers ⇒ Object

Additional HTTP headers to include in requests.



8438
8439
8440
 
# File 'lib/models/porcelain.rb', line 8438

def custom_headers
  @custom_headers
end

#default_path ⇒ Object

Automatically redirect to this path upon connecting.



8440
8441
8442
 
# File 'lib/models/porcelain.rb', line 8440

def default_path
  @default_path
end

#egress_filter ⇒ Object

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



8442
8443
8444
 
# File 'lib/models/porcelain.rb', line 8442

def egress_filter
  @egress_filter
end

#headers_blacklist ⇒ Object

Header names (e.g. Authorization), to omit from logs.



8444
8445
8446
 
# File 'lib/models/porcelain.rb', line 8444

def headers_blacklist
  @headers_blacklist
end

#healthcheck_path ⇒ Object

This path will be used to check the health of your site.



8446
8447
8448
 
# File 'lib/models/porcelain.rb', line 8446

def healthcheck_path
  @healthcheck_path
end

#healthy ⇒ Object

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



8448
8449
8450
 
# File 'lib/models/porcelain.rb', line 8448

def healthy
  @healthy
end

#host_override ⇒ Object

The host header will be overwritten with this field if provided.



8450
8451
8452
 
# File 'lib/models/porcelain.rb', line 8450

def host_override
  @host_override
end

#id ⇒ Object

Unique identifier of the Resource.



8452
8453
8454
 
# File 'lib/models/porcelain.rb', line 8452

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



8454
8455
8456
 
# File 'lib/models/porcelain.rb', line 8454

def name
  @name
end

#password ⇒ Object

The password to authenticate with.



8456
8457
8458
 
# File 'lib/models/porcelain.rb', line 8456

def password
  @password
end

#port_override ⇒ Object

The local port used by clients to connect to this resource. It is automatically generated if not provided on create and may be re-generated on update by specifying a value of -1.



8458
8459
8460
 
# File 'lib/models/porcelain.rb', line 8458

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

ID of the proxy cluster for this resource, if any.



8460
8461
8462
 
# File 'lib/models/porcelain.rb', line 8460

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



8462
8463
8464
 
# File 'lib/models/porcelain.rb', line 8462

def secret_store_id
  @secret_store_id
end

#subdomain ⇒ Object

Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)



8464
8465
8466
 
# File 'lib/models/porcelain.rb', line 8464

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



8466
8467
8468
 
# File 'lib/models/porcelain.rb', line 8466

def tags
  @tags
end

#url ⇒ Object

The base address of your website without the path.



8468
8469
8470
 
# File 'lib/models/porcelain.rb', line 8468

def url
  @url
end

#username ⇒ Object

The username to authenticate with.



8470
8471
8472
 
# File 'lib/models/porcelain.rb', line 8470

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



8512
8513
8514
8515
8516
8517
8518
 
# File 'lib/models/porcelain.rb', line 8512

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