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, port_override: nil, proxy_cluster_id: nil, secret_store_id: nil, subdomain: nil, tags: nil, url: nil) ⇒ HTTPAuth

Returns a new instance of HTTPAuth.



6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
 
# File 'lib/models/porcelain.rb', line 6735

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,
  port_override: 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
  @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
end

Instance Attribute Details

#auth_header ⇒ Object

The content to set as the authorization header.



6703
6704
6705
 
# File 'lib/models/porcelain.rb', line 6703

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.



6705
6706
6707
 
# File 'lib/models/porcelain.rb', line 6705

def bind_interface
  @bind_interface
end

#default_path ⇒ Object

Automatically redirect to this path upon connecting.



6707
6708
6709
 
# File 'lib/models/porcelain.rb', line 6707

def default_path
  @default_path
end

#egress_filter ⇒ Object

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



6709
6710
6711
 
# File 'lib/models/porcelain.rb', line 6709

def egress_filter
  @egress_filter
end

#headers_blacklist ⇒ Object

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



6711
6712
6713
 
# File 'lib/models/porcelain.rb', line 6711

def headers_blacklist
  @headers_blacklist
end

#healthcheck_path ⇒ Object

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



6713
6714
6715
 
# File 'lib/models/porcelain.rb', line 6713

def healthcheck_path
  @healthcheck_path
end

#healthy ⇒ Object

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



6715
6716
6717
 
# File 'lib/models/porcelain.rb', line 6715

def healthy
  @healthy
end

#host_override ⇒ Object

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



6717
6718
6719
 
# File 'lib/models/porcelain.rb', line 6717

def host_override
  @host_override
end

#id ⇒ Object

Unique identifier of the Resource.



6719
6720
6721
 
# File 'lib/models/porcelain.rb', line 6719

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



6721
6722
6723
 
# File 'lib/models/porcelain.rb', line 6721

def name
  @name
end

#port_override ⇒ Object

The local port used by clients to connect to this resource.



6723
6724
6725
 
# File 'lib/models/porcelain.rb', line 6723

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



6725
6726
6727
 
# File 'lib/models/porcelain.rb', line 6725

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



6727
6728
6729
 
# File 'lib/models/porcelain.rb', line 6727

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)



6729
6730
6731
 
# File 'lib/models/porcelain.rb', line 6729

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



6731
6732
6733
 
# File 'lib/models/porcelain.rb', line 6731

def tags
  @tags
end

#url ⇒ Object

The base address of your website without the path.



6733
6734
6735
 
# File 'lib/models/porcelain.rb', line 6733

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



6771
6772
6773
6774
6775
6776
6777
 
# File 'lib/models/porcelain.rb', line 6771

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