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.



6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
 
# File 'lib/models/porcelain.rb', line 6908

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.



6876
6877
6878
 
# File 'lib/models/porcelain.rb', line 6876

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.



6878
6879
6880
 
# File 'lib/models/porcelain.rb', line 6878

def bind_interface
  @bind_interface
end

#default_path ⇒ Object

Automatically redirect to this path upon connecting.



6880
6881
6882
 
# File 'lib/models/porcelain.rb', line 6880

def default_path
  @default_path
end

#egress_filter ⇒ Object

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



6882
6883
6884
 
# File 'lib/models/porcelain.rb', line 6882

def egress_filter
  @egress_filter
end

#headers_blacklist ⇒ Object

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



6884
6885
6886
 
# File 'lib/models/porcelain.rb', line 6884

def headers_blacklist
  @headers_blacklist
end

#healthcheck_path ⇒ Object

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



6886
6887
6888
 
# File 'lib/models/porcelain.rb', line 6886

def healthcheck_path
  @healthcheck_path
end

#healthy ⇒ Object

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



6888
6889
6890
 
# File 'lib/models/porcelain.rb', line 6888

def healthy
  @healthy
end

#host_override ⇒ Object

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



6890
6891
6892
 
# File 'lib/models/porcelain.rb', line 6890

def host_override
  @host_override
end

#id ⇒ Object

Unique identifier of the Resource.



6892
6893
6894
 
# File 'lib/models/porcelain.rb', line 6892

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



6894
6895
6896
 
# File 'lib/models/porcelain.rb', line 6894

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.



6896
6897
6898
 
# File 'lib/models/porcelain.rb', line 6896

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



6898
6899
6900
 
# File 'lib/models/porcelain.rb', line 6898

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



6900
6901
6902
 
# File 'lib/models/porcelain.rb', line 6900

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)



6902
6903
6904
 
# File 'lib/models/porcelain.rb', line 6902

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



6904
6905
6906
 
# File 'lib/models/porcelain.rb', line 6904

def tags
  @tags
end

#url ⇒ Object

The base address of your website without the path.



6906
6907
6908
 
# File 'lib/models/porcelain.rb', line 6906

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



6944
6945
6946
6947
6948
6949
6950
 
# File 'lib/models/porcelain.rb', line 6944

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