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.



5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
 
# File 'lib/models/porcelain.rb', line 5702

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.



5672
5673
5674
 
# File 'lib/models/porcelain.rb', line 5672

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.



5674
5675
5676
 
# File 'lib/models/porcelain.rb', line 5674

def bind_interface
  @bind_interface
end

#default_path ⇒ Object

Automatically redirect to this path upon connecting.



5676
5677
5678
 
# File 'lib/models/porcelain.rb', line 5676

def default_path
  @default_path
end

#egress_filter ⇒ Object

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



5678
5679
5680
 
# File 'lib/models/porcelain.rb', line 5678

def egress_filter
  @egress_filter
end

#headers_blacklist ⇒ Object

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



5680
5681
5682
 
# File 'lib/models/porcelain.rb', line 5680

def headers_blacklist
  @headers_blacklist
end

#healthcheck_path ⇒ Object

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



5682
5683
5684
 
# File 'lib/models/porcelain.rb', line 5682

def healthcheck_path
  @healthcheck_path
end

#healthy ⇒ Object

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



5684
5685
5686
 
# File 'lib/models/porcelain.rb', line 5684

def healthy
  @healthy
end

#host_override ⇒ Object

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



5686
5687
5688
 
# File 'lib/models/porcelain.rb', line 5686

def host_override
  @host_override
end

#id ⇒ Object

Unique identifier of the Resource.



5688
5689
5690
 
# File 'lib/models/porcelain.rb', line 5688

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



5690
5691
5692
 
# File 'lib/models/porcelain.rb', line 5690

def name
  @name
end

#proxy_cluster_id ⇒ Object

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



5692
5693
5694
 
# File 'lib/models/porcelain.rb', line 5692

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



5694
5695
5696
 
# File 'lib/models/porcelain.rb', line 5694

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)



5696
5697
5698
 
# File 'lib/models/porcelain.rb', line 5696

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



5698
5699
5700
 
# File 'lib/models/porcelain.rb', line 5698

def tags
  @tags
end

#url ⇒ Object

The base address of your website without the path.



5700
5701
5702
 
# File 'lib/models/porcelain.rb', line 5700

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



5736
5737
5738
5739
5740
5741
5742
 
# File 'lib/models/porcelain.rb', line 5736

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