Class: SDM::HTTPAuth

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(auth_header: nil, bind_interface: nil, default_path: nil, egress_filter: nil, headers_blacklist: nil, healthcheck_path: nil, healthy: nil, host_override: nil, id: nil, name: nil, proxy_cluster_id: nil, secret_store_id: nil, subdomain: nil, tags: nil, url: nil) ⇒ HTTPAuth

Returns a new instance of HTTPAuth.



6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
 
# File 'lib/models/porcelain.rb', line 6435

def initialize(
  auth_header: nil,
  bind_interface: nil,
  default_path: nil,
  egress_filter: nil,
  headers_blacklist: nil,
  healthcheck_path: nil,
  healthy: nil,
  host_override: nil,
  id: nil,
  name: nil,
  proxy_cluster_id: nil,
  secret_store_id: nil,
  subdomain: nil,
  tags: nil,
  url: nil
)
  @auth_header = auth_header == nil ? "" : auth_header
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @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
  @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
end

Instance Attribute Details

#auth_header ⇒ Object

The content to set as the authorization header.



6405
6406
6407
 
# File 'lib/models/porcelain.rb', line 6405

def auth_header
  @auth_header
end

#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.



6407
6408
6409
 
# File 'lib/models/porcelain.rb', line 6407

def bind_interface
  @bind_interface
end

#default_path ⇒ Object

Automatically redirect to this path upon connecting.



6409
6410
6411
 
# File 'lib/models/porcelain.rb', line 6409

def default_path
  @default_path
end

#egress_filter ⇒ Object

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



6411
6412
6413
 
# File 'lib/models/porcelain.rb', line 6411

def egress_filter
  @egress_filter
end

#headers_blacklist ⇒ Object

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



6413
6414
6415
 
# File 'lib/models/porcelain.rb', line 6413

def headers_blacklist
  @headers_blacklist
end

#healthcheck_path ⇒ Object

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



6415
6416
6417
 
# File 'lib/models/porcelain.rb', line 6415

def healthcheck_path
  @healthcheck_path
end

#healthy ⇒ Object

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



6417
6418
6419
 
# File 'lib/models/porcelain.rb', line 6417

def healthy
  @healthy
end

#host_override ⇒ Object

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



6419
6420
6421
 
# File 'lib/models/porcelain.rb', line 6419

def host_override
  @host_override
end

#id ⇒ Object

Unique identifier of the Resource.



6421
6422
6423
 
# File 'lib/models/porcelain.rb', line 6421

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



6423
6424
6425
 
# File 'lib/models/porcelain.rb', line 6423

def name
  @name
end

#proxy_cluster_id ⇒ Object

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



6425
6426
6427
 
# File 'lib/models/porcelain.rb', line 6425

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



6427
6428
6429
 
# File 'lib/models/porcelain.rb', line 6427

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)



6429
6430
6431
 
# File 'lib/models/porcelain.rb', line 6429

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



6431
6432
6433
 
# File 'lib/models/porcelain.rb', line 6431

def tags
  @tags
end

#url ⇒ Object

The base address of your website without the path.



6433
6434
6435
 
# File 'lib/models/porcelain.rb', line 6433

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



6469
6470
6471
6472
6473
6474
6475
 
# File 'lib/models/porcelain.rb', line 6469

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