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.



8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
 
# File 'lib/models/porcelain.rb', line 8337

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.



8305
8306
8307
 
# File 'lib/models/porcelain.rb', line 8305

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.



8307
8308
8309
 
# File 'lib/models/porcelain.rb', line 8307

def bind_interface
  @bind_interface
end

#default_path ⇒ Object

Automatically redirect to this path upon connecting.



8309
8310
8311
 
# File 'lib/models/porcelain.rb', line 8309

def default_path
  @default_path
end

#egress_filter ⇒ Object

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



8311
8312
8313
 
# File 'lib/models/porcelain.rb', line 8311

def egress_filter
  @egress_filter
end

#headers_blacklist ⇒ Object

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



8313
8314
8315
 
# File 'lib/models/porcelain.rb', line 8313

def headers_blacklist
  @headers_blacklist
end

#healthcheck_path ⇒ Object

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



8315
8316
8317
 
# File 'lib/models/porcelain.rb', line 8315

def healthcheck_path
  @healthcheck_path
end

#healthy ⇒ Object

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



8317
8318
8319
 
# File 'lib/models/porcelain.rb', line 8317

def healthy
  @healthy
end

#host_override ⇒ Object

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



8319
8320
8321
 
# File 'lib/models/porcelain.rb', line 8319

def host_override
  @host_override
end

#id ⇒ Object

Unique identifier of the Resource.



8321
8322
8323
 
# File 'lib/models/porcelain.rb', line 8321

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



8323
8324
8325
 
# File 'lib/models/porcelain.rb', line 8323

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.



8325
8326
8327
 
# File 'lib/models/porcelain.rb', line 8325

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



8327
8328
8329
 
# File 'lib/models/porcelain.rb', line 8327

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



8329
8330
8331
 
# File 'lib/models/porcelain.rb', line 8329

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)



8331
8332
8333
 
# File 'lib/models/porcelain.rb', line 8331

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



8333
8334
8335
 
# File 'lib/models/porcelain.rb', line 8333

def tags
  @tags
end

#url ⇒ Object

The base address of your website without the path.



8335
8336
8337
 
# File 'lib/models/porcelain.rb', line 8335

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



8373
8374
8375
8376
8377
8378
8379
 
# File 'lib/models/porcelain.rb', line 8373

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