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.



5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
# File 'lib/models/porcelain.rb', line 5110

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.



5082
5083
5084
# File 'lib/models/porcelain.rb', line 5082

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.



5084
5085
5086
# File 'lib/models/porcelain.rb', line 5084

def bind_interface
  @bind_interface
end

#default_pathObject

Automatically redirect to this path upon connecting.



5086
5087
5088
# File 'lib/models/porcelain.rb', line 5086

def default_path
  @default_path
end

#egress_filterObject

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



5088
5089
5090
# File 'lib/models/porcelain.rb', line 5088

def egress_filter
  @egress_filter
end

#headers_blacklistObject

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



5090
5091
5092
# File 'lib/models/porcelain.rb', line 5090

def headers_blacklist
  @headers_blacklist
end

#healthcheck_pathObject

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



5092
5093
5094
# File 'lib/models/porcelain.rb', line 5092

def healthcheck_path
  @healthcheck_path
end

#healthyObject

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



5094
5095
5096
# File 'lib/models/porcelain.rb', line 5094

def healthy
  @healthy
end

#host_overrideObject

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



5096
5097
5098
# File 'lib/models/porcelain.rb', line 5096

def host_override
  @host_override
end

#idObject

Unique identifier of the Resource.



5098
5099
5100
# File 'lib/models/porcelain.rb', line 5098

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



5100
5101
5102
# File 'lib/models/porcelain.rb', line 5100

def name
  @name
end

#secret_store_idObject

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



5102
5103
5104
# File 'lib/models/porcelain.rb', line 5102

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)



5104
5105
5106
# File 'lib/models/porcelain.rb', line 5104

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



5106
5107
5108
# File 'lib/models/porcelain.rb', line 5106

def tags
  @tags
end

#urlObject

The base address of your website without the path.



5108
5109
5110
# File 'lib/models/porcelain.rb', line 5108

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object



5142
5143
5144
5145
5146
5147
5148
# File 'lib/models/porcelain.rb', line 5142

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