class NgrokAPI::Services::TCPEdgeBackendModuleClient

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

Constants

PATH

The API path for the requests

Attributes

client[R]

Public Class Methods

new(client:) click to toggle source
# File lib/ngrokapi/services/tcp_edge_backend_module_client.rb, line 13
def initialize(client:)
  @client = client
end

Public Instance Methods

delete(id: "") click to toggle source

@param [string] id a resource identifier @return [NgrokAPI::Models::Empty] result from the API request

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

# 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: "") click to toggle source

@param [string] id a resource identifier @return [NgrokAPI::Models::Empty] result from the API request

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

# 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: "") click to toggle source

@param [string] id a resource identifier @return [NgrokAPI::Models::EndpointBackend] result from the API request

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

# 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: "") click to toggle source

@param [string] id a resource identifier @return [NgrokAPI::Models::EndpointBackend] result from the API request

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

# 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) click to toggle source

@param [string] id @param [EndpointBackendMutate] a_module @return [NgrokAPI::Models::EndpointBackend] result from the API request

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

# 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) click to toggle source

@param [string] id @param [EndpointBackendMutate] a_module @return [NgrokAPI::Models::EndpointBackend] result from the API request

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

# 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