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, proxy_cluster_id: nil, secret_store_id: nil, subdomain: nil, tags: nil, url: nil) ⇒ HTTPAuth



5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
# File 'lib/models/porcelain.rb', line 5462

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,
  proxy_cluster_id: 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
  @proxy_cluster_id = proxy_cluster_id == nil ? "" : proxy_cluster_id
  @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.



5432
5433
5434
# File 'lib/models/porcelain.rb', line 5432

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.



5434
5435
5436
# File 'lib/models/porcelain.rb', line 5434

def bind_interface
  @bind_interface
end

#default_pathObject

Automatically redirect to this path upon connecting.



5436
5437
5438
# File 'lib/models/porcelain.rb', line 5436

def default_path
  @default_path
end

#egress_filterObject

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



5438
5439
5440
# File 'lib/models/porcelain.rb', line 5438

def egress_filter
  @egress_filter
end

#headers_blacklistObject

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



5440
5441
5442
# File 'lib/models/porcelain.rb', line 5440

def headers_blacklist
  @headers_blacklist
end

#healthcheck_pathObject

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



5442
5443
5444
# File 'lib/models/porcelain.rb', line 5442

def healthcheck_path
  @healthcheck_path
end

#healthyObject

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



5444
5445
5446
# File 'lib/models/porcelain.rb', line 5444

def healthy
  @healthy
end

#host_overrideObject

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



5446
5447
5448
# File 'lib/models/porcelain.rb', line 5446

def host_override
  @host_override
end

#idObject

Unique identifier of the Resource.



5448
5449
5450
# File 'lib/models/porcelain.rb', line 5448

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



5450
5451
5452
# File 'lib/models/porcelain.rb', line 5450

def name
  @name
end

#proxy_cluster_idObject

ID of the proxy cluster for this resource, if any.



5452
5453
5454
# File 'lib/models/porcelain.rb', line 5452

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

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



5454
5455
5456
# File 'lib/models/porcelain.rb', line 5454

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)



5456
5457
5458
# File 'lib/models/porcelain.rb', line 5456

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



5458
5459
5460
# File 'lib/models/porcelain.rb', line 5458

def tags
  @tags
end

#urlObject

The base address of your website without the path.



5460
5461
5462
# File 'lib/models/porcelain.rb', line 5460

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object



5496
5497
5498
5499
5500
5501
5502
# File 'lib/models/porcelain.rb', line 5496

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