class NgrokAPI::Models::HTTPSEdge

Attributes

attrs[R]
client[R]
created_at[R]
description[R]
hostports[R]
id[R]
metadata[R]
mutual_tls[R]
routes[R]
tls_termination[R]
uri[R]

Public Class Methods

new(client: nil, attrs: {}) click to toggle source
# File lib/ngrokapi/models/https_edge.rb, line 18
def initialize(client: nil, attrs: {})
  @client = client
  @attrs = attrs
  @id = @attrs['id']
  @description = @attrs['description']
  @metadata = @attrs['metadata']
  @created_at = @attrs['created_at']
  @uri = @attrs['uri']
  @hostports = @attrs['hostports']
  @mutual_tls = @attrs['mutual_tls']
  @tls_termination = @attrs['tls_termination']
  @routes = @attrs['routes']
end

Public Instance Methods

==(other) click to toggle source
# File lib/ngrokapi/models/https_edge.rb, line 32
def ==(other)
  @attrs == other.attrs
end
delete() click to toggle source

Delete an HTTPS Edge by ID

ngrok.com/docs/api#api-edges-https-delete

# File lib/ngrokapi/models/https_edge.rb, line 77
def delete
  @client.delete(
    id: @id
  )
end
to_h() click to toggle source
# File lib/ngrokapi/models/https_edge.rb, line 40
def to_h
  @attrs.to_h
end
to_s() click to toggle source
# File lib/ngrokapi/models/https_edge.rb, line 36
def to_s
  @attrs.to_s
end
update( description: nil, metadata: nil, hostports: nil, mutual_tls: nil, tls_termination: nil ) click to toggle source

Updates an HTTPS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.

ngrok.com/docs/api#api-edges-https-update

# File lib/ngrokapi/models/https_edge.rb, line 51
def update(
  description: nil,
  metadata: nil,
  hostports: nil,
  mutual_tls: nil,
  tls_termination: nil
)
  @description = description if description
  @metadata = metadata if metadata
  @hostports = hostports if hostports
  @mutual_tls = mutual_tls if mutual_tls
  @tls_termination = tls_termination if tls_termination
  @client.update(
    id: @id,
    description: description,
    metadata: metadata,
    hostports: hostports,
    mutual_tls: mutual_tls,
    tls_termination: tls_termination
  )
end