Class: NgrokAPI::Models::HTTPSEdge

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:, result:) ⇒ HTTPSEdge

Returns a new instance of HTTPSEdge.



18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/ngrokapi/models/https_edge.rb', line 18

def initialize(client:, result:)
  @client = client
  @result = result
  @id = @result['id']
  @description = @result['description']
  @metadata = @result['metadata']
  @created_at = @result['created_at']
  @uri = @result['uri']
  @hostports = @result['hostports']
  @mutual_tls = @result['mutual_tls']
  @tls_termination = @result['tls_termination']
  @routes = @result['routes']
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



6
7
8
 
# File 'lib/ngrokapi/models/https_edge.rb', line 6

def client
  @client
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



6
7
8
 
# File 'lib/ngrokapi/models/https_edge.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.rb', line 6

def description
  @description
end

#hostports ⇒ Object (readonly)

Returns the value of attribute hostports.



6
7
8
 
# File 'lib/ngrokapi/models/https_edge.rb', line 6

def hostports
  @hostports
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



6
7
8
 
# File 'lib/ngrokapi/models/https_edge.rb', line 6

def id
  @id
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



6
7
8
 
# File 'lib/ngrokapi/models/https_edge.rb', line 6

def metadata
  @metadata
end

#mutual_tls ⇒ Object (readonly)

Returns the value of attribute mutual_tls.



6
7
8
 
# File 'lib/ngrokapi/models/https_edge.rb', line 6

def mutual_tls
  @mutual_tls
end

#result ⇒ Object (readonly)

Returns the value of attribute result.



6
7
8
 
# File 'lib/ngrokapi/models/https_edge.rb', line 6

def result
  @result
end

#routes ⇒ Object (readonly)

Returns the value of attribute routes.



6
7
8
 
# File 'lib/ngrokapi/models/https_edge.rb', line 6

def routes
  @routes
end

#tls_termination ⇒ Object (readonly)

Returns the value of attribute tls_termination.



6
7
8
 
# File 'lib/ngrokapi/models/https_edge.rb', line 6

def tls_termination
  @tls_termination
end

#uri ⇒ Object (readonly)

Returns the value of attribute uri.



6
7
8
 
# File 'lib/ngrokapi/models/https_edge.rb', line 6

def uri
  @uri
end

Instance Method Details

#==(other) ⇒ Object 



32
33
34
 
# File 'lib/ngrokapi/models/https_edge.rb', line 32

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

#delete ⇒ Object

Delete an HTTPS Edge by ID

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



73
74
75
76
77
 
# File 'lib/ngrokapi/models/https_edge.rb', line 73

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

#to_s ⇒ Object 



36
37
38
 
# File 'lib/ngrokapi/models/https_edge.rb', line 36

def to_s
  @result.to_s
end

#update(description: nil, metadata: nil, hostports: nil, mutual_tls: nil, tls_termination: nil) ⇒ Object

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.

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/ngrokapi/models/https_edge.rb', line 47

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