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.



6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
 
# File 'lib/models/porcelain.rb', line 6571

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.



6541
6542
6543
 
# File 'lib/models/porcelain.rb', line 6541

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.



6543
6544
6545
 
# File 'lib/models/porcelain.rb', line 6543

def bind_interface
  @bind_interface
end

#default_path ⇒ Object

Automatically redirect to this path upon connecting.



6545
6546
6547
 
# File 'lib/models/porcelain.rb', line 6545

def default_path
  @default_path
end

#egress_filter ⇒ Object

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



6547
6548
6549
 
# File 'lib/models/porcelain.rb', line 6547

def egress_filter
  @egress_filter
end

#headers_blacklist ⇒ Object

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



6549
6550
6551
 
# File 'lib/models/porcelain.rb', line 6549

def headers_blacklist
  @headers_blacklist
end

#healthcheck_path ⇒ Object

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



6551
6552
6553
 
# File 'lib/models/porcelain.rb', line 6551

def healthcheck_path
  @healthcheck_path
end

#healthy ⇒ Object

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



6553
6554
6555
 
# File 'lib/models/porcelain.rb', line 6553

def healthy
  @healthy
end

#host_override ⇒ Object

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



6555
6556
6557
 
# File 'lib/models/porcelain.rb', line 6555

def host_override
  @host_override
end

#id ⇒ Object

Unique identifier of the Resource.



6557
6558
6559
 
# File 'lib/models/porcelain.rb', line 6557

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



6559
6560
6561
 
# File 'lib/models/porcelain.rb', line 6559

def name
  @name
end

#proxy_cluster_id ⇒ Object

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



6561
6562
6563
 
# File 'lib/models/porcelain.rb', line 6561

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



6563
6564
6565
 
# File 'lib/models/porcelain.rb', line 6563

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)



6565
6566
6567
 
# File 'lib/models/porcelain.rb', line 6565

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



6567
6568
6569
 
# File 'lib/models/porcelain.rb', line 6567

def tags
  @tags
end

#url ⇒ Object

The base address of your website without the path.



6569
6570
6571
 
# File 'lib/models/porcelain.rb', line 6569

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



6605
6606
6607
6608
6609
6610
6611
 
# File 'lib/models/porcelain.rb', line 6605

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