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

Returns a new instance of HTTPAuth.



5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
# File 'lib/models/porcelain.rb', line 5064

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,
  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
  @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_headerObject

The content to set as the authorization header.



5036
5037
5038
# File 'lib/models/porcelain.rb', line 5036

def auth_header
  @auth_header
end

#bind_interfaceObject

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.



5038
5039
5040
# File 'lib/models/porcelain.rb', line 5038

def bind_interface
  @bind_interface
end

#default_pathObject

Automatically redirect to this path upon connecting.



5040
5041
5042
# File 'lib/models/porcelain.rb', line 5040

def default_path
  @default_path
end

#egress_filterObject

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



5042
5043
5044
# File 'lib/models/porcelain.rb', line 5042

def egress_filter
  @egress_filter
end

#headers_blacklistObject

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



5044
5045
5046
# File 'lib/models/porcelain.rb', line 5044

def headers_blacklist
  @headers_blacklist
end

#healthcheck_pathObject

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



5046
5047
5048
# File 'lib/models/porcelain.rb', line 5046

def healthcheck_path
  @healthcheck_path
end

#healthyObject

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



5048
5049
5050
# File 'lib/models/porcelain.rb', line 5048

def healthy
  @healthy
end

#host_overrideObject

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



5050
5051
5052
# File 'lib/models/porcelain.rb', line 5050

def host_override
  @host_override
end

#idObject

Unique identifier of the Resource.



5052
5053
5054
# File 'lib/models/porcelain.rb', line 5052

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



5054
5055
5056
# File 'lib/models/porcelain.rb', line 5054

def name
  @name
end

#secret_store_idObject

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



5056
5057
5058
# File 'lib/models/porcelain.rb', line 5056

def secret_store_id
  @secret_store_id
end

#subdomainObject

Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)



5058
5059
5060
# File 'lib/models/porcelain.rb', line 5058

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



5060
5061
5062
# File 'lib/models/porcelain.rb', line 5060

def tags
  @tags
end

#urlObject

The base address of your website without the path.



5062
5063
5064
# File 'lib/models/porcelain.rb', line 5062

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object



5096
5097
5098
5099
5100
5101
5102
# File 'lib/models/porcelain.rb', line 5096

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