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.



4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
# File 'lib/models/porcelain.rb', line 4425

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.



4397
4398
4399
# File 'lib/models/porcelain.rb', line 4397

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.



4399
4400
4401
# File 'lib/models/porcelain.rb', line 4399

def bind_interface
  @bind_interface
end

#default_pathObject

Automatically redirect to this path upon connecting.



4401
4402
4403
# File 'lib/models/porcelain.rb', line 4401

def default_path
  @default_path
end

#egress_filterObject

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



4403
4404
4405
# File 'lib/models/porcelain.rb', line 4403

def egress_filter
  @egress_filter
end

#headers_blacklistObject

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



4405
4406
4407
# File 'lib/models/porcelain.rb', line 4405

def headers_blacklist
  @headers_blacklist
end

#healthcheck_pathObject

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



4407
4408
4409
# File 'lib/models/porcelain.rb', line 4407

def healthcheck_path
  @healthcheck_path
end

#healthyObject

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



4409
4410
4411
# File 'lib/models/porcelain.rb', line 4409

def healthy
  @healthy
end

#host_overrideObject

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



4411
4412
4413
# File 'lib/models/porcelain.rb', line 4411

def host_override
  @host_override
end

#idObject

Unique identifier of the Resource.



4413
4414
4415
# File 'lib/models/porcelain.rb', line 4413

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



4415
4416
4417
# File 'lib/models/porcelain.rb', line 4415

def name
  @name
end

#secret_store_idObject

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



4417
4418
4419
# File 'lib/models/porcelain.rb', line 4417

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)



4419
4420
4421
# File 'lib/models/porcelain.rb', line 4419

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



4421
4422
4423
# File 'lib/models/porcelain.rb', line 4421

def tags
  @tags
end

#urlObject

The base address of your website without the path.



4423
4424
4425
# File 'lib/models/porcelain.rb', line 4423

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object



4457
4458
4459
4460
4461
4462
4463
# File 'lib/models/porcelain.rb', line 4457

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