class NgrokAPI::Models::HTTPSEdgeRoute

Attributes

attrs[R]
backend[R]
circuit_breaker[R]
client[R]
compression[R]
created_at[R]
description[R]
edge_id[R]
id[R]
ip_restriction[R]
match[R]
match_type[R]
metadata[R]
oauth[R]
oidc[R]
request_headers[R]
response_headers[R]
saml[R]
uri[R]
webhook_verification[R]
websocket_tcp_converter[R]

Public Class Methods

new(client: nil, attrs: {}) click to toggle source
# File lib/ngrokapi/models/https_edge_route.rb, line 28
def initialize(client: nil, attrs: {})
  @client = client
  @attrs = attrs
  @edge_id = @attrs['edge_id']
  @id = @attrs['id']
  @created_at = @attrs['created_at']
  @match_type = @attrs['match_type']
  @match = @attrs['match']
  @uri = @attrs['uri']
  @description = @attrs['description']
  @metadata = @attrs['metadata']
  @backend = @attrs['backend']
  @ip_restriction = @attrs['ip_restriction']
  @circuit_breaker = @attrs['circuit_breaker']
  @compression = @attrs['compression']
  @request_headers = @attrs['request_headers']
  @response_headers = @attrs['response_headers']
  @webhook_verification = @attrs['webhook_verification']
  @oauth = @attrs['oauth']
  @saml = @attrs['saml']
  @oidc = @attrs['oidc']
  @websocket_tcp_converter = @attrs['websocket_tcp_converter']
end

Public Instance Methods

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

Delete an HTTPS Edge Route by ID

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

# File lib/ngrokapi/models/https_edge_route.rb, line 128
def delete(
)
  @client.delete(
    edge_id: @edge_id,
    id: @id
  )
end
to_h() click to toggle source
# File lib/ngrokapi/models/https_edge_route.rb, line 60
def to_h
  @attrs.to_h
end
to_s() click to toggle source
# File lib/ngrokapi/models/https_edge_route.rb, line 56
def to_s
  @attrs.to_s
end
update( match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil ) click to toggle source

Updates an HTTPS Edge Route 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-routes-update

# File lib/ngrokapi/models/https_edge_route.rb, line 71
def update(
  match_type: "",
  match: "",
  description: "",
  metadata: "",
  backend: nil,
  ip_restriction: nil,
  circuit_breaker: nil,
  compression: nil,
  request_headers: nil,
  response_headers: nil,
  webhook_verification: nil,
  oauth: nil,
  saml: nil,
  oidc: nil,
  websocket_tcp_converter: nil
)
  @match_type = match_type if match_type
  @match = match if match
  @description = description if description
  @metadata = metadata if metadata
  @backend = backend if backend
  @ip_restriction = ip_restriction if ip_restriction
  @circuit_breaker = circuit_breaker if circuit_breaker
  @compression = compression if compression
  @request_headers = request_headers if request_headers
  @response_headers = response_headers if response_headers
  @webhook_verification = webhook_verification if webhook_verification
  @oauth = oauth if oauth
  @saml = saml if saml
  @oidc = oidc if oidc
  @websocket_tcp_converter = websocket_tcp_converter if websocket_tcp_converter
  @client.update(
    edge_id: @edge_id,
    id: @id,
    match_type: match_type,
    match: match,
    description: description,
    metadata: metadata,
    backend: backend,
    ip_restriction: ip_restriction,
    circuit_breaker: circuit_breaker,
    compression: compression,
    request_headers: request_headers,
    response_headers: response_headers,
    webhook_verification: webhook_verification,
    oauth: oauth,
    saml: saml,
    oidc: oidc,
    websocket_tcp_converter: websocket_tcp_converter
  )
end