Class: NgrokAPI::Services::TunnelGroupBackendsClient

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

Overview

A Tunnel Group Backend balances traffic among all online tunnels that match a label selector.

https://ngrok.com/docs/api#api-tunnel-group-backends

Constant Summary collapse

PATH =

The API path for the requests

'/backends/tunnel_group'
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:) ⇒ TunnelGroupBackendsClient

Returns a new instance of TunnelGroupBackendsClient.



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

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



16
17
18
 
# File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 16

def client
  @client
end

Instance Method Details

#create(description: "", metadata: "", labels: {}) ⇒ NgrokAPI::Models::TunnelGroupBackend

Create a new TunnelGroup backend

https://ngrok.com/docs/api#api-tunnel-group-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

  • labels (Map<string, string>) (defaults to: {}) —

    labels to watch for tunnels on, e.g. app->foo, dc->bar

Returns:



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

def create(description: "", metadata: "", labels: {})
  path = '/backends/tunnel_group'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:labels] = labels if labels
  result = @client.post(path % replacements, data: data)
  NgrokAPI::Models::TunnelGroupBackend.new(client: self, result: result)
end

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

Delete a TunnelGroup backend by ID. TODO what if used?

https://ngrok.com/docs/api#api-tunnel-group-backends-delete

Parameters:

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

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



50
51
52
53
54
55
56
 
# File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 50

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

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

Delete a TunnelGroup backend by ID. TODO what if used? Throws an exception if API error.

https://ngrok.com/docs/api#api-tunnel-group-backends-delete

Parameters:

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

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



66
67
68
69
70
71
72
 
# File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 66

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

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

Get detailed information about a TunnelGroup backend by ID

https://ngrok.com/docs/api#api-tunnel-group-backends-get

Parameters:

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

    a resource identifier

Returns:



81
82
83
84
85
86
87
88
89
 
# File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 81

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

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

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

https://ngrok.com/docs/api#api-tunnel-group-backends-get

Parameters:

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

    a resource identifier

Returns:



99
100
101
102
103
104
105
106
107
 
# File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 99

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

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

List all TunnelGroup backends on this account

https://ngrok.com/docs/api#api-tunnel-group-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:



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

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

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

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

https://ngrok.com/docs/api#api-tunnel-group-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:



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

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

#update(id: "", description: nil, metadata: nil, labels: {}) ⇒ NgrokAPI::Models::TunnelGroupBackend

Update TunnelGroup backend by ID

https://ngrok.com/docs/api#api-tunnel-group-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

  • labels (Map<string, string>) (defaults to: {}) —

    labels to watch for tunnels on, e.g. app->foo, dc->bar

Returns:



174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 174

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

#update!(id: "", description: nil, metadata: nil, labels: {}) ⇒ NgrokAPI::Models::TunnelGroupBackend

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

https://ngrok.com/docs/api#api-tunnel-group-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

  • labels (Map<string, string>) (defaults to: {}) —

    labels to watch for tunnels on, e.g. app->foo, dc->bar

Returns:



198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 198

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