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.



5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
# File 'lib/models/porcelain.rb', line 5139

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.



5111
5112
5113
# File 'lib/models/porcelain.rb', line 5111

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.



5113
5114
5115
# File 'lib/models/porcelain.rb', line 5113

def bind_interface
  @bind_interface
end

#default_pathObject

Automatically redirect to this path upon connecting.



5115
5116
5117
# File 'lib/models/porcelain.rb', line 5115

def default_path
  @default_path
end

#egress_filterObject

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



5117
5118
5119
# File 'lib/models/porcelain.rb', line 5117

def egress_filter
  @egress_filter
end

#headers_blacklistObject

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



5119
5120
5121
# File 'lib/models/porcelain.rb', line 5119

def headers_blacklist
  @headers_blacklist
end

#healthcheck_pathObject

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



5121
5122
5123
# File 'lib/models/porcelain.rb', line 5121

def healthcheck_path
  @healthcheck_path
end

#healthyObject

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



5123
5124
5125
# File 'lib/models/porcelain.rb', line 5123

def healthy
  @healthy
end

#host_overrideObject

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



5125
5126
5127
# File 'lib/models/porcelain.rb', line 5125

def host_override
  @host_override
end

#idObject

Unique identifier of the Resource.



5127
5128
5129
# File 'lib/models/porcelain.rb', line 5127

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



5129
5130
5131
# File 'lib/models/porcelain.rb', line 5129

def name
  @name
end

#secret_store_idObject

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



5131
5132
5133
# File 'lib/models/porcelain.rb', line 5131

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)



5133
5134
5135
# File 'lib/models/porcelain.rb', line 5133

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



5135
5136
5137
# File 'lib/models/porcelain.rb', line 5135

def tags
  @tags
end

#urlObject

The base address of your website without the path.



5137
5138
5139
# File 'lib/models/porcelain.rb', line 5137

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object



5171
5172
5173
5174
5175
5176
5177
# File 'lib/models/porcelain.rb', line 5171

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