Class: NgrokAPI::Models::HTTPSEdgeRoute

Inherits:
Object
  • Object
show all
Defined in:
lib/ngrokapi/models/https_edge_route.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client: nil, attrs: {}) ⇒ HTTPSEdgeRoute

Returns a new instance of HTTPSEdgeRoute.



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 34

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']
  unless @attrs['uri'].nil?
    @uri = URI(@attrs['uri'])
  end
  @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']
  @user_agent_filter = @attrs['user_agent_filter']
  @traffic_policy = @attrs['traffic_policy']
end

Instance Attribute Details

#attrs ⇒ Object (readonly)

Returns the value of attribute attrs.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def attrs
  @attrs
end

#backend ⇒ Object (readonly)

Returns the value of attribute backend.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def backend
  @backend
end

#circuit_breaker ⇒ Object (readonly)

Returns the value of attribute circuit_breaker.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def circuit_breaker
  @circuit_breaker
end

#client ⇒ Object (readonly)

Returns the value of attribute client.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def client
  @client
end

#compression ⇒ Object (readonly)

Returns the value of attribute compression.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def compression
  @compression
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def created_at
  @created_at
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def description
  @description
end

#edge_id ⇒ Object (readonly)

Returns the value of attribute edge_id.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def edge_id
  @edge_id
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def id
  @id
end

#ip_restriction ⇒ Object (readonly)

Returns the value of attribute ip_restriction.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def ip_restriction
  @ip_restriction
end

#match ⇒ Object (readonly)

Returns the value of attribute match.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def match
  @match
end

#match_type ⇒ Object (readonly)

Returns the value of attribute match_type.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def match_type
  @match_type
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def metadata
  @metadata
end

#oauth ⇒ Object (readonly)

Returns the value of attribute oauth.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def oauth
  @oauth
end

#oidc ⇒ Object (readonly)

Returns the value of attribute oidc.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def oidc
  @oidc
end

#request_headers ⇒ Object (readonly)

Returns the value of attribute request_headers.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def request_headers
  @request_headers
end

#response_headers ⇒ Object (readonly)

Returns the value of attribute response_headers.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def response_headers
  @response_headers
end

#saml ⇒ Object (readonly)

Returns the value of attribute saml.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def saml
  @saml
end

#traffic_policy ⇒ Object (readonly)

Returns the value of attribute traffic_policy.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def traffic_policy
  @traffic_policy
end

#uri ⇒ Object (readonly)

Returns the value of attribute uri.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def uri
  @uri
end

#user_agent_filter ⇒ Object (readonly)

Returns the value of attribute user_agent_filter.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def user_agent_filter
  @user_agent_filter
end

#webhook_verification ⇒ Object (readonly)

Returns the value of attribute webhook_verification.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def webhook_verification
  @webhook_verification
end

#websocket_tcp_converter ⇒ Object (readonly)

Returns the value of attribute websocket_tcp_converter.



10
11
12
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 10

def websocket_tcp_converter
  @websocket_tcp_converter
end

Instance Method Details

#==(other) ⇒ Object 



62
63
64
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 62

def ==(other)
  @attrs == other.attrs
end

#delete ⇒ Object

Delete an HTTPS Edge Route by ID

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



144
145
146
147
148
149
150
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 144

def delete(
)
  @client.delete(
    edge_id: @edge_id,
    id: @id
  )
end

#to_h ⇒ Object 



70
71
72
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 70

def to_h
  @attrs.to_h
end

#to_s ⇒ Object 



66
67
68
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 66

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, user_agent_filter: nil, traffic_policy: nil) ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/ngrokapi/models/https_edge_route.rb', line 81

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,
  user_agent_filter: nil,
  traffic_policy: 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
  @user_agent_filter = user_agent_filter if user_agent_filter
  @traffic_policy = traffic_policy if traffic_policy
  @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,
    user_agent_filter: user_agent_filter,
    traffic_policy: traffic_policy
  )
end