Class: NgrokAPI::Models::HTTPSEdgeRoute
- Inherits:
-
Object
- Object
- NgrokAPI::Models::HTTPSEdgeRoute
- Defined in:
- lib/ngrokapi/models/https_edge_route.rb
Instance Attribute Summary collapse
-
#attrs ⇒ Object
readonly
Returns the value of attribute attrs.
-
#backend ⇒ Object
readonly
Returns the value of attribute backend.
-
#circuit_breaker ⇒ Object
readonly
Returns the value of attribute circuit_breaker.
-
#client ⇒ Object
readonly
Returns the value of attribute client.
-
#compression ⇒ Object
readonly
Returns the value of attribute compression.
-
#created_at ⇒ Object
readonly
Returns the value of attribute created_at.
-
#description ⇒ Object
readonly
Returns the value of attribute description.
-
#edge_id ⇒ Object
readonly
Returns the value of attribute edge_id.
-
#id ⇒ Object
readonly
Returns the value of attribute id.
-
#ip_restriction ⇒ Object
readonly
Returns the value of attribute ip_restriction.
-
#match ⇒ Object
readonly
Returns the value of attribute match.
-
#match_type ⇒ Object
readonly
Returns the value of attribute match_type.
-
#metadata ⇒ Object
readonly
Returns the value of attribute metadata.
-
#oauth ⇒ Object
readonly
Returns the value of attribute oauth.
-
#oidc ⇒ Object
readonly
Returns the value of attribute oidc.
-
#request_headers ⇒ Object
readonly
Returns the value of attribute request_headers.
-
#response_headers ⇒ Object
readonly
Returns the value of attribute response_headers.
-
#saml ⇒ Object
readonly
Returns the value of attribute saml.
-
#uri ⇒ Object
readonly
Returns the value of attribute uri.
-
#webhook_verification ⇒ Object
readonly
Returns the value of attribute webhook_verification.
-
#websocket_tcp_converter ⇒ Object
readonly
Returns the value of attribute websocket_tcp_converter.
Instance Method Summary collapse
- #==(other) ⇒ Object
-
#delete ⇒ Object
Delete an HTTPS Edge Route by ID.
-
#initialize(client: nil, attrs: {}) ⇒ HTTPSEdgeRoute
constructor
A new instance of HTTPSEdgeRoute.
- #to_h ⇒ Object
- #to_s ⇒ Object
-
#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) ⇒ Object
Updates an HTTPS Edge Route by ID.
Constructor Details
#initialize(client: nil, attrs: {}) ⇒ HTTPSEdgeRoute
Returns a new instance of HTTPSEdgeRoute.
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
# 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 |
Instance Attribute Details
#attrs ⇒ Object (readonly)
Returns the value of attribute attrs.
6 7 8 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 6 def attrs @attrs end |
#backend ⇒ Object (readonly)
Returns the value of attribute backend.
6 7 8 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 6 def backend @backend end |
#circuit_breaker ⇒ Object (readonly)
Returns the value of attribute circuit_breaker.
6 7 8 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 6 def circuit_breaker @circuit_breaker end |
#client ⇒ Object (readonly)
Returns the value of attribute client.
6 7 8 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 6 def client @client end |
#compression ⇒ Object (readonly)
Returns the value of attribute compression.
6 7 8 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 6 def compression @compression end |
#created_at ⇒ Object (readonly)
Returns the value of attribute created_at.
6 7 8 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 6 def created_at @created_at end |
#description ⇒ Object (readonly)
Returns the value of attribute description.
6 7 8 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 6 def description @description end |
#edge_id ⇒ Object (readonly)
Returns the value of attribute edge_id.
6 7 8 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 6 def edge_id @edge_id end |
#id ⇒ Object (readonly)
Returns the value of attribute id.
6 7 8 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 6 def id @id end |
#ip_restriction ⇒ Object (readonly)
Returns the value of attribute ip_restriction.
6 7 8 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 6 def ip_restriction @ip_restriction end |
#match ⇒ Object (readonly)
Returns the value of attribute match.
6 7 8 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 6 def match @match end |
#match_type ⇒ Object (readonly)
Returns the value of attribute match_type.
6 7 8 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 6 def match_type @match_type end |
#metadata ⇒ Object (readonly)
Returns the value of attribute metadata.
6 7 8 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 6 def @metadata end |
#oauth ⇒ Object (readonly)
Returns the value of attribute oauth.
6 7 8 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 6 def oauth @oauth end |
#oidc ⇒ Object (readonly)
Returns the value of attribute oidc.
6 7 8 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 6 def oidc @oidc end |
#request_headers ⇒ Object (readonly)
Returns the value of attribute request_headers.
6 7 8 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 6 def request_headers @request_headers end |
#response_headers ⇒ Object (readonly)
Returns the value of attribute response_headers.
6 7 8 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 6 def response_headers @response_headers end |
#saml ⇒ Object (readonly)
Returns the value of attribute saml.
6 7 8 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 6 def saml @saml end |
#uri ⇒ Object (readonly)
Returns the value of attribute uri.
6 7 8 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 6 def uri @uri end |
#webhook_verification ⇒ Object (readonly)
Returns the value of attribute webhook_verification.
6 7 8 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 6 def webhook_verification @webhook_verification end |
#websocket_tcp_converter ⇒ Object (readonly)
Returns the value of attribute websocket_tcp_converter.
6 7 8 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 6 def websocket_tcp_converter @websocket_tcp_converter end |
Instance Method Details
#==(other) ⇒ Object
52 53 54 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 52 def ==(other) @attrs == other.attrs end |
#delete ⇒ Object
Delete an HTTPS Edge Route by ID
128 129 130 131 132 133 134 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 128 def delete( ) @client.delete( edge_id: @edge_id, id: @id ) end |
#to_h ⇒ Object
60 61 62 |
# File 'lib/ngrokapi/models/https_edge_route.rb', line 60 def to_h @attrs.to_h end |
#to_s ⇒ Object
56 57 58 |
# 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) ⇒ 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.
71 72 73 74 75 76 77 78 79 80 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 |
# 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 = if @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: , 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 |