Class: NgrokAPI::Services::TCPEdgeBackendModuleClient

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

Overview

https://ngrok.com/docs/api#api-tcp-edge-backend-module

Constant Summary collapse

PATH =

The API path for the requests

'/edges/tcp/%{id}/backend'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ TCPEdgeBackendModuleClient

Returns a new instance of TCPEdgeBackendModuleClient.



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

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



11
12
13
 
# File 'lib/ngrokapi/services/tcp_edge_backend_module_client.rb', line 11

def client
  @client
end

Instance Method Details

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

https://ngrok.com/docs/api#api-tcp-edge-backend-module-delete

Parameters:

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

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



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

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

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

https://ngrok.com/docs/api#api-tcp-edge-backend-module-delete

Parameters:

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

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



97
98
99
100
101
102
103
 
# File 'lib/ngrokapi/services/tcp_edge_backend_module_client.rb', line 97

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

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

https://ngrok.com/docs/api#api-tcp-edge-backend-module-get

Parameters:

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

    a resource identifier

Returns:



54
55
56
57
58
59
60
61
62
 
# File 'lib/ngrokapi/services/tcp_edge_backend_module_client.rb', line 54

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

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

https://ngrok.com/docs/api#api-tcp-edge-backend-module-get

Parameters:

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

    a resource identifier

Returns:



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

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

#replace(id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointBackend

https://ngrok.com/docs/api#api-tcp-edge-backend-module-replace

Parameters:

  • id (string) (defaults to: "")
  • a_module (EndpointBackendMutate) (defaults to: nil)

Returns:



23
24
25
26
27
28
29
30
31
 
# File 'lib/ngrokapi/services/tcp_edge_backend_module_client.rb', line 23

def replace(id: "", a_module: nil)
  path = '/edges/tcp/%{id}/backend'
  replacements = {
    id: id,
  }
  data = a_module
  result = @client.put(path % replacements, data: data)
  NgrokAPI::Models::EndpointBackend.new(client: self, attrs: result)
end

#replace!(id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointBackend

https://ngrok.com/docs/api#api-tcp-edge-backend-module-replace

Parameters:

  • id (string) (defaults to: "")
  • a_module (EndpointBackendMutate) (defaults to: nil)

Returns:



39
40
41
42
43
44
45
46
47
 
# File 'lib/ngrokapi/services/tcp_edge_backend_module_client.rb', line 39

def replace!(id: "", a_module: nil)
  path = '/edges/tcp/%{id}/backend'
  replacements = {
    id: id,
  }
  data = a_module
  result = @client.put(path % replacements, data: data, danger: true)
  NgrokAPI::Models::EndpointBackend.new(client: self, attrs: result)
end