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, custom_headers: 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.



8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
 
# File 'lib/models/porcelain.rb', line 8875

def initialize(
  auth_header: nil,
  bind_interface: nil,
  custom_headers: 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
  @custom_headers = custom_headers == nil ? nil : custom_headers
  @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.



8841
8842
8843
 
# File 'lib/models/porcelain.rb', line 8841

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.



8843
8844
8845
 
# File 'lib/models/porcelain.rb', line 8843

def bind_interface
  @bind_interface
end

#custom_headers ⇒ Object

Additional HTTP headers to include in requests.



8845
8846
8847
 
# File 'lib/models/porcelain.rb', line 8845

def custom_headers
  @custom_headers
end

#default_path ⇒ Object

Automatically redirect to this path upon connecting.



8847
8848
8849
 
# File 'lib/models/porcelain.rb', line 8847

def default_path
  @default_path
end

#egress_filter ⇒ Object

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



8849
8850
8851
 
# File 'lib/models/porcelain.rb', line 8849

def egress_filter
  @egress_filter
end

#headers_blacklist ⇒ Object

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



8851
8852
8853
 
# File 'lib/models/porcelain.rb', line 8851

def headers_blacklist
  @headers_blacklist
end

#healthcheck_path ⇒ Object

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



8853
8854
8855
 
# File 'lib/models/porcelain.rb', line 8853

def healthcheck_path
  @healthcheck_path
end

#healthy ⇒ Object

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



8855
8856
8857
 
# File 'lib/models/porcelain.rb', line 8855

def healthy
  @healthy
end

#host_override ⇒ Object

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



8857
8858
8859
 
# File 'lib/models/porcelain.rb', line 8857

def host_override
  @host_override
end

#id ⇒ Object

Unique identifier of the Resource.



8859
8860
8861
 
# File 'lib/models/porcelain.rb', line 8859

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



8861
8862
8863
 
# File 'lib/models/porcelain.rb', line 8861

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.



8863
8864
8865
 
# File 'lib/models/porcelain.rb', line 8863

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



8865
8866
8867
 
# File 'lib/models/porcelain.rb', line 8865

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



8867
8868
8869
 
# File 'lib/models/porcelain.rb', line 8867

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)



8869
8870
8871
 
# File 'lib/models/porcelain.rb', line 8869

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



8871
8872
8873
 
# File 'lib/models/porcelain.rb', line 8871

def tags
  @tags
end

#url ⇒ Object

The base address of your website without the path.



8873
8874
8875
 
# File 'lib/models/porcelain.rb', line 8873

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



8913
8914
8915
8916
8917
8918
8919
 
# File 'lib/models/porcelain.rb', line 8913

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