Class: NgrokAPI::Services::EdgesTCPClient

Inherits:
Object
  • Object
show all
Defined in:
lib/ngrokapi/services/edges_tcp_client.rb

Overview

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

Constant Summary collapse

PATH =

The API path for the requests

'/edges/tcp'
LIST_PROPERTY =

The List Property from the resulting API for list calls

'tcp_edges'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ EdgesTCPClient

Returns a new instance of EdgesTCPClient.



15
16
17
 
# File 'lib/ngrokapi/services/edges_tcp_client.rb', line 15

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



13
14
15
 
# File 'lib/ngrokapi/services/edges_tcp_client.rb', line 13

def client
  @client
end

Instance Method Details

#create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge

Create a TCP Edge

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

Parameters:

  • description (string) (defaults to: "") —

    human-readable description of what this edge will be used for; optional, max 255 bytes.

  • metadata (string) (defaults to: "") —

    arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.

  • hostports (List<string>) (defaults to: nil) —

    hostports served by this edge

  • backend (EndpointBackendMutate) (defaults to: nil) —

    edge modules

  • ip_restriction (EndpointIPPolicyMutate) (defaults to: nil)

Returns:



30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/ngrokapi/services/edges_tcp_client.rb', line 30

def create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil)
  path = '/edges/tcp'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:hostports] = hostports if hostports
  data[:backend] = backend if backend
  data[:ip_restriction] = ip_restriction if ip_restriction
  result = @client.post(path % replacements, data: data)
  NgrokAPI::Models::TCPEdge.new(client: self, result: result)
end

#delete(id: "") ⇒ NgrokAPI::Models::Empty

Delete a TCP Edge by ID

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

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



202
203
204
205
206
207
208
 
# File 'lib/ngrokapi/services/edges_tcp_client.rb', line 202

def delete(id: "")
  path = '/edges/tcp/%{id}'
  replacements = {
    id: id,
  }
  @client.delete(path % replacements)
end

#delete!(id: "") ⇒ NgrokAPI::Models::Empty

Delete a TCP Edge by ID Throws an exception if API error.

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

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



218
219
220
221
222
223
224
 
# File 'lib/ngrokapi/services/edges_tcp_client.rb', line 218

def delete!(id: "")
  path = '/edges/tcp/%{id}'
  replacements = {
    id: id,
  }
  @client.delete(path % replacements, danger: true)
end

#get(id: "") ⇒ NgrokAPI::Models::TCPEdge

Get a TCP Edge by ID

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

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:



51
52
53
54
55
56
57
58
59
 
# File 'lib/ngrokapi/services/edges_tcp_client.rb', line 51

def get(id: "")
  path = '/edges/tcp/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data)
  NgrokAPI::Models::TCPEdge.new(client: self, result: result)
end

#get!(id: "") ⇒ NgrokAPI::Models::TCPEdge

Get a TCP Edge by ID Throws an exception if API error.

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

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:



69
70
71
72
73
74
75
76
77
 
# File 'lib/ngrokapi/services/edges_tcp_client.rb', line 69

def get!(id: "")
  path = '/edges/tcp/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data, danger: true)
  NgrokAPI::Models::TCPEdge.new(client: self, result: result)
end

#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable

Returns a list of all TCP Edges on this account

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

Parameters:

  • before_id (string) (defaults to: nil)
  • limit (string) (defaults to: nil)
  • url (string) (defaults to: nil) —

    optional and mutually exclusive from before_id and limit

Returns:



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/ngrokapi/services/edges_tcp_client.rb', line 88

def list(before_id: nil, limit: nil,
         url: nil)
  result = @client.list(
    before_id: before_id,
    limit: limit,
    url: url,
    path: PATH
  )

  NgrokAPI::Models::Listable.new(
    client: self,
    result: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::TCPEdge
  )
end

#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable

Returns a list of all TCP Edges on this account Throws an exception if API error.

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

Parameters:

  • before_id (string) (defaults to: nil)
  • limit (string) (defaults to: nil)
  • url (string) (defaults to: nil) —

    optional and mutually exclusive from before_id and limit

Returns:



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/ngrokapi/services/edges_tcp_client.rb', line 115

def list!(before_id: nil, limit: nil,
          url: nil)
  result = @client.list(
    before_id: before_id,
    limit: limit,
    danger: true,
    url: url,
    path: PATH
  )

  NgrokAPI::Models::Listable.new(
    client: self,
    result: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::TCPEdge,
    danger: true
  )
end

#update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge

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

Parameters:

  • id (string) (defaults to: "") —

    unique identifier of this edge

  • description (string) (defaults to: nil) —

    human-readable description of what this edge will be used for; optional, max 255 bytes.

  • metadata (string) (defaults to: nil) —

    arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.

  • hostports (List<string>) (defaults to: nil) —

    hostports served by this edge

  • backend (EndpointBackendMutate) (defaults to: nil) —

    edge modules

  • ip_restriction (EndpointIPPolicyMutate) (defaults to: nil)

Returns:



149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/ngrokapi/services/edges_tcp_client.rb', line 149

def update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil)
  path = '/edges/tcp/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:hostports] = hostports if hostports
  data[:backend] = backend if backend
  data[:ip_restriction] = ip_restriction if ip_restriction
  result = @client.patch(path % replacements, data: data)
  NgrokAPI::Models::TCPEdge.new(client: self, result: result)
end

#update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge

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. Throws an exception if API error.

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

Parameters:

  • id (string) (defaults to: "") —

    unique identifier of this edge

  • description (string) (defaults to: nil) —

    human-readable description of what this edge will be used for; optional, max 255 bytes.

  • metadata (string) (defaults to: nil) —

    arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.

  • hostports (List<string>) (defaults to: nil) —

    hostports served by this edge

  • backend (EndpointBackendMutate) (defaults to: nil) —

    edge modules

  • ip_restriction (EndpointIPPolicyMutate) (defaults to: nil)

Returns:



180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/ngrokapi/services/edges_tcp_client.rb', line 180

def update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil)
  path = '/edges/tcp/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:hostports] = hostports if hostports
  data[:backend] = backend if backend
  data[:ip_restriction] = ip_restriction if ip_restriction
  result = @client.patch(path % replacements, data: data, danger: true)
  NgrokAPI::Models::TCPEdge.new(client: self, result: result)
end