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.



6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
# File 'lib/models/porcelain.rb', line 6077

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.



6047
6048
6049
# File 'lib/models/porcelain.rb', line 6047

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.



6049
6050
6051
# File 'lib/models/porcelain.rb', line 6049

def bind_interface
  @bind_interface
end

#default_pathObject

Automatically redirect to this path upon connecting.



6051
6052
6053
# File 'lib/models/porcelain.rb', line 6051

def default_path
  @default_path
end

#egress_filterObject

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



6053
6054
6055
# File 'lib/models/porcelain.rb', line 6053

def egress_filter
  @egress_filter
end

#headers_blacklistObject

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



6055
6056
6057
# File 'lib/models/porcelain.rb', line 6055

def headers_blacklist
  @headers_blacklist
end

#healthcheck_pathObject

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



6057
6058
6059
# File 'lib/models/porcelain.rb', line 6057

def healthcheck_path
  @healthcheck_path
end

#healthyObject

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



6059
6060
6061
# File 'lib/models/porcelain.rb', line 6059

def healthy
  @healthy
end

#host_overrideObject

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



6061
6062
6063
# File 'lib/models/porcelain.rb', line 6061

def host_override
  @host_override
end

#idObject

Unique identifier of the Resource.



6063
6064
6065
# File 'lib/models/porcelain.rb', line 6063

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



6065
6066
6067
# File 'lib/models/porcelain.rb', line 6065

def name
  @name
end

#proxy_cluster_idObject

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



6067
6068
6069
# File 'lib/models/porcelain.rb', line 6067

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

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



6069
6070
6071
# File 'lib/models/porcelain.rb', line 6069

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)



6071
6072
6073
# File 'lib/models/porcelain.rb', line 6071

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



6073
6074
6075
# File 'lib/models/porcelain.rb', line 6073

def tags
  @tags
end

#urlObject

The base address of your website without the path.



6075
6076
6077
# File 'lib/models/porcelain.rb', line 6075

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object



6111
6112
6113
6114
6115
6116
6117
# File 'lib/models/porcelain.rb', line 6111

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