Class: NgrokAPI::Services::EndpointsClient
- Inherits:
-
Object
- Object
- NgrokAPI::Services::EndpointsClient
- 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.
Constant Summary collapse
- LIST_PROPERTY =
The List Property from the resulting API for list calls
'endpoints'
- PATH =
The API path for the requests
'/endpoints'
Instance Attribute Summary collapse
-
#client ⇒ Object
readonly
Returns the value of attribute client.
Instance Method Summary collapse
-
#get(id: "") ⇒ NgrokAPI::Models::Endpoint
Get the status of an endpoint by ID.
-
#get!(id: "") ⇒ NgrokAPI::Models::Endpoint
Get the status of an endpoint by ID Throws an exception if API error.
-
#initialize(client:) ⇒ EndpointsClient
constructor
A new instance of EndpointsClient.
-
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all active endpoints on the account.
-
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all active endpoints on the account Throws an exception if API error.
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
#get(id: "") ⇒ NgrokAPI::Models::Endpoint
Get the status of an endpoint by ID
85 86 87 88 89 90 91 92 93 |
# File 'lib/ngrokapi/services/endpoints_client.rb', line 85 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.
103 104 105 106 107 108 109 110 111 |
# File 'lib/ngrokapi/services/endpoints_client.rb', line 103 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
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
# File 'lib/ngrokapi/services/endpoints_client.rb', line 34 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.
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/ngrokapi/services/endpoints_client.rb', line 60 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 |