Class: NgrokAPI::Services::EndpointsClient

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

Overview

Endpoints provides an API for querying the endpoint objects which define what tunnel or edge is used to serve a hostport. Only active endpoints associated with a tunnel or backend are returned.

https://ngrok.com/docs/api#api-endpoints

Constant Summary collapse

PATH =

The API path for the requests

'/endpoints'
LIST_PROPERTY =

The List Property from the resulting API for list calls

'endpoints'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ EndpointsClient

Returns a new instance of EndpointsClient.



21
22
23
 
# File 'lib/ngrokapi/services/endpoints_client.rb', line 21

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



19
20
21
 
# File 'lib/ngrokapi/services/endpoints_client.rb', line 19

def client
  @client
end

Instance Method Details

#create(url: "", type: "", traffic_policy: "", description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint

Create an endpoint, currently available only for cloud endpoints

https://ngrok.com/docs/api#api-endpoints-create

Parameters:

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

    the url of the endpoint

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

    whether the endpoint is ephemeral (served directly by an agent-initiated tunnel) or edge (served by an edge) or cloud (represents a cloud endpoint)

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

    The traffic policy attached to this endpoint

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

    user-supplied description of the associated tunnel

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

    user-supplied metadata of the associated tunnel or edge object

  • bindings (List<string>) (defaults to: nil) —

    the bindings associated with this endpoint

Returns:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/ngrokapi/services/endpoints_client.rb', line 37

def create(url: "", type: "", traffic_policy: "", description: nil, metadata: nil, bindings: nil)
  path = '/endpoints'
  replacements = {
  }
  data = {}
  data[:url] = url if url
  data[:type] = type if type
  data[:traffic_policy] = traffic_policy if traffic_policy
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:bindings] = bindings if bindings
  result = @client.post(path % replacements, data: data)
  NgrokAPI::Models::Endpoint.new(client: self, attrs: result)
end

#create!(url: "", type: "", traffic_policy: "", description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint

Create an endpoint, currently available only for cloud endpoints Throws an exception if API error.

https://ngrok.com/docs/api#api-endpoints-create

Parameters:

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

    the url of the endpoint

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

    whether the endpoint is ephemeral (served directly by an agent-initiated tunnel) or edge (served by an edge) or cloud (represents a cloud endpoint)

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

    The traffic policy attached to this endpoint

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

    user-supplied description of the associated tunnel

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

    user-supplied metadata of the associated tunnel or edge object

  • bindings (List<string>) (defaults to: nil) —

    the bindings associated with this endpoint

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/ngrokapi/services/endpoints_client.rb', line 65

def create!(url: "", type: "", traffic_policy: "", description: nil, metadata: nil, bindings: nil)
  path = '/endpoints'
  replacements = {
  }
  data = {}
  data[:url] = url if url
  data[:type] = type if type
  data[:traffic_policy] = traffic_policy if traffic_policy
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:bindings] = bindings if bindings
  result = @client.post(path % replacements, data: data, danger: true)
  NgrokAPI::Models::Endpoint.new(client: self, attrs: result)
end

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

Delete an Endpoint by ID, currently available only for cloud endpoints

https://ngrok.com/docs/api#api-endpoints-delete

Parameters:

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

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



230
231
232
233
234
235
236
 
# File 'lib/ngrokapi/services/endpoints_client.rb', line 230

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

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

Delete an Endpoint by ID, currently available only for cloud endpoints Throws an exception if API error.

https://ngrok.com/docs/api#api-endpoints-delete

Parameters:

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

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



246
247
248
249
250
251
252
 
# File 'lib/ngrokapi/services/endpoints_client.rb', line 246

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

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

Get the status of an endpoint by ID

https://ngrok.com/docs/api#api-endpoints-get

Parameters:

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

    a resource identifier

Returns:



140
141
142
143
144
145
146
147
148
 
# File 'lib/ngrokapi/services/endpoints_client.rb', line 140

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

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

Get the status of an endpoint by ID Throws an exception if API error.

https://ngrok.com/docs/api#api-endpoints-get

Parameters:

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

    a resource identifier

Returns:



158
159
160
161
162
163
164
165
166
 
# File 'lib/ngrokapi/services/endpoints_client.rb', line 158

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

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

List all active endpoints on the account

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/ngrokapi/services/endpoints_client.rb', line 89

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

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

List all active endpoints on the account Throws an exception if API error.

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



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/ngrokapi/services/endpoints_client.rb', line 115

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

#update(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint

Update an Endpoint by ID, currently available only for cloud endpoints

https://ngrok.com/docs/api#api-endpoints-update

Parameters:

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

    unique endpoint resource identifier

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

    the url of the endpoint

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

    The traffic policy attached to this endpoint

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

    user-supplied description of the associated tunnel

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

    user-supplied metadata of the associated tunnel or edge object

  • bindings (List<string>) (defaults to: nil) —

    the bindings associated with this endpoint

Returns:



180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/ngrokapi/services/endpoints_client.rb', line 180

def update(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil)
  path = '/endpoints/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:url] = url if url
  data[:traffic_policy] = traffic_policy if traffic_policy
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:bindings] = bindings if bindings
  result = @client.patch(path % replacements, data: data)
  NgrokAPI::Models::Endpoint.new(client: self, attrs: result)
end

#update!(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint

Update an Endpoint by ID, currently available only for cloud endpoints Throws an exception if API error.

https://ngrok.com/docs/api#api-endpoints-update

Parameters:

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

    unique endpoint resource identifier

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

    the url of the endpoint

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

    The traffic policy attached to this endpoint

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

    user-supplied description of the associated tunnel

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

    user-supplied metadata of the associated tunnel or edge object

  • bindings (List<string>) (defaults to: nil) —

    the bindings associated with this endpoint

Returns:



208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/ngrokapi/services/endpoints_client.rb', line 208

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