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

Returns a new instance of HTTPAuth.



6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
# File 'lib/models/porcelain.rb', line 6654

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.



6624
6625
6626
# File 'lib/models/porcelain.rb', line 6624

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.



6626
6627
6628
# File 'lib/models/porcelain.rb', line 6626

def bind_interface
  @bind_interface
end

#default_pathObject

Automatically redirect to this path upon connecting.



6628
6629
6630
# File 'lib/models/porcelain.rb', line 6628

def default_path
  @default_path
end

#egress_filterObject

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



6630
6631
6632
# File 'lib/models/porcelain.rb', line 6630

def egress_filter
  @egress_filter
end

#headers_blacklistObject

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



6632
6633
6634
# File 'lib/models/porcelain.rb', line 6632

def headers_blacklist
  @headers_blacklist
end

#healthcheck_pathObject

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



6634
6635
6636
# File 'lib/models/porcelain.rb', line 6634

def healthcheck_path
  @healthcheck_path
end

#healthyObject

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



6636
6637
6638
# File 'lib/models/porcelain.rb', line 6636

def healthy
  @healthy
end

#host_overrideObject

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



6638
6639
6640
# File 'lib/models/porcelain.rb', line 6638

def host_override
  @host_override
end

#idObject

Unique identifier of the Resource.



6640
6641
6642
# File 'lib/models/porcelain.rb', line 6640

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



6642
6643
6644
# File 'lib/models/porcelain.rb', line 6642

def name
  @name
end

#proxy_cluster_idObject

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



6644
6645
6646
# File 'lib/models/porcelain.rb', line 6644

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

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



6646
6647
6648
# File 'lib/models/porcelain.rb', line 6646

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)



6648
6649
6650
# File 'lib/models/porcelain.rb', line 6648

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



6650
6651
6652
# File 'lib/models/porcelain.rb', line 6650

def tags
  @tags
end

#urlObject

The base address of your website without the path.



6652
6653
6654
# File 'lib/models/porcelain.rb', line 6652

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object



6688
6689
6690
6691
6692
6693
6694
# File 'lib/models/porcelain.rb', line 6688

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