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.



4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
# File 'lib/models/porcelain.rb', line 4359

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.



4331
4332
4333
# File 'lib/models/porcelain.rb', line 4331

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.



4333
4334
4335
# File 'lib/models/porcelain.rb', line 4333

def bind_interface
  @bind_interface
end

#default_pathObject

Automatically redirect to this path upon connecting.



4335
4336
4337
# File 'lib/models/porcelain.rb', line 4335

def default_path
  @default_path
end

#egress_filterObject

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



4337
4338
4339
# File 'lib/models/porcelain.rb', line 4337

def egress_filter
  @egress_filter
end

#headers_blacklistObject

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



4339
4340
4341
# File 'lib/models/porcelain.rb', line 4339

def headers_blacklist
  @headers_blacklist
end

#healthcheck_pathObject

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



4341
4342
4343
# File 'lib/models/porcelain.rb', line 4341

def healthcheck_path
  @healthcheck_path
end

#healthyObject

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



4343
4344
4345
# File 'lib/models/porcelain.rb', line 4343

def healthy
  @healthy
end

#host_overrideObject

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



4345
4346
4347
# File 'lib/models/porcelain.rb', line 4345

def host_override
  @host_override
end

#idObject

Unique identifier of the Resource.



4347
4348
4349
# File 'lib/models/porcelain.rb', line 4347

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



4349
4350
4351
# File 'lib/models/porcelain.rb', line 4349

def name
  @name
end

#secret_store_idObject

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



4351
4352
4353
# File 'lib/models/porcelain.rb', line 4351

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)



4353
4354
4355
# File 'lib/models/porcelain.rb', line 4353

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



4355
4356
4357
# File 'lib/models/porcelain.rb', line 4355

def tags
  @tags
end

#urlObject

The base address of your website without the path.



4357
4358
4359
# File 'lib/models/porcelain.rb', line 4357

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object



4391
4392
4393
4394
4395
4396
4397
# File 'lib/models/porcelain.rb', line 4391

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