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.

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

#clientObject (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

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] =  if 
  data[:labels] = labels if labels
  result = @client.post(path % replacements, data: data)
  NgrokAPI::Models::TunnelGroupBackend.new(client: self, attrs: result)
end

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

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

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:



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

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

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

Delete a TunnelGroup backend by ID.

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



72
73
74
75
76
77
78
# File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 72

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. Throws an exception if API error.

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



88
89
90
91
92
93
94
# File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 88

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

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

Parameters:

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

    a resource identifier

Returns:



103
104
105
106
107
108
109
110
111
# File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 103

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

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

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

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

Parameters:

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

    a resource identifier

Returns:



121
122
123
124
125
126
127
128
129
# File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 121

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

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

List all TunnelGroup backends on this account

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:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
# File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 140

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

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:



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
# File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 166

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

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

Update TunnelGroup backend by ID

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:



194
195
196
197
198
199
200
201
202
203
204
205
# File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 194

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

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

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

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:



218
219
220
221
222
223
224
225
226
227
228
229
# File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 218

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