Class: NgrokAPI::Services::AgentIngressesClient
- Inherits:
-
Object
- Object
- NgrokAPI::Services::AgentIngressesClient
- Defined in:
- lib/ngrokapi/services/agent_ingresses_client.rb
Overview
Constant Summary collapse
- PATH =
The API path for the requests
'/agent_ingresses'
- LIST_PROPERTY =
The List Property from the resulting API for list calls
'ingresses'
Instance Attribute Summary collapse
-
#client ⇒ Object
readonly
Returns the value of attribute client.
Instance Method Summary collapse
-
#create(description: "", metadata: "", domain:, certificate_management_policy: nil) ⇒ NgrokAPI::Models::AgentIngress
Create a new Agent Ingress.
-
#create!(description: "", metadata: "", domain:, certificate_management_policy: nil) ⇒ NgrokAPI::Models::AgentIngress
Create a new Agent Ingress.
-
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete an Agent Ingress by ID.
-
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete an Agent Ingress by ID Throws an exception if API error.
-
#get(id: "") ⇒ NgrokAPI::Models::AgentIngress
Get the details of an Agent Ingress by ID.
-
#get!(id: "") ⇒ NgrokAPI::Models::AgentIngress
Get the details of an Agent Ingress by ID.
-
#initialize(client:) ⇒ AgentIngressesClient
constructor
A new instance of AgentIngressesClient.
-
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all Agent Ingresses owned by this account.
-
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all Agent Ingresses owned by this account Throws an exception if API error.
-
#update(id: "", description: nil, metadata: nil, certificate_management_policy: nil) ⇒ NgrokAPI::Models::AgentIngress
Update attributes of an Agent Ingress by ID.
-
#update!(id: "", description: nil, metadata: nil, certificate_management_policy: nil) ⇒ NgrokAPI::Models::AgentIngress
Update attributes of an Agent Ingress by ID.
Constructor Details
#initialize(client:) ⇒ AgentIngressesClient
Returns a new instance of AgentIngressesClient.
17 18 19 |
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 17 def initialize(client:) @client = client end |
Instance Attribute Details
#client ⇒ Object (readonly)
Returns the value of attribute client.
15 16 17 |
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 15 def client @client end |
Instance Method Details
#create(description: "", metadata: "", domain:, certificate_management_policy: nil) ⇒ NgrokAPI::Models::AgentIngress
Create a new Agent Ingress. The ngrok agent can be configured to connect to ngrok via the new set of addresses on the returned Agent Ingress.
32 33 34 35 36 37 38 39 40 41 42 43 |
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 32 def create(description: "", metadata: "", domain:, certificate_management_policy: nil) path = '/agent_ingresses' replacements = { } data = {} data[:description] = description if description data[:metadata] = if data[:domain] = domain if domain data[:certificate_management_policy] = certificate_management_policy if certificate_management_policy result = @client.post(path % replacements, data: data) NgrokAPI::Models::AgentIngress.new(client: self, attrs: result) end |
#create!(description: "", metadata: "", domain:, certificate_management_policy: nil) ⇒ NgrokAPI::Models::AgentIngress
Create a new Agent Ingress. The ngrok agent can be configured to connect to ngrok via the new set of addresses on the returned Agent Ingress. Throws an exception if API error.
57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 57 def create!(description: "", metadata: "", domain:, certificate_management_policy: nil) path = '/agent_ingresses' replacements = { } data = {} data[:description] = description if description data[:metadata] = if data[:domain] = domain if domain data[:certificate_management_policy] = certificate_management_policy if certificate_management_policy result = @client.post(path % replacements, data: data, danger: true) NgrokAPI::Models::AgentIngress.new(client: self, attrs: result) end |
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete an Agent Ingress by ID
77 78 79 80 81 82 83 |
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 77 def delete(id: "") path = '/agent_ingresses/%{id}' replacements = { id: id, } @client.delete(path % replacements) end |
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete an Agent Ingress by ID Throws an exception if API error.
93 94 95 96 97 98 99 |
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 93 def delete!(id: "") path = '/agent_ingresses/%{id}' replacements = { id: id, } @client.delete(path % replacements, danger: true) end |
#get(id: "") ⇒ NgrokAPI::Models::AgentIngress
Get the details of an Agent Ingress by ID.
108 109 110 111 112 113 114 115 116 |
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 108 def get(id: "") path = '/agent_ingresses/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data) NgrokAPI::Models::AgentIngress.new(client: self, attrs: result) end |
#get!(id: "") ⇒ NgrokAPI::Models::AgentIngress
Get the details of an Agent Ingress by ID. Throws an exception if API error.
126 127 128 129 130 131 132 133 134 |
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 126 def get!(id: "") path = '/agent_ingresses/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data, danger: true) NgrokAPI::Models::AgentIngress.new(client: self, attrs: result) end |
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all Agent Ingresses owned by this account
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 145 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::AgentIngress ) end |
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all Agent Ingresses owned by this account Throws an exception if API error.
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 175 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::AgentIngress, danger: true ) end |
#update(id: "", description: nil, metadata: nil, certificate_management_policy: nil) ⇒ NgrokAPI::Models::AgentIngress
Update attributes of an Agent Ingress by ID.
207 208 209 210 211 212 213 214 215 216 217 218 |
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 207 def update(id: "", description: nil, metadata: nil, certificate_management_policy: nil) path = '/agent_ingresses/%{id}' replacements = { id: id, } data = {} data[:description] = description if description data[:metadata] = if data[:certificate_management_policy] = certificate_management_policy if certificate_management_policy result = @client.patch(path % replacements, data: data) NgrokAPI::Models::AgentIngress.new(client: self, attrs: result) end |
#update!(id: "", description: nil, metadata: nil, certificate_management_policy: nil) ⇒ NgrokAPI::Models::AgentIngress
Update attributes of an Agent Ingress by ID. Throws an exception if API error.
231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 231 def update!(id: "", description: nil, metadata: nil, certificate_management_policy: nil) path = '/agent_ingresses/%{id}' replacements = { id: id, } data = {} data[:description] = description if description data[:metadata] = if data[:certificate_management_policy] = certificate_management_policy if certificate_management_policy result = @client.patch(path % replacements, data: data, danger: true) NgrokAPI::Models::AgentIngress.new(client: self, attrs: result) end |