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, custom_headers: 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.



8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
 
# File 'lib/models/porcelain.rb', line 8387

def initialize(
  auth_header: nil,
  bind_interface: nil,
  custom_headers: 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
  @custom_headers = custom_headers == nil ? nil : custom_headers
  @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.



8353
8354
8355
 
# File 'lib/models/porcelain.rb', line 8353

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.



8355
8356
8357
 
# File 'lib/models/porcelain.rb', line 8355

def bind_interface
  @bind_interface
end

#custom_headers ⇒ Object

Additional HTTP headers to include in requests.



8357
8358
8359
 
# File 'lib/models/porcelain.rb', line 8357

def custom_headers
  @custom_headers
end

#default_path ⇒ Object

Automatically redirect to this path upon connecting.



8359
8360
8361
 
# File 'lib/models/porcelain.rb', line 8359

def default_path
  @default_path
end

#egress_filter ⇒ Object

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



8361
8362
8363
 
# File 'lib/models/porcelain.rb', line 8361

def egress_filter
  @egress_filter
end

#headers_blacklist ⇒ Object

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



8363
8364
8365
 
# File 'lib/models/porcelain.rb', line 8363

def headers_blacklist
  @headers_blacklist
end

#healthcheck_path ⇒ Object

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



8365
8366
8367
 
# File 'lib/models/porcelain.rb', line 8365

def healthcheck_path
  @healthcheck_path
end

#healthy ⇒ Object

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



8367
8368
8369
 
# File 'lib/models/porcelain.rb', line 8367

def healthy
  @healthy
end

#host_override ⇒ Object

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



8369
8370
8371
 
# File 'lib/models/porcelain.rb', line 8369

def host_override
  @host_override
end

#id ⇒ Object

Unique identifier of the Resource.



8371
8372
8373
 
# File 'lib/models/porcelain.rb', line 8371

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



8373
8374
8375
 
# File 'lib/models/porcelain.rb', line 8373

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.



8375
8376
8377
 
# File 'lib/models/porcelain.rb', line 8375

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



8377
8378
8379
 
# File 'lib/models/porcelain.rb', line 8377

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



8379
8380
8381
 
# File 'lib/models/porcelain.rb', line 8379

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)



8381
8382
8383
 
# File 'lib/models/porcelain.rb', line 8381

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



8383
8384
8385
 
# File 'lib/models/porcelain.rb', line 8383

def tags
  @tags
end

#url ⇒ Object

The base address of your website without the path.



8385
8386
8387
 
# File 'lib/models/porcelain.rb', line 8385

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



8425
8426
8427
8428
8429
8430
8431
 
# File 'lib/models/porcelain.rb', line 8425

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