Class: NgrokAPI::Services::EdgesTCPClient

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

Overview

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.



17
18
19
 
# File 'lib/ngrokapi/services/edges_tcp_client.rb', line 17

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



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

def client
  @client
end

Instance Method Details

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

Create a TCP Edge

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)
  • policy (EndpointPolicy) (defaults to: nil) —

    the traffic policy associated with this edge or null

Returns:



33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/ngrokapi/services/edges_tcp_client.rb', line 33

def create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, policy: 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
  data[:policy] = policy if policy
  result = @client.post(path % replacements, data: data)
  NgrokAPI::Models::TCPEdge.new(client: self, attrs: result)
end

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

Create a TCP Edge Throws an exception if API error.

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)
  • policy (EndpointPolicy) (defaults to: nil) —

    the traffic policy associated with this edge or null

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/ngrokapi/services/edges_tcp_client.rb', line 61

def create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, policy: 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
  data[:policy] = policy if policy
  result = @client.post(path % replacements, data: data, danger: true)
  NgrokAPI::Models::TCPEdge.new(client: self, attrs: result)
end

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

Delete a TCP Edge by ID

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



236
237
238
239
240
241
242
 
# File 'lib/ngrokapi/services/edges_tcp_client.rb', line 236

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.

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



252
253
254
255
256
257
258
 
# File 'lib/ngrokapi/services/edges_tcp_client.rb', line 252

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

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

Parameters:

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

    a resource identifier

Returns:



83
84
85
86
87
88
89
90
91
 
# File 'lib/ngrokapi/services/edges_tcp_client.rb', line 83

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

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

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

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

Parameters:

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

    a resource identifier

Returns:



101
102
103
104
105
106
107
108
109
 
# File 'lib/ngrokapi/services/edges_tcp_client.rb', line 101

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, attrs: result)
end

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

Returns a list of all TCP Edges on this account

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:



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/ngrokapi/services/edges_tcp_client.rb', line 120

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,
    attrs: 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.

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:



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

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,
    attrs: 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, policy: 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.

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)
  • policy (EndpointPolicy) (defaults to: nil) —

    the traffic policy associated with this edge or null

Returns:



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

def update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: 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
  data[:policy] = policy if policy
  result = @client.patch(path % replacements, data: data)
  NgrokAPI::Models::TCPEdge.new(client: self, attrs: result)
end

#update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: 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.

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)
  • policy (EndpointPolicy) (defaults to: nil) —

    the traffic policy associated with this edge or null

Returns:



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/ngrokapi/services/edges_tcp_client.rb', line 213

def update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: 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
  data[:policy] = policy if policy
  result = @client.patch(path % replacements, data: data, danger: true)
  NgrokAPI::Models::TCPEdge.new(client: self, attrs: result)
end