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

Returns a new instance of HTTPAuth.



8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
 
# File 'lib/models/porcelain.rb', line 8254

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,
  port_override: 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
  @port_override = port_override == nil ? 0 : port_override
  @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_header ⇒ Object

The content to set as the authorization header.



8222
8223
8224
 
# File 'lib/models/porcelain.rb', line 8222

def auth_header
  @auth_header
end

#bind_interface ⇒ Object

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 and may also be set to one of the ResourceIPAllocationMode constants to select between VNM, loopback, or default allocation.



8224
8225
8226
 
# File 'lib/models/porcelain.rb', line 8224

def bind_interface
  @bind_interface
end

#default_path ⇒ Object

Automatically redirect to this path upon connecting.



8226
8227
8228
 
# File 'lib/models/porcelain.rb', line 8226

def default_path
  @default_path
end

#egress_filter ⇒ Object

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



8228
8229
8230
 
# File 'lib/models/porcelain.rb', line 8228

def egress_filter
  @egress_filter
end

#headers_blacklist ⇒ Object

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



8230
8231
8232
 
# File 'lib/models/porcelain.rb', line 8230

def headers_blacklist
  @headers_blacklist
end

#healthcheck_path ⇒ Object

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



8232
8233
8234
 
# File 'lib/models/porcelain.rb', line 8232

def healthcheck_path
  @healthcheck_path
end

#healthy ⇒ Object

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



8234
8235
8236
 
# File 'lib/models/porcelain.rb', line 8234

def healthy
  @healthy
end

#host_override ⇒ Object

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



8236
8237
8238
 
# File 'lib/models/porcelain.rb', line 8236

def host_override
  @host_override
end

#id ⇒ Object

Unique identifier of the Resource.



8238
8239
8240
 
# File 'lib/models/porcelain.rb', line 8238

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



8240
8241
8242
 
# File 'lib/models/porcelain.rb', line 8240

def name
  @name
end

#port_override ⇒ Object

The local port used by clients to connect to this resource. It is automatically generated if not provided on create and may be re-generated on update by specifying a value of -1.



8242
8243
8244
 
# File 'lib/models/porcelain.rb', line 8242

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



8244
8245
8246
 
# File 'lib/models/porcelain.rb', line 8244

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



8246
8247
8248
 
# File 'lib/models/porcelain.rb', line 8246

def secret_store_id
  @secret_store_id
end

#subdomain ⇒ Object

Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)



8248
8249
8250
 
# File 'lib/models/porcelain.rb', line 8248

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



8250
8251
8252
 
# File 'lib/models/porcelain.rb', line 8250

def tags
  @tags
end

#url ⇒ Object

The base address of your website without the path.



8252
8253
8254
 
# File 'lib/models/porcelain.rb', line 8252

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



8290
8291
8292
8293
8294
8295
8296
 
# File 'lib/models/porcelain.rb', line 8290

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