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.



5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
# File 'lib/models/porcelain.rb', line 5073

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.



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

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.



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

def bind_interface
  @bind_interface
end

#default_pathObject

Automatically redirect to this path upon connecting.



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

def default_path
  @default_path
end

#egress_filterObject

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



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

def egress_filter
  @egress_filter
end

#headers_blacklistObject

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



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

def headers_blacklist
  @headers_blacklist
end

#healthcheck_pathObject

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



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

def healthcheck_path
  @healthcheck_path
end

#healthyObject

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



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

def healthy
  @healthy
end

#host_overrideObject

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



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

def host_override
  @host_override
end

#idObject

Unique identifier of the Resource.



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

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



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

def name
  @name
end

#secret_store_idObject

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



5065
5066
5067
# File 'lib/models/porcelain.rb', line 5065

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)



5067
5068
5069
# File 'lib/models/porcelain.rb', line 5067

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



5069
5070
5071
# File 'lib/models/porcelain.rb', line 5069

def tags
  @tags
end

#urlObject

The base address of your website without the path.



5071
5072
5073
# File 'lib/models/porcelain.rb', line 5071

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object



5105
5106
5107
5108
5109
5110
5111
# File 'lib/models/porcelain.rb', line 5105

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