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.



4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
# File 'lib/models/porcelain.rb', line 4283

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.



4255
4256
4257
# File 'lib/models/porcelain.rb', line 4255

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.



4257
4258
4259
# File 'lib/models/porcelain.rb', line 4257

def bind_interface
  @bind_interface
end

#default_pathObject

Automatically redirect to this path upon connecting.



4259
4260
4261
# File 'lib/models/porcelain.rb', line 4259

def default_path
  @default_path
end

#egress_filterObject

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



4261
4262
4263
# File 'lib/models/porcelain.rb', line 4261

def egress_filter
  @egress_filter
end

#headers_blacklistObject

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



4263
4264
4265
# File 'lib/models/porcelain.rb', line 4263

def headers_blacklist
  @headers_blacklist
end

#healthcheck_pathObject

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



4265
4266
4267
# File 'lib/models/porcelain.rb', line 4265

def healthcheck_path
  @healthcheck_path
end

#healthyObject

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



4267
4268
4269
# File 'lib/models/porcelain.rb', line 4267

def healthy
  @healthy
end

#host_overrideObject

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



4269
4270
4271
# File 'lib/models/porcelain.rb', line 4269

def host_override
  @host_override
end

#idObject

Unique identifier of the Resource.



4271
4272
4273
# File 'lib/models/porcelain.rb', line 4271

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



4273
4274
4275
# File 'lib/models/porcelain.rb', line 4273

def name
  @name
end

#secret_store_idObject

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



4275
4276
4277
# File 'lib/models/porcelain.rb', line 4275

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)



4277
4278
4279
# File 'lib/models/porcelain.rb', line 4277

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



4279
4280
4281
# File 'lib/models/porcelain.rb', line 4279

def tags
  @tags
end

#urlObject

The base address of your website without the path.



4281
4282
4283
# File 'lib/models/porcelain.rb', line 4281

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object



4315
4316
4317
4318
4319
4320
4321
# File 'lib/models/porcelain.rb', line 4315

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