Class: NgrokAPI::Services::StaticBackendsClient

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

Overview

A static backend sends traffic to a TCP address (hostname and port) that is reachable on the public internet.

ngrok.com/docs/api#api-static-backends

Constant Summary collapse

PATH =

The API path for the requests

'/backends/static'
LIST_PROPERTY =

The List Property from the resulting API for list calls

'backends'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ StaticBackendsClient

Returns a new instance of StaticBackendsClient.



20
21
22
 
# File 'lib/ngrokapi/services/static_backends_client.rb', line 20

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



18
19
20
 
# File 'lib/ngrokapi/services/static_backends_client.rb', line 18

def client
  @client
end

Instance Method Details

#create(description: "", metadata: "", address: "", tls: nil) ⇒ NgrokAPI::Models::StaticBackend

Create a new static backend

ngrok.com/docs/api#api-static-backends-create

Parameters:

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

    human-readable description of this backend. Optional

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

    arbitrary user-defined machine-readable data of this backend. Optional

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

    the address to forward to

  • tls (StaticBackendTLS) (defaults to: nil) —

    tls configuration to use

Returns:



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

def create(description: "", metadata: "", address: "", tls: nil)
  path = '/backends/static'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:address] = address if address
  data[:tls] = tls if tls
  result = @client.post(path % replacements, data: data)
  NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
end

#create!(description: "", metadata: "", address: "", tls: nil) ⇒ NgrokAPI::Models::StaticBackend

Create a new static backend Throws an exception if API error.

ngrok.com/docs/api#api-static-backends-create

Parameters:

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

    human-readable description of this backend. Optional

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

    arbitrary user-defined machine-readable data of this backend. Optional

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

    the address to forward to

  • tls (StaticBackendTLS) (defaults to: nil) —

    tls configuration to use

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/ngrokapi/services/static_backends_client.rb', line 58

def create!(description: "", metadata: "", address: "", tls: nil)
  path = '/backends/static'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:address] = address if address
  data[:tls] = tls if tls
  result = @client.post(path % replacements, data: data, danger: true)
  NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
end

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

Delete a static backend by ID.

ngrok.com/docs/api#api-static-backends-delete

Parameters:

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

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



78
79
80
81
82
83
84
 
# File 'lib/ngrokapi/services/static_backends_client.rb', line 78

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

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

Delete a static backend by ID. Throws an exception if API error.

ngrok.com/docs/api#api-static-backends-delete

Parameters:

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

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



94
95
96
97
98
99
100
 
# File 'lib/ngrokapi/services/static_backends_client.rb', line 94

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

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

Get detailed information about a static backend by ID

ngrok.com/docs/api#api-static-backends-get

Parameters:

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

    a resource identifier

Returns:



109
110
111
112
113
114
115
116
117
 
# File 'lib/ngrokapi/services/static_backends_client.rb', line 109

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

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

Get detailed information about a static backend by ID Throws an exception if API error.

ngrok.com/docs/api#api-static-backends-get

Parameters:

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

    a resource identifier

Returns:



127
128
129
130
131
132
133
134
135
 
# File 'lib/ngrokapi/services/static_backends_client.rb', line 127

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

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

List all static backends on this account

ngrok.com/docs/api#api-static-backends-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
 
# File 'lib/ngrokapi/services/static_backends_client.rb', line 146

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::StaticBackend
  )
end

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

List all static backends on this account Throws an exception if API error.

ngrok.com/docs/api#api-static-backends-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:



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/ngrokapi/services/static_backends_client.rb', line 172

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::StaticBackend,
    danger: true
  )
end

#update(id: "", description: nil, metadata: nil, address: "", tls: nil) ⇒ NgrokAPI::Models::StaticBackend

Update static backend by ID

ngrok.com/docs/api#api-static-backends-update

Parameters:

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

    human-readable description of this backend. Optional

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

    arbitrary user-defined machine-readable data of this backend. Optional

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

    the address to forward to

  • tls (StaticBackendTLS) (defaults to: nil) —

    tls configuration to use

Returns:



201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/ngrokapi/services/static_backends_client.rb', line 201

def update(id: "", description: nil, metadata: nil, address: "", tls: nil)
  path = '/backends/static/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:address] = address if address
  data[:tls] = tls if tls
  result = @client.patch(path % replacements, data: data)
  NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
end

#update!(id: "", description: nil, metadata: nil, address: "", tls: nil) ⇒ NgrokAPI::Models::StaticBackend

Update static backend by ID Throws an exception if API error.

ngrok.com/docs/api#api-static-backends-update

Parameters:

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

    human-readable description of this backend. Optional

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

    arbitrary user-defined machine-readable data of this backend. Optional

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

    the address to forward to

  • tls (StaticBackendTLS) (defaults to: nil) —

    tls configuration to use

Returns:



227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/ngrokapi/services/static_backends_client.rb', line 227

def update!(id: "", description: nil, metadata: nil, address: "", tls: nil)
  path = '/backends/static/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:address] = address if address
  data[:tls] = tls if tls
  result = @client.patch(path % replacements, data: data, danger: true)
  NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
end