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, tls_cert: nil, tls_insecure: nil, tls_required: nil, url: nil) ⇒ HTTPAuth

Returns a new instance of HTTPAuth.



8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
 
# File 'lib/models/porcelain.rb', line 8958

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,
  tls_cert: nil,
  tls_insecure: nil,
  tls_required: 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
  @tls_cert = tls_cert == nil ? "" : tls_cert
  @tls_insecure = tls_insecure == nil ? false : tls_insecure
  @tls_required = tls_required == nil ? false : tls_required
  @url = url == nil ? "" : url
end

Instance Attribute Details

#auth_header ⇒ Object

The content to set as the authorization header.



8918
8919
8920
 
# File 'lib/models/porcelain.rb', line 8918

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.



8920
8921
8922
 
# File 'lib/models/porcelain.rb', line 8920

def bind_interface
  @bind_interface
end

#custom_headers ⇒ Object

Additional HTTP headers to include in requests.



8922
8923
8924
 
# File 'lib/models/porcelain.rb', line 8922

def custom_headers
  @custom_headers
end

#default_path ⇒ Object

Automatically redirect to this path upon connecting.



8924
8925
8926
 
# File 'lib/models/porcelain.rb', line 8924

def default_path
  @default_path
end

#egress_filter ⇒ Object

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



8926
8927
8928
 
# File 'lib/models/porcelain.rb', line 8926

def egress_filter
  @egress_filter
end

#headers_blacklist ⇒ Object

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



8928
8929
8930
 
# File 'lib/models/porcelain.rb', line 8928

def headers_blacklist
  @headers_blacklist
end

#healthcheck_path ⇒ Object

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



8930
8931
8932
 
# File 'lib/models/porcelain.rb', line 8930

def healthcheck_path
  @healthcheck_path
end

#healthy ⇒ Object

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



8932
8933
8934
 
# File 'lib/models/porcelain.rb', line 8932

def healthy
  @healthy
end

#host_override ⇒ Object

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



8934
8935
8936
 
# File 'lib/models/porcelain.rb', line 8934

def host_override
  @host_override
end

#id ⇒ Object

Unique identifier of the Resource.



8936
8937
8938
 
# File 'lib/models/porcelain.rb', line 8936

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



8938
8939
8940
 
# File 'lib/models/porcelain.rb', line 8938

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.



8940
8941
8942
 
# File 'lib/models/porcelain.rb', line 8940

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



8942
8943
8944
 
# File 'lib/models/porcelain.rb', line 8942

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



8944
8945
8946
 
# File 'lib/models/porcelain.rb', line 8944

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)



8946
8947
8948
 
# File 'lib/models/porcelain.rb', line 8946

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



8948
8949
8950
 
# File 'lib/models/porcelain.rb', line 8948

def tags
  @tags
end

#tls_cert ⇒ Object

Custom TLS certificate for upstream connection.



8950
8951
8952
 
# File 'lib/models/porcelain.rb', line 8950

def tls_cert
  @tls_cert
end

#tls_insecure ⇒ Object

Skip TLS certificate verification for the upstream connection.



8952
8953
8954
 
# File 'lib/models/porcelain.rb', line 8952

def tls_insecure
  @tls_insecure
end

#tls_required ⇒ Object

This option enforces HTTPS on the client, not resource connection.



8954
8955
8956
 
# File 'lib/models/porcelain.rb', line 8954

def tls_required
  @tls_required
end

#url ⇒ Object

The base address of your website without the path.



8956
8957
8958
 
# File 'lib/models/porcelain.rb', line 8956

def url
  @url
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



9002
9003
9004
9005
9006
9007
9008
 
# File 'lib/models/porcelain.rb', line 9002

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