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.



7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
 
# File 'lib/models/porcelain.rb', line 7770

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.



7738
7739
7740
 
# File 'lib/models/porcelain.rb', line 7738

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 and may also be set to one of the ResourceIPAllocationMode constants to select between VNM, loopback, or default allocation.



7740
7741
7742
 
# File 'lib/models/porcelain.rb', line 7740

def bind_interface
  @bind_interface
end

#default_path ⇒ Object

Automatically redirect to this path upon connecting.



7742
7743
7744
 
# File 'lib/models/porcelain.rb', line 7742

def default_path
  @default_path
end

#egress_filter ⇒ Object

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



7744
7745
7746
 
# File 'lib/models/porcelain.rb', line 7744

def egress_filter
  @egress_filter
end

#headers_blacklist ⇒ Object

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



7746
7747
7748
 
# File 'lib/models/porcelain.rb', line 7746

def headers_blacklist
  @headers_blacklist
end

#healthcheck_path ⇒ Object

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



7748
7749
7750
 
# File 'lib/models/porcelain.rb', line 7748

def healthcheck_path
  @healthcheck_path
end

#healthy ⇒ Object

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



7750
7751
7752
 
# File 'lib/models/porcelain.rb', line 7750

def healthy
  @healthy
end

#host_override ⇒ Object

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



7752
7753
7754
 
# File 'lib/models/porcelain.rb', line 7752

def host_override
  @host_override
end

#id ⇒ Object

Unique identifier of the Resource.



7754
7755
7756
 
# File 'lib/models/porcelain.rb', line 7754

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



7756
7757
7758
 
# File 'lib/models/porcelain.rb', line 7756

def name
  @name
end

#port_override ⇒ Object

The local port used by clients to connect to this resource. It is automatically generated if not provided on create and may be re-generated on update by specifying a value of -1.



7758
7759
7760
 
# File 'lib/models/porcelain.rb', line 7758

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



7760
7761
7762
 
# File 'lib/models/porcelain.rb', line 7760

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



7762
7763
7764
 
# File 'lib/models/porcelain.rb', line 7762

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)



7764
7765
7766
 
# File 'lib/models/porcelain.rb', line 7764

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



7766
7767
7768
 
# File 'lib/models/porcelain.rb', line 7766

def tags
  @tags
end

#url ⇒ Object

The base address of your website without the path.



7768
7769
7770
 
# File 'lib/models/porcelain.rb', line 7768

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



7806
7807
7808
7809
7810
7811
7812
 
# File 'lib/models/porcelain.rb', line 7806

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