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.



6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
 
# File 'lib/models/porcelain.rb', line 6503

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.



6473
6474
6475
 
# File 'lib/models/porcelain.rb', line 6473

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.



6475
6476
6477
 
# File 'lib/models/porcelain.rb', line 6475

def bind_interface
  @bind_interface
end

#default_path ⇒ Object

Automatically redirect to this path upon connecting.



6477
6478
6479
 
# File 'lib/models/porcelain.rb', line 6477

def default_path
  @default_path
end

#egress_filter ⇒ Object

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



6479
6480
6481
 
# File 'lib/models/porcelain.rb', line 6479

def egress_filter
  @egress_filter
end

#headers_blacklist ⇒ Object

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



6481
6482
6483
 
# File 'lib/models/porcelain.rb', line 6481

def headers_blacklist
  @headers_blacklist
end

#healthcheck_path ⇒ Object

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



6483
6484
6485
 
# File 'lib/models/porcelain.rb', line 6483

def healthcheck_path
  @healthcheck_path
end

#healthy ⇒ Object

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



6485
6486
6487
 
# File 'lib/models/porcelain.rb', line 6485

def healthy
  @healthy
end

#host_override ⇒ Object

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



6487
6488
6489
 
# File 'lib/models/porcelain.rb', line 6487

def host_override
  @host_override
end

#id ⇒ Object

Unique identifier of the Resource.



6489
6490
6491
 
# File 'lib/models/porcelain.rb', line 6489

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



6491
6492
6493
 
# File 'lib/models/porcelain.rb', line 6491

def name
  @name
end

#proxy_cluster_id ⇒ Object

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



6493
6494
6495
 
# File 'lib/models/porcelain.rb', line 6493

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



6495
6496
6497
 
# File 'lib/models/porcelain.rb', line 6495

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)



6497
6498
6499
 
# File 'lib/models/porcelain.rb', line 6497

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



6499
6500
6501
 
# File 'lib/models/porcelain.rb', line 6499

def tags
  @tags
end

#url ⇒ Object

The base address of your website without the path.



6501
6502
6503
 
# File 'lib/models/porcelain.rb', line 6501

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



6537
6538
6539
6540
6541
6542
6543
 
# File 'lib/models/porcelain.rb', line 6537

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