Class: NgrokAPI::Models::TCPEdge

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:, result:) ⇒ TCPEdge

Returns a new instance of TCPEdge.



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

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']
  @backend = @result['backend']
  @ip_restriction = @result['ip_restriction']
end

Instance Attribute Details

#backend ⇒ Object (readonly)

Returns the value of attribute backend.



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

def backend
  @backend
end

#client ⇒ Object (readonly)

Returns the value of attribute client.



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

def description
  @description
end

#hostports ⇒ Object (readonly)

Returns the value of attribute hostports.



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

def hostports
  @hostports
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def ip_restriction
  @ip_restriction
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



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

def metadata
  @metadata
end

#result ⇒ Object (readonly)

Returns the value of attribute result.



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

def result
  @result
end

#uri ⇒ Object (readonly)

Returns the value of attribute uri.



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

def uri
  @uri
end

Instance Method Details

#==(other) ⇒ Object 



30
31
32
 
# File 'lib/ngrokapi/models/tcp_edge.rb', line 30

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

#delete ⇒ Object

Delete a TCP Edge by ID

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



71
72
73
74
75
 
# File 'lib/ngrokapi/models/tcp_edge.rb', line 71

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

#to_s ⇒ Object 



34
35
36
 
# File 'lib/ngrokapi/models/tcp_edge.rb', line 34

def to_s
  @result.to_s
end

#update(description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) ⇒ Object

Updates a TCP 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-tcp-update



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

def update(
  description: nil,
  metadata: nil,
  hostports: nil,
  backend: nil,
  ip_restriction: nil
)
  @description = description if description
  @metadata = metadata if metadata
  @hostports = hostports if hostports
  @backend = backend if backend
  @ip_restriction = ip_restriction if ip_restriction
  @client.update(
    id: @id,
    description: description,
    metadata: metadata,
    hostports: hostports,
    backend: backend,
    ip_restriction: ip_restriction
  )
end