ngrok-api 0.16.0 → 0.17.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (373) hide show
  1. checksums.yaml +4 -4
  2. data/doc/NgrokAPI/Client.html +270 -180
  3. data/doc/NgrokAPI/Error.html +2 -2
  4. data/doc/NgrokAPI/Errors/NotFoundError.html +2 -2
  5. data/doc/NgrokAPI/Errors.html +2 -2
  6. data/doc/NgrokAPI/HttpClient.html +2 -2
  7. data/doc/NgrokAPI/Models/APIKey.html +2 -2
  8. data/doc/NgrokAPI/Models/AWSAuth.html +2 -2
  9. data/doc/NgrokAPI/Models/AWSCredentials.html +2 -2
  10. data/doc/NgrokAPI/Models/AWSRole.html +2 -2
  11. data/doc/NgrokAPI/Models/AbuseReport.html +2 -2
  12. data/doc/NgrokAPI/Models/AbuseReportHostname.html +2 -2
  13. data/doc/NgrokAPI/Models/AgentIngress.html +2 -2
  14. data/doc/NgrokAPI/Models/CertificateAuthority.html +2 -2
  15. data/doc/NgrokAPI/Models/Credential.html +2 -2
  16. data/doc/NgrokAPI/Models/Endpoint.html +1431 -0
  17. data/{docs/NgrokAPI/Models/EndpointLogging.html → doc/NgrokAPI/Models/EndpointBackend.html} +41 -41
  18. data/doc/NgrokAPI/Models/{EndpointLoggingMutate.html → EndpointBackendMutate.html} +41 -41
  19. data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
  20. data/doc/NgrokAPI/Models/EndpointCompression.html +2 -2
  21. data/doc/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
  22. data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
  23. data/doc/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
  24. data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
  25. data/doc/NgrokAPI/Models/EndpointOAuth.html +2 -2
  26. data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
  27. data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
  28. data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
  29. data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
  30. data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
  31. data/doc/NgrokAPI/Models/EndpointOIDC.html +2 -2
  32. data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
  33. data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
  34. data/doc/NgrokAPI/Models/EndpointSAML.html +2 -2
  35. data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
  36. data/doc/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
  37. data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +617 -0
  38. data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
  39. data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +543 -0
  40. data/doc/NgrokAPI/Models/EventDestination.html +6 -6
  41. data/doc/NgrokAPI/Models/EventSource.html +2 -2
  42. data/doc/NgrokAPI/Models/EventSourceList.html +2 -2
  43. data/doc/NgrokAPI/Models/EventSourceReplace.html +2 -2
  44. data/doc/NgrokAPI/Models/EventSubscription.html +2 -2
  45. data/doc/NgrokAPI/Models/EventTarget.html +2 -2
  46. data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
  47. data/doc/NgrokAPI/Models/EventTargetFirehose.html +2 -2
  48. data/doc/NgrokAPI/Models/EventTargetKinesis.html +2 -2
  49. data/doc/NgrokAPI/Models/FailoverBackend.html +1075 -0
  50. data/doc/NgrokAPI/Models/HTTPResponseBackend.html +1231 -0
  51. data/{docs/NgrokAPI/Models/EventStream.html → doc/NgrokAPI/Models/HTTPSEdge.html} +118 -118
  52. data/doc/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +202 -264
  53. data/doc/NgrokAPI/Models/IPPolicy.html +2 -2
  54. data/doc/NgrokAPI/Models/IPPolicyRule.html +96 -22
  55. data/doc/NgrokAPI/Models/IPRestriction.html +2 -2
  56. data/doc/NgrokAPI/Models/Listable.html +2 -2
  57. data/doc/NgrokAPI/Models/Ref.html +2 -2
  58. data/doc/NgrokAPI/Models/ReservedAddr.html +2 -2
  59. data/doc/NgrokAPI/Models/ReservedDomain.html +2 -2
  60. data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
  61. data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
  62. data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
  63. data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
  64. data/doc/NgrokAPI/Models/SSHCredential.html +2 -2
  65. data/doc/NgrokAPI/Models/SSHHostCertificate.html +2 -2
  66. data/doc/NgrokAPI/Models/SSHUserCertificate.html +2 -2
  67. data/doc/NgrokAPI/Models/TCPEdge.html +1235 -0
  68. data/doc/NgrokAPI/Models/TLSCertificate.html +2 -2
  69. data/doc/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
  70. data/doc/NgrokAPI/Models/TLSEdge.html +1395 -0
  71. data/doc/NgrokAPI/Models/Tunnel.html +313 -17
  72. data/doc/NgrokAPI/Models/TunnelGroupBackend.html +1149 -0
  73. data/doc/NgrokAPI/Models/TunnelSession.html +2 -2
  74. data/doc/NgrokAPI/Models/WeightedBackend.html +1075 -0
  75. data/doc/NgrokAPI/Models.html +4 -4
  76. data/doc/NgrokAPI/PagedIterator.html +2 -2
  77. data/doc/NgrokAPI/Services/APIKeysClient.html +2 -2
  78. data/doc/NgrokAPI/Services/AbuseReportsClient.html +2 -2
  79. data/doc/NgrokAPI/Services/AgentIngressesClient.html +2 -2
  80. data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +2 -2
  81. data/doc/NgrokAPI/Services/CredentialsClient.html +2 -2
  82. data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1153 -0
  83. data/doc/NgrokAPI/Services/{EndpointCircuitBreakerModuleClient.html → EdgeRouteCircuitBreakerModuleClient.html} +206 -96
  84. data/{docs/NgrokAPI/Services/EndpointCompressionModuleClient.html → doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html} +206 -96
  85. data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1153 -0
  86. data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +1153 -0
  87. data/{docs/NgrokAPI/Services/EndpointOIDCModuleClient.html → doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html} +206 -96
  88. data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1153 -0
  89. data/{docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html → doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html} +206 -96
  90. data/{docs/NgrokAPI/Services/EndpointSAMLModuleClient.html → doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html} +206 -96
  91. data/doc/NgrokAPI/Services/{EndpointWebhookValidationModuleClient.html → EdgeRouteWebhookVerificationModuleClient.html} +206 -96
  92. data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1153 -0
  93. data/doc/NgrokAPI/Services/{EventStreamsClient.html → EdgesHTTPSClient.html} +236 -271
  94. data/{docs/NgrokAPI/Services/EndpointConfigurationsClient.html → doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html} +456 -620
  95. data/doc/NgrokAPI/Services/EdgesTCPClient.html +1757 -0
  96. data/doc/NgrokAPI/Services/EdgesTLSClient.html +1847 -0
  97. data/doc/NgrokAPI/Services/EndpointsClient.html +907 -0
  98. data/doc/NgrokAPI/Services/EventDestinationsClient.html +35 -35
  99. data/doc/NgrokAPI/Services/EventSourcesClient.html +2 -2
  100. data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +5 -5
  101. data/doc/NgrokAPI/Services/FailoverBackendsClient.html +1644 -0
  102. data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +1744 -0
  103. data/doc/NgrokAPI/Services/{EndpointOIDCModuleClient.html → HTTPSEdgeMutualTLSModuleClient.html} +59 -59
  104. data/doc/NgrokAPI/Services/{EndpointRequestHeadersModuleClient.html → HTTPSEdgeTLSTerminationModuleClient.html} +59 -59
  105. data/doc/NgrokAPI/Services/IPPoliciesClient.html +40 -58
  106. data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +60 -40
  107. data/doc/NgrokAPI/Services/IPRestrictionsClient.html +3 -3
  108. data/doc/NgrokAPI/Services/ReservedAddrsClient.html +41 -331
  109. data/doc/NgrokAPI/Services/ReservedDomainsClient.html +94 -674
  110. data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +2 -2
  111. data/doc/NgrokAPI/Services/SSHCredentialsClient.html +2 -2
  112. data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +2 -2
  113. data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +2 -2
  114. data/{docs/NgrokAPI/Services/EndpointLoggingModuleClient.html → doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html} +59 -59
  115. data/doc/NgrokAPI/Services/{EndpointIPPolicyModuleClient.html → TCPEdgeIPRestrictionModuleClient.html} +41 -41
  116. data/doc/NgrokAPI/Services/TLSCertificatesClient.html +2 -2
  117. data/doc/NgrokAPI/Services/{EndpointLoggingModuleClient.html → TLSEdgeBackendModuleClient.html} +59 -59
  118. data/{docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html → doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html} +41 -41
  119. data/doc/NgrokAPI/Services/{EndpointMutualTLSModuleClient.html → TLSEdgeMutualTLSModuleClient.html} +41 -41
  120. data/{docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html → doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html} +41 -41
  121. data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +1644 -0
  122. data/doc/NgrokAPI/Services/TunnelSessionsClient.html +2 -2
  123. data/doc/NgrokAPI/Services/TunnelsClient.html +241 -3
  124. data/doc/NgrokAPI/Services/WeightedBackendsClient.html +1644 -0
  125. data/doc/NgrokAPI/Services.html +4 -4
  126. data/doc/NgrokAPI.html +3 -3
  127. data/doc/_index.html +237 -60
  128. data/doc/class_list.html +1 -1
  129. data/doc/file.README.html +2 -2
  130. data/doc/index.html +2 -2
  131. data/doc/method_list.html +3393 -1433
  132. data/doc/top-level-namespace.html +2 -2
  133. data/docs/NgrokAPI/Client.html +270 -180
  134. data/docs/NgrokAPI/Error.html +2 -2
  135. data/docs/NgrokAPI/Errors/NotFoundError.html +2 -2
  136. data/docs/NgrokAPI/Errors.html +2 -2
  137. data/docs/NgrokAPI/HttpClient.html +2 -2
  138. data/docs/NgrokAPI/Models/APIKey.html +2 -2
  139. data/docs/NgrokAPI/Models/AWSAuth.html +2 -2
  140. data/docs/NgrokAPI/Models/AWSCredentials.html +2 -2
  141. data/docs/NgrokAPI/Models/AWSRole.html +2 -2
  142. data/docs/NgrokAPI/Models/AbuseReport.html +2 -2
  143. data/docs/NgrokAPI/Models/AbuseReportHostname.html +2 -2
  144. data/docs/NgrokAPI/Models/AgentIngress.html +2 -2
  145. data/docs/NgrokAPI/Models/CertificateAuthority.html +2 -2
  146. data/docs/NgrokAPI/Models/Credential.html +2 -2
  147. data/docs/NgrokAPI/Models/Endpoint.html +1431 -0
  148. data/{doc/NgrokAPI/Models/EndpointLogging.html → docs/NgrokAPI/Models/EndpointBackend.html} +41 -41
  149. data/docs/NgrokAPI/Models/{EndpointLoggingMutate.html → EndpointBackendMutate.html} +41 -41
  150. data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
  151. data/docs/NgrokAPI/Models/EndpointCompression.html +2 -2
  152. data/docs/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
  153. data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
  154. data/docs/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
  155. data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
  156. data/docs/NgrokAPI/Models/EndpointOAuth.html +2 -2
  157. data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
  158. data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
  159. data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
  160. data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
  161. data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
  162. data/docs/NgrokAPI/Models/EndpointOIDC.html +2 -2
  163. data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
  164. data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
  165. data/docs/NgrokAPI/Models/EndpointSAML.html +2 -2
  166. data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
  167. data/docs/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
  168. data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +617 -0
  169. data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
  170. data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +543 -0
  171. data/docs/NgrokAPI/Models/EventDestination.html +6 -6
  172. data/docs/NgrokAPI/Models/EventSource.html +2 -2
  173. data/docs/NgrokAPI/Models/EventSourceList.html +2 -2
  174. data/docs/NgrokAPI/Models/EventSourceReplace.html +2 -2
  175. data/docs/NgrokAPI/Models/EventSubscription.html +2 -2
  176. data/docs/NgrokAPI/Models/EventTarget.html +2 -2
  177. data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
  178. data/docs/NgrokAPI/Models/EventTargetFirehose.html +2 -2
  179. data/docs/NgrokAPI/Models/EventTargetKinesis.html +2 -2
  180. data/docs/NgrokAPI/Models/FailoverBackend.html +1075 -0
  181. data/docs/NgrokAPI/Models/HTTPResponseBackend.html +1231 -0
  182. data/{doc/NgrokAPI/Models/EventStream.html → docs/NgrokAPI/Models/HTTPSEdge.html} +118 -118
  183. data/docs/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +202 -264
  184. data/docs/NgrokAPI/Models/IPPolicy.html +2 -2
  185. data/docs/NgrokAPI/Models/IPPolicyRule.html +96 -22
  186. data/docs/NgrokAPI/Models/IPRestriction.html +2 -2
  187. data/docs/NgrokAPI/Models/Listable.html +2 -2
  188. data/docs/NgrokAPI/Models/Ref.html +2 -2
  189. data/docs/NgrokAPI/Models/ReservedAddr.html +2 -2
  190. data/docs/NgrokAPI/Models/ReservedDomain.html +2 -2
  191. data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
  192. data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
  193. data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
  194. data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
  195. data/docs/NgrokAPI/Models/SSHCredential.html +2 -2
  196. data/docs/NgrokAPI/Models/SSHHostCertificate.html +2 -2
  197. data/docs/NgrokAPI/Models/SSHUserCertificate.html +2 -2
  198. data/docs/NgrokAPI/Models/TCPEdge.html +1235 -0
  199. data/docs/NgrokAPI/Models/TLSCertificate.html +2 -2
  200. data/docs/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
  201. data/docs/NgrokAPI/Models/TLSEdge.html +1395 -0
  202. data/docs/NgrokAPI/Models/Tunnel.html +313 -17
  203. data/docs/NgrokAPI/Models/TunnelGroupBackend.html +1149 -0
  204. data/docs/NgrokAPI/Models/TunnelSession.html +2 -2
  205. data/docs/NgrokAPI/Models/WeightedBackend.html +1075 -0
  206. data/docs/NgrokAPI/Models.html +4 -4
  207. data/docs/NgrokAPI/PagedIterator.html +2 -2
  208. data/docs/NgrokAPI/Services/APIKeysClient.html +2 -2
  209. data/docs/NgrokAPI/Services/AbuseReportsClient.html +2 -2
  210. data/docs/NgrokAPI/Services/AgentIngressesClient.html +2 -2
  211. data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +2 -2
  212. data/docs/NgrokAPI/Services/CredentialsClient.html +2 -2
  213. data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1153 -0
  214. data/docs/NgrokAPI/Services/{EndpointCircuitBreakerModuleClient.html → EdgeRouteCircuitBreakerModuleClient.html} +206 -96
  215. data/{doc/NgrokAPI/Services/EndpointCompressionModuleClient.html → docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html} +206 -96
  216. data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1153 -0
  217. data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +1153 -0
  218. data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +1153 -0
  219. data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1153 -0
  220. data/{doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html → docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html} +206 -96
  221. data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +1153 -0
  222. data/docs/NgrokAPI/Services/{EndpointWebhookValidationModuleClient.html → EdgeRouteWebhookVerificationModuleClient.html} +206 -96
  223. data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1153 -0
  224. data/docs/NgrokAPI/Services/{EventStreamsClient.html → EdgesHTTPSClient.html} +236 -271
  225. data/{doc/NgrokAPI/Services/EndpointConfigurationsClient.html → docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html} +456 -620
  226. data/docs/NgrokAPI/Services/EdgesTCPClient.html +1757 -0
  227. data/docs/NgrokAPI/Services/EdgesTLSClient.html +1847 -0
  228. data/docs/NgrokAPI/Services/EndpointsClient.html +907 -0
  229. data/docs/NgrokAPI/Services/EventDestinationsClient.html +35 -35
  230. data/docs/NgrokAPI/Services/EventSourcesClient.html +2 -2
  231. data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +5 -5
  232. data/docs/NgrokAPI/Services/FailoverBackendsClient.html +1644 -0
  233. data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +1744 -0
  234. data/{doc/NgrokAPI/Services/EndpointSAMLModuleClient.html → docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html} +59 -59
  235. data/docs/NgrokAPI/Services/{EndpointRequestHeadersModuleClient.html → HTTPSEdgeTLSTerminationModuleClient.html} +59 -59
  236. data/docs/NgrokAPI/Services/IPPoliciesClient.html +40 -58
  237. data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +60 -40
  238. data/docs/NgrokAPI/Services/IPRestrictionsClient.html +3 -3
  239. data/docs/NgrokAPI/Services/ReservedAddrsClient.html +41 -331
  240. data/docs/NgrokAPI/Services/ReservedDomainsClient.html +94 -674
  241. data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +2 -2
  242. data/docs/NgrokAPI/Services/SSHCredentialsClient.html +2 -2
  243. data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +2 -2
  244. data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +2 -2
  245. data/docs/NgrokAPI/Services/{EndpointOAuthModuleClient.html → TCPEdgeBackendModuleClient.html} +59 -59
  246. data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +1043 -0
  247. data/docs/NgrokAPI/Services/TLSCertificatesClient.html +2 -2
  248. data/{doc/NgrokAPI/Services/EndpointOAuthModuleClient.html → docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html} +59 -59
  249. data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +1043 -0
  250. data/docs/NgrokAPI/Services/{EndpointMutualTLSModuleClient.html → TLSEdgeMutualTLSModuleClient.html} +41 -41
  251. data/{doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html → docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html} +41 -41
  252. data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +1644 -0
  253. data/docs/NgrokAPI/Services/TunnelSessionsClient.html +2 -2
  254. data/docs/NgrokAPI/Services/TunnelsClient.html +241 -3
  255. data/docs/NgrokAPI/Services/WeightedBackendsClient.html +1644 -0
  256. data/docs/NgrokAPI/Services.html +4 -4
  257. data/docs/NgrokAPI.html +3 -3
  258. data/docs/_index.html +237 -60
  259. data/docs/class_list.html +1 -1
  260. data/docs/file.README.html +2 -2
  261. data/docs/index.html +2 -2
  262. data/docs/method_list.html +3393 -1433
  263. data/docs/top-level-namespace.html +2 -2
  264. data/lib/ngrokapi/client.rb +47 -24
  265. data/lib/ngrokapi/models/endpoint.rb +49 -0
  266. data/lib/ngrokapi/models/{endpoint_logging.rb → endpoint_backend.rb} +3 -3
  267. data/lib/ngrokapi/models/{endpoint_logging_mutate.rb → endpoint_backend_mutate.rb} +3 -3
  268. data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +27 -0
  269. data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +25 -0
  270. data/lib/ngrokapi/models/event_destination.rb +1 -2
  271. data/lib/ngrokapi/models/{event_stream.rb → failover_backend.rb} +15 -27
  272. data/lib/ngrokapi/models/http_response_backend.rb +71 -0
  273. data/lib/ngrokapi/models/https_edge.rb +80 -0
  274. data/lib/ngrokapi/models/{endpoint_configuration.rb → https_edge_route.rb} +56 -53
  275. data/lib/ngrokapi/models/ip_policy_rule.rb +3 -1
  276. data/lib/ngrokapi/models/tcp_edge.rb +78 -0
  277. data/lib/ngrokapi/models/tls_edge.rb +88 -0
  278. data/lib/ngrokapi/models/tunnel.rb +9 -1
  279. data/lib/ngrokapi/models/tunnel_group_backend.rb +67 -0
  280. data/lib/ngrokapi/models/weighted_backend.rb +65 -0
  281. data/lib/ngrokapi/services/edge_route_backend_module_client.rb +120 -0
  282. data/lib/ngrokapi/services/{endpoint_circuit_breaker_module_client.rb → edge_route_circuit_breaker_module_client.rb} +37 -25
  283. data/lib/ngrokapi/services/{endpoint_compression_module_client.rb → edge_route_compression_module_client.rb} +37 -25
  284. data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +120 -0
  285. data/lib/ngrokapi/services/edge_route_o_auth_module_client.rb +120 -0
  286. data/lib/ngrokapi/services/edge_route_oidc_module_client.rb +120 -0
  287. data/lib/ngrokapi/services/edge_route_request_headers_module_client.rb +120 -0
  288. data/lib/ngrokapi/services/{endpoint_response_headers_module_client.rb → edge_route_response_headers_module_client.rb} +37 -25
  289. data/lib/ngrokapi/services/edge_route_saml_module_client.rb +120 -0
  290. data/lib/ngrokapi/services/{endpoint_webhook_validation_module_client.rb → edge_route_webhook_verification_module_client.rb} +37 -25
  291. data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +120 -0
  292. data/lib/ngrokapi/services/edges_https_client.rb +227 -0
  293. data/lib/ngrokapi/services/edges_https_routes_client.rb +244 -0
  294. data/lib/ngrokapi/services/edges_tcp_client.rb +227 -0
  295. data/lib/ngrokapi/services/edges_tls_client.rb +239 -0
  296. data/lib/ngrokapi/services/endpoints_client.rb +114 -0
  297. data/lib/ngrokapi/services/event_destinations_client.rb +2 -4
  298. data/lib/ngrokapi/services/event_subscriptions_client.rb +3 -3
  299. data/lib/ngrokapi/services/failover_backends_client.rb +214 -0
  300. data/lib/ngrokapi/services/http_response_backends_client.rb +199 -0
  301. data/lib/ngrokapi/services/{endpoint_saml_module_client.rb → https_edge_mutual_tls_module_client.rb} +25 -25
  302. data/lib/ngrokapi/services/{endpoint_request_headers_module_client.rb → https_edge_tls_termination_module_client.rb} +25 -25
  303. data/lib/ngrokapi/services/ip_policies_client.rb +1 -3
  304. data/lib/ngrokapi/services/ip_policy_rules_client.rb +3 -1
  305. data/lib/ngrokapi/services/ip_restrictions_client.rb +1 -1
  306. data/lib/ngrokapi/services/reserved_addrs_client.rb +0 -37
  307. data/lib/ngrokapi/services/reserved_domains_client.rb +0 -74
  308. data/lib/ngrokapi/services/{endpoint_logging_module_client.rb → tcp_edge_backend_module_client.rb} +25 -25
  309. data/lib/ngrokapi/services/{endpoint_ip_policy_module_client.rb → tcp_edge_ip_restriction_module_client.rb} +15 -15
  310. data/lib/ngrokapi/services/{endpoint_oidc_module_client.rb → tls_edge_backend_module_client.rb} +25 -25
  311. data/lib/ngrokapi/services/{endpoint_o_auth_module_client.rb → tls_edge_ip_restriction_module_client.rb} +25 -25
  312. data/lib/ngrokapi/services/{endpoint_mutual_tls_module_client.rb → tls_edge_mutual_tls_module_client.rb} +15 -15
  313. data/lib/ngrokapi/services/{endpoint_tls_termination_module_client.rb → tls_edge_tls_termination_module_client.rb} +15 -15
  314. data/lib/ngrokapi/services/tunnel_group_backends_client.rb +212 -0
  315. data/lib/ngrokapi/services/tunnels_client.rb +35 -0
  316. data/lib/ngrokapi/services/weighted_backends_client.rb +214 -0
  317. data/lib/ngrokapi/version.rb +1 -1
  318. data/spec/ngrokapi/client_spec.rb +44 -23
  319. data/spec/ngrokapi/models/endpoint_backend_mutate_spec.rb +21 -0
  320. data/spec/ngrokapi/models/endpoint_backend_spec.rb +21 -0
  321. data/spec/ngrokapi/models/endpoint_spec.rb +21 -0
  322. data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +21 -0
  323. data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +21 -0
  324. data/spec/ngrokapi/models/failover_backend_spec.rb +45 -0
  325. data/spec/ngrokapi/models/http_response_backend_spec.rb +51 -0
  326. data/spec/ngrokapi/models/https_edge_route_spec.rb +81 -0
  327. data/spec/ngrokapi/models/https_edge_spec.rb +51 -0
  328. data/spec/ngrokapi/models/tcp_edge_spec.rb +51 -0
  329. data/spec/ngrokapi/models/tls_edge_spec.rb +57 -0
  330. data/spec/ngrokapi/models/tunnel_group_backend_spec.rb +45 -0
  331. data/spec/ngrokapi/models/weighted_backend_spec.rb +45 -0
  332. data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +139 -0
  333. data/spec/ngrokapi/services/{endpoint_circuit_breaker_module_client_spec.rb → edge_route_circuit_breaker_module_client_spec.rb} +31 -17
  334. data/spec/ngrokapi/services/{endpoint_compression_module_client_spec.rb → edge_route_compression_module_client_spec.rb} +31 -17
  335. data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +139 -0
  336. data/spec/ngrokapi/services/{endpoint_o_auth_module_client_spec.rb → edge_route_o_auth_module_client_spec.rb} +31 -17
  337. data/spec/ngrokapi/services/{endpoint_oidc_module_client_spec.rb → edge_route_oidc_module_client_spec.rb} +31 -17
  338. data/spec/ngrokapi/services/{endpoint_request_headers_module_client_spec.rb → edge_route_request_headers_module_client_spec.rb} +31 -17
  339. data/spec/ngrokapi/services/{endpoint_response_headers_module_client_spec.rb → edge_route_response_headers_module_client_spec.rb} +31 -17
  340. data/spec/ngrokapi/services/{endpoint_saml_module_client_spec.rb → edge_route_saml_module_client_spec.rb} +31 -17
  341. data/spec/ngrokapi/services/{endpoint_webhook_validation_module_client_spec.rb → edge_route_webhook_verification_module_client_spec.rb} +31 -17
  342. data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +139 -0
  343. data/spec/ngrokapi/services/{event_streams_client_spec.rb → edges_https_client_spec.rb} +106 -108
  344. data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +241 -0
  345. data/spec/ngrokapi/services/edges_tcp_client_spec.rb +175 -0
  346. data/spec/ngrokapi/services/edges_tls_client_spec.rb +187 -0
  347. data/spec/ngrokapi/services/endpoints_client_spec.rb +57 -0
  348. data/spec/ngrokapi/services/failover_backends_client_spec.rb +163 -0
  349. data/spec/ngrokapi/services/http_response_backends_client_spec.rb +175 -0
  350. data/spec/ngrokapi/services/{endpoint_mutual_tls_module_client_spec.rb → https_edge_mutual_tls_module_client_spec.rb} +17 -17
  351. data/spec/ngrokapi/services/{endpoint_tls_termination_module_client_spec.rb → https_edge_tls_termination_module_client_spec.rb} +17 -17
  352. data/spec/ngrokapi/services/ip_policies_client_spec.rb +0 -1
  353. data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +3 -1
  354. data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +0 -44
  355. data/spec/ngrokapi/services/reserved_domains_client_spec.rb +0 -88
  356. data/spec/ngrokapi/services/{endpoint_logging_module_client_spec.rb → tcp_edge_backend_module_client_spec.rb} +40 -40
  357. data/spec/ngrokapi/services/{endpoint_ip_policy_module_client_spec.rb → tcp_edge_ip_restriction_module_client_spec.rb} +17 -17
  358. data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +125 -0
  359. data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +125 -0
  360. data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +125 -0
  361. data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +125 -0
  362. data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +163 -0
  363. data/spec/ngrokapi/services/tunnels_client_spec.rb +36 -0
  364. data/spec/ngrokapi/services/weighted_backends_client_spec.rb +163 -0
  365. data/spec/spec_helper.rb +326 -33
  366. metadata +166 -74
  367. data/lib/ngrokapi/services/endpoint_configurations_client.rb +0 -289
  368. data/lib/ngrokapi/services/event_streams_client.rb +0 -224
  369. data/spec/ngrokapi/models/endpoint_configuration_spec.rb +0 -78
  370. data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +0 -21
  371. data/spec/ngrokapi/models/endpoint_logging_spec.rb +0 -21
  372. data/spec/ngrokapi/models/event_stream_spec.rb +0 -51
  373. data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +0 -237
@@ -0,0 +1,1644 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: NgrokAPI::Services::WeightedBackendsClient
8
+
9
+ &mdash; Documentation by YARD 0.9.27
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "NgrokAPI::Services::WeightedBackendsClient";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (W)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
41
+ &raquo;
42
+ <span class="title">WeightedBackendsClient</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: NgrokAPI::Services::WeightedBackendsClient
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">NgrokAPI::Services::WeightedBackendsClient</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/ngrokapi/services/weighted_backends_client.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>A Weighted Backend balances traffic among the referenced backends. Traffic is assigned proportionally to each based on its weight. The percentage of traffic is calculated by dividing a backend&#39;s weight by the sum of all weights.</p>
106
+
107
+ <p><a href="https://ngrok.com/docs/api#api-weighted-backends">ngrok.com/docs/api#api-weighted-backends</a></p>
108
+
109
+
110
+ </div>
111
+ </div>
112
+ <div class="tags">
113
+
114
+
115
+ </div>
116
+
117
+ <h2>
118
+ Constant Summary
119
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
120
+ </h2>
121
+
122
+ <dl class="constants">
123
+
124
+ <dt id="PATH-constant" class="">PATH =
125
+ <div class="docstring">
126
+ <div class="discussion">
127
+
128
+ <p>The API path for the requests</p>
129
+
130
+
131
+ </div>
132
+ </div>
133
+ <div class="tags">
134
+
135
+
136
+ </div>
137
+ </dt>
138
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/backends/weighted</span><span class='tstring_end'>&#39;</span></span></pre></dd>
139
+
140
+ <dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
141
+ <div class="docstring">
142
+ <div class="discussion">
143
+
144
+ <p>The List Property from the resulting API for list calls</p>
145
+
146
+
147
+ </div>
148
+ </div>
149
+ <div class="tags">
150
+
151
+
152
+ </div>
153
+ </dt>
154
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>backends</span><span class='tstring_end'>&#39;</span></span></pre></dd>
155
+
156
+ </dl>
157
+
158
+
159
+
160
+
161
+
162
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
163
+ <ul class="summary">
164
+
165
+ <li class="public ">
166
+ <span class="summary_signature">
167
+
168
+ <a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> &#x21d2; Object </a>
169
+
170
+
171
+
172
+ </span>
173
+
174
+
175
+
176
+
177
+ <span class="note title readonly">readonly</span>
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+ <span class="summary_desc"><div class='inline'>
188
+ <p>Returns the value of attribute client.</p>
189
+ </div></span>
190
+
191
+ </li>
192
+
193
+
194
+ </ul>
195
+
196
+
197
+
198
+
199
+
200
+ <h2>
201
+ Instance Method Summary
202
+ <small><a href="#" class="summary_toggle">collapse</a></small>
203
+ </h2>
204
+
205
+ <ul class="summary">
206
+
207
+ <li class="public ">
208
+ <span class="summary_signature">
209
+
210
+ <a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;, backends: {}) &#x21d2; NgrokAPI::Models::WeightedBackend </a>
211
+
212
+
213
+
214
+ </span>
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+ <span class="summary_desc"><div class='inline'>
225
+ <p>Create a new Weighted backend.</p>
226
+ </div></span>
227
+
228
+ </li>
229
+
230
+
231
+ <li class="public ">
232
+ <span class="summary_signature">
233
+
234
+ <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::Empty </a>
235
+
236
+
237
+
238
+ </span>
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+ <span class="summary_desc"><div class='inline'>
249
+ <p>Delete a Weighted backend by ID.</p>
250
+ </div></span>
251
+
252
+ </li>
253
+
254
+
255
+ <li class="public ">
256
+ <span class="summary_signature">
257
+
258
+ <a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::Empty </a>
259
+
260
+
261
+
262
+ </span>
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+ <span class="summary_desc"><div class='inline'>
273
+ <p>Delete a Weighted backend by ID.</p>
274
+ </div></span>
275
+
276
+ </li>
277
+
278
+
279
+ <li class="public ">
280
+ <span class="summary_signature">
281
+
282
+ <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::WeightedBackend </a>
283
+
284
+
285
+
286
+ </span>
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+ <span class="summary_desc"><div class='inline'>
297
+ <p>Get detailed information about a Weighted backend by ID.</p>
298
+ </div></span>
299
+
300
+ </li>
301
+
302
+
303
+ <li class="public ">
304
+ <span class="summary_signature">
305
+
306
+ <a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::WeightedBackend </a>
307
+
308
+
309
+
310
+ </span>
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+ <span class="summary_desc"><div class='inline'>
321
+ <p>Get detailed information about a Weighted backend by ID Throws an exception if API error.</p>
322
+ </div></span>
323
+
324
+ </li>
325
+
326
+
327
+ <li class="public ">
328
+ <span class="summary_signature">
329
+
330
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) &#x21d2; WeightedBackendsClient </a>
331
+
332
+
333
+
334
+ </span>
335
+
336
+
337
+ <span class="note title constructor">constructor</span>
338
+
339
+
340
+
341
+
342
+
343
+
344
+
345
+
346
+ <span class="summary_desc"><div class='inline'>
347
+ <p>A new instance of WeightedBackendsClient.</p>
348
+ </div></span>
349
+
350
+ </li>
351
+
352
+
353
+ <li class="public ">
354
+ <span class="summary_signature">
355
+
356
+ <a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, url: nil) &#x21d2; NgrokAPI::Models::Listable </a>
357
+
358
+
359
+
360
+ </span>
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+ <span class="summary_desc"><div class='inline'>
371
+ <p>List all Weighted backends on this account.</p>
372
+ </div></span>
373
+
374
+ </li>
375
+
376
+
377
+ <li class="public ">
378
+ <span class="summary_signature">
379
+
380
+ <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) &#x21d2; NgrokAPI::Models::Listable </a>
381
+
382
+
383
+
384
+ </span>
385
+
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+
394
+ <span class="summary_desc"><div class='inline'>
395
+ <p>List all Weighted backends on this account Throws an exception if API error.</p>
396
+ </div></span>
397
+
398
+ </li>
399
+
400
+
401
+ <li class="public ">
402
+ <span class="summary_signature">
403
+
404
+ <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: &quot;&quot;, description: nil, metadata: nil, backends: {}) &#x21d2; NgrokAPI::Models::WeightedBackend </a>
405
+
406
+
407
+
408
+ </span>
409
+
410
+
411
+
412
+
413
+
414
+
415
+
416
+
417
+
418
+ <span class="summary_desc"><div class='inline'>
419
+ <p>Update Weighted backend by ID.</p>
420
+ </div></span>
421
+
422
+ </li>
423
+
424
+
425
+ <li class="public ">
426
+ <span class="summary_signature">
427
+
428
+ <a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: &quot;&quot;, description: nil, metadata: nil, backends: {}) &#x21d2; NgrokAPI::Models::WeightedBackend </a>
429
+
430
+
431
+
432
+ </span>
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+ <span class="summary_desc"><div class='inline'>
443
+ <p>Update Weighted backend by ID Throws an exception if API error.</p>
444
+ </div></span>
445
+
446
+ </li>
447
+
448
+
449
+ </ul>
450
+
451
+
452
+ <div id="constructor_details" class="method_details_list">
453
+ <h2>Constructor Details</h2>
454
+
455
+ <div class="method_details first">
456
+ <h3 class="signature first" id="initialize-instance_method">
457
+
458
+ #<strong>initialize</strong>(client:) &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Services::WeightedBackendsClient (class)">WeightedBackendsClient</a></span></tt>
459
+
460
+
461
+
462
+
463
+
464
+ </h3><div class="docstring">
465
+ <div class="discussion">
466
+
467
+ <p>Returns a new instance of WeightedBackendsClient.</p>
468
+
469
+
470
+ </div>
471
+ </div>
472
+ <div class="tags">
473
+
474
+
475
+ </div><table class="source_code">
476
+ <tr>
477
+ <td>
478
+ <pre class="lines">
479
+
480
+
481
+ 20
482
+ 21
483
+ 22</pre>
484
+ </td>
485
+ <td>
486
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/weighted_backends_client.rb', line 20</span>
487
+
488
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
489
+ <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
490
+ <span class='kw'>end</span></pre>
491
+ </td>
492
+ </tr>
493
+ </table>
494
+ </div>
495
+
496
+ </div>
497
+
498
+ <div id="instance_attr_details" class="attr_details">
499
+ <h2>Instance Attribute Details</h2>
500
+
501
+
502
+ <span id=""></span>
503
+ <div class="method_details first">
504
+ <h3 class="signature first" id="client-instance_method">
505
+
506
+ #<strong>client</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
507
+
508
+
509
+
510
+
511
+
512
+ </h3><div class="docstring">
513
+ <div class="discussion">
514
+
515
+ <p>Returns the value of attribute client.</p>
516
+
517
+
518
+ </div>
519
+ </div>
520
+ <div class="tags">
521
+
522
+
523
+ </div><table class="source_code">
524
+ <tr>
525
+ <td>
526
+ <pre class="lines">
527
+
528
+
529
+ 18
530
+ 19
531
+ 20</pre>
532
+ </td>
533
+ <td>
534
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/weighted_backends_client.rb', line 18</span>
535
+
536
+ <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
537
+ <span class='ivar'>@client</span>
538
+ <span class='kw'>end</span></pre>
539
+ </td>
540
+ </tr>
541
+ </table>
542
+ </div>
543
+
544
+ </div>
545
+
546
+
547
+ <div id="instance_method_details" class="method_details_list">
548
+ <h2>Instance Method Details</h2>
549
+
550
+
551
+ <div class="method_details first">
552
+ <h3 class="signature first" id="create-instance_method">
553
+
554
+ #<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;, backends: {}) &#x21d2; <tt><span class='object_link'><a href="../Models/WeightedBackend.html" title="NgrokAPI::Models::WeightedBackend (class)">NgrokAPI::Models::WeightedBackend</a></span></tt>
555
+
556
+
557
+
558
+
559
+
560
+ </h3><div class="docstring">
561
+ <div class="discussion">
562
+
563
+ <p>Create a new Weighted backend</p>
564
+
565
+ <p><a href="https://ngrok.com/docs/api#api-weighted-backends-create">ngrok.com/docs/api#api-weighted-backends-create</a></p>
566
+
567
+
568
+ </div>
569
+ </div>
570
+ <div class="tags">
571
+ <p class="tag_title">Parameters:</p>
572
+ <ul class="param">
573
+
574
+ <li>
575
+
576
+ <span class='name'>description</span>
577
+
578
+
579
+ <span class='type'>(<tt>string</tt>)</span>
580
+
581
+
582
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
583
+
584
+
585
+ &mdash;
586
+ <div class='inline'>
587
+ <p>human-readable description of this backend. Optional</p>
588
+ </div>
589
+
590
+ </li>
591
+
592
+ <li>
593
+
594
+ <span class='name'>metadata</span>
595
+
596
+
597
+ <span class='type'>(<tt>string</tt>)</span>
598
+
599
+
600
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
601
+
602
+
603
+ &mdash;
604
+ <div class='inline'>
605
+ <p>arbitrary user-defined machine-readable data of this backend. Optional</p>
606
+ </div>
607
+
608
+ </li>
609
+
610
+ <li>
611
+
612
+ <span class='name'>backends</span>
613
+
614
+
615
+ <span class='type'>(<tt>Map&lt;string, int64&gt;</tt>)</span>
616
+
617
+
618
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
619
+
620
+
621
+ &mdash;
622
+ <div class='inline'>
623
+ <p>the ids of the child backends to their weights (0-10000)</p>
624
+ </div>
625
+
626
+ </li>
627
+
628
+ </ul>
629
+
630
+ <p class="tag_title">Returns:</p>
631
+ <ul class="return">
632
+
633
+ <li>
634
+
635
+
636
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/WeightedBackend.html" title="NgrokAPI::Models::WeightedBackend (class)">NgrokAPI::Models::WeightedBackend</a></span></tt>)</span>
637
+
638
+
639
+
640
+ &mdash;
641
+ <div class='inline'>
642
+ <p>result from the API request</p>
643
+ </div>
644
+
645
+ </li>
646
+
647
+ </ul>
648
+
649
+ </div><table class="source_code">
650
+ <tr>
651
+ <td>
652
+ <pre class="lines">
653
+
654
+
655
+ 33
656
+ 34
657
+ 35
658
+ 36
659
+ 37
660
+ 38
661
+ 39
662
+ 40
663
+ 41
664
+ 42
665
+ 43</pre>
666
+ </td>
667
+ <td>
668
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/weighted_backends_client.rb', line 33</span>
669
+
670
+ <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>backends:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
671
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/backends/weighted</span><span class='tstring_end'>&#39;</span></span>
672
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
673
+ <span class='rbrace'>}</span>
674
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
675
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
676
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
677
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:backends</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_backends'>backends</span> <span class='kw'>if</span> <span class='id identifier rubyid_backends'>backends</span>
678
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
679
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/WeightedBackend.html" title="NgrokAPI::Models::WeightedBackend (class)">WeightedBackend</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/WeightedBackend.html#initialize-instance_method" title="NgrokAPI::Models::WeightedBackend#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
680
+ <span class='kw'>end</span></pre>
681
+ </td>
682
+ </tr>
683
+ </table>
684
+ </div>
685
+
686
+ <div class="method_details ">
687
+ <h3 class="signature " id="delete-instance_method">
688
+
689
+ #<strong>delete</strong>(id: &quot;&quot;) &#x21d2; <tt>NgrokAPI::Models::Empty</tt>
690
+
691
+
692
+
693
+
694
+
695
+ </h3><div class="docstring">
696
+ <div class="discussion">
697
+
698
+ <p>Delete a Weighted backend by ID. TODO what if used?</p>
699
+
700
+ <p><a href="https://ngrok.com/docs/api#api-weighted-backends-delete">ngrok.com/docs/api#api-weighted-backends-delete</a></p>
701
+
702
+
703
+ </div>
704
+ </div>
705
+ <div class="tags">
706
+ <p class="tag_title">Parameters:</p>
707
+ <ul class="param">
708
+
709
+ <li>
710
+
711
+ <span class='name'>id</span>
712
+
713
+
714
+ <span class='type'>(<tt>string</tt>)</span>
715
+
716
+
717
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
718
+
719
+
720
+ &mdash;
721
+ <div class='inline'>
722
+ <p>a resource identifier</p>
723
+ </div>
724
+
725
+ </li>
726
+
727
+ </ul>
728
+
729
+ <p class="tag_title">Returns:</p>
730
+ <ul class="return">
731
+
732
+ <li>
733
+
734
+
735
+ <span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
736
+
737
+
738
+
739
+ &mdash;
740
+ <div class='inline'>
741
+ <p>result from the API request</p>
742
+ </div>
743
+
744
+ </li>
745
+
746
+ </ul>
747
+
748
+ </div><table class="source_code">
749
+ <tr>
750
+ <td>
751
+ <pre class="lines">
752
+
753
+
754
+ 52
755
+ 53
756
+ 54
757
+ 55
758
+ 56
759
+ 57
760
+ 58</pre>
761
+ </td>
762
+ <td>
763
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/weighted_backends_client.rb', line 52</span>
764
+
765
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
766
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/backends/weighted/%{id}</span><span class='tstring_end'>&#39;</span></span>
767
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
768
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
769
+ <span class='rbrace'>}</span>
770
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='rparen'>)</span>
771
+ <span class='kw'>end</span></pre>
772
+ </td>
773
+ </tr>
774
+ </table>
775
+ </div>
776
+
777
+ <div class="method_details ">
778
+ <h3 class="signature " id="delete!-instance_method">
779
+
780
+ #<strong>delete!</strong>(id: &quot;&quot;) &#x21d2; <tt>NgrokAPI::Models::Empty</tt>
781
+
782
+
783
+
784
+
785
+
786
+ </h3><div class="docstring">
787
+ <div class="discussion">
788
+
789
+ <p>Delete a Weighted backend by ID. TODO what if used? Throws an exception if API error.</p>
790
+
791
+ <p><a href="https://ngrok.com/docs/api#api-weighted-backends-delete">ngrok.com/docs/api#api-weighted-backends-delete</a></p>
792
+
793
+
794
+ </div>
795
+ </div>
796
+ <div class="tags">
797
+ <p class="tag_title">Parameters:</p>
798
+ <ul class="param">
799
+
800
+ <li>
801
+
802
+ <span class='name'>id</span>
803
+
804
+
805
+ <span class='type'>(<tt>string</tt>)</span>
806
+
807
+
808
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
809
+
810
+
811
+ &mdash;
812
+ <div class='inline'>
813
+ <p>a resource identifier</p>
814
+ </div>
815
+
816
+ </li>
817
+
818
+ </ul>
819
+
820
+ <p class="tag_title">Returns:</p>
821
+ <ul class="return">
822
+
823
+ <li>
824
+
825
+
826
+ <span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
827
+
828
+
829
+
830
+ &mdash;
831
+ <div class='inline'>
832
+ <p>result from the API request</p>
833
+ </div>
834
+
835
+ </li>
836
+
837
+ </ul>
838
+
839
+ </div><table class="source_code">
840
+ <tr>
841
+ <td>
842
+ <pre class="lines">
843
+
844
+
845
+ 68
846
+ 69
847
+ 70
848
+ 71
849
+ 72
850
+ 73
851
+ 74</pre>
852
+ </td>
853
+ <td>
854
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/weighted_backends_client.rb', line 68</span>
855
+
856
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
857
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/backends/weighted/%{id}</span><span class='tstring_end'>&#39;</span></span>
858
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
859
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
860
+ <span class='rbrace'>}</span>
861
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
862
+ <span class='kw'>end</span></pre>
863
+ </td>
864
+ </tr>
865
+ </table>
866
+ </div>
867
+
868
+ <div class="method_details ">
869
+ <h3 class="signature " id="get-instance_method">
870
+
871
+ #<strong>get</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/WeightedBackend.html" title="NgrokAPI::Models::WeightedBackend (class)">NgrokAPI::Models::WeightedBackend</a></span></tt>
872
+
873
+
874
+
875
+
876
+
877
+ </h3><div class="docstring">
878
+ <div class="discussion">
879
+
880
+ <p>Get detailed information about a Weighted backend by ID</p>
881
+
882
+ <p><a href="https://ngrok.com/docs/api#api-weighted-backends-get">ngrok.com/docs/api#api-weighted-backends-get</a></p>
883
+
884
+
885
+ </div>
886
+ </div>
887
+ <div class="tags">
888
+ <p class="tag_title">Parameters:</p>
889
+ <ul class="param">
890
+
891
+ <li>
892
+
893
+ <span class='name'>id</span>
894
+
895
+
896
+ <span class='type'>(<tt>string</tt>)</span>
897
+
898
+
899
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
900
+
901
+
902
+ &mdash;
903
+ <div class='inline'>
904
+ <p>a resource identifier</p>
905
+ </div>
906
+
907
+ </li>
908
+
909
+ </ul>
910
+
911
+ <p class="tag_title">Returns:</p>
912
+ <ul class="return">
913
+
914
+ <li>
915
+
916
+
917
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/WeightedBackend.html" title="NgrokAPI::Models::WeightedBackend (class)">NgrokAPI::Models::WeightedBackend</a></span></tt>)</span>
918
+
919
+
920
+
921
+ &mdash;
922
+ <div class='inline'>
923
+ <p>result from the API request</p>
924
+ </div>
925
+
926
+ </li>
927
+
928
+ </ul>
929
+
930
+ </div><table class="source_code">
931
+ <tr>
932
+ <td>
933
+ <pre class="lines">
934
+
935
+
936
+ 83
937
+ 84
938
+ 85
939
+ 86
940
+ 87
941
+ 88
942
+ 89
943
+ 90
944
+ 91</pre>
945
+ </td>
946
+ <td>
947
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/weighted_backends_client.rb', line 83</span>
948
+
949
+ <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
950
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/backends/weighted/%{id}</span><span class='tstring_end'>&#39;</span></span>
951
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
952
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
953
+ <span class='rbrace'>}</span>
954
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
955
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
956
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/WeightedBackend.html" title="NgrokAPI::Models::WeightedBackend (class)">WeightedBackend</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/WeightedBackend.html#initialize-instance_method" title="NgrokAPI::Models::WeightedBackend#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
957
+ <span class='kw'>end</span></pre>
958
+ </td>
959
+ </tr>
960
+ </table>
961
+ </div>
962
+
963
+ <div class="method_details ">
964
+ <h3 class="signature " id="get!-instance_method">
965
+
966
+ #<strong>get!</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/WeightedBackend.html" title="NgrokAPI::Models::WeightedBackend (class)">NgrokAPI::Models::WeightedBackend</a></span></tt>
967
+
968
+
969
+
970
+
971
+
972
+ </h3><div class="docstring">
973
+ <div class="discussion">
974
+
975
+ <p>Get detailed information about a Weighted backend by ID Throws an exception if API error.</p>
976
+
977
+ <p><a href="https://ngrok.com/docs/api#api-weighted-backends-get">ngrok.com/docs/api#api-weighted-backends-get</a></p>
978
+
979
+
980
+ </div>
981
+ </div>
982
+ <div class="tags">
983
+ <p class="tag_title">Parameters:</p>
984
+ <ul class="param">
985
+
986
+ <li>
987
+
988
+ <span class='name'>id</span>
989
+
990
+
991
+ <span class='type'>(<tt>string</tt>)</span>
992
+
993
+
994
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
995
+
996
+
997
+ &mdash;
998
+ <div class='inline'>
999
+ <p>a resource identifier</p>
1000
+ </div>
1001
+
1002
+ </li>
1003
+
1004
+ </ul>
1005
+
1006
+ <p class="tag_title">Returns:</p>
1007
+ <ul class="return">
1008
+
1009
+ <li>
1010
+
1011
+
1012
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/WeightedBackend.html" title="NgrokAPI::Models::WeightedBackend (class)">NgrokAPI::Models::WeightedBackend</a></span></tt>)</span>
1013
+
1014
+
1015
+
1016
+ &mdash;
1017
+ <div class='inline'>
1018
+ <p>result from the API request</p>
1019
+ </div>
1020
+
1021
+ </li>
1022
+
1023
+ </ul>
1024
+
1025
+ </div><table class="source_code">
1026
+ <tr>
1027
+ <td>
1028
+ <pre class="lines">
1029
+
1030
+
1031
+ 101
1032
+ 102
1033
+ 103
1034
+ 104
1035
+ 105
1036
+ 106
1037
+ 107
1038
+ 108
1039
+ 109</pre>
1040
+ </td>
1041
+ <td>
1042
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/weighted_backends_client.rb', line 101</span>
1043
+
1044
+ <span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1045
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/backends/weighted/%{id}</span><span class='tstring_end'>&#39;</span></span>
1046
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1047
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1048
+ <span class='rbrace'>}</span>
1049
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1050
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
1051
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/WeightedBackend.html" title="NgrokAPI::Models::WeightedBackend (class)">WeightedBackend</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/WeightedBackend.html#initialize-instance_method" title="NgrokAPI::Models::WeightedBackend#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1052
+ <span class='kw'>end</span></pre>
1053
+ </td>
1054
+ </tr>
1055
+ </table>
1056
+ </div>
1057
+
1058
+ <div class="method_details ">
1059
+ <h3 class="signature " id="list-instance_method">
1060
+
1061
+ #<strong>list</strong>(before_id: nil, limit: nil, url: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
1062
+
1063
+
1064
+
1065
+
1066
+
1067
+ </h3><div class="docstring">
1068
+ <div class="discussion">
1069
+
1070
+ <p>List all Weighted backends on this account</p>
1071
+
1072
+ <p><a href="https://ngrok.com/docs/api#api-weighted-backends-list">ngrok.com/docs/api#api-weighted-backends-list</a></p>
1073
+
1074
+
1075
+ </div>
1076
+ </div>
1077
+ <div class="tags">
1078
+ <p class="tag_title">Parameters:</p>
1079
+ <ul class="param">
1080
+
1081
+ <li>
1082
+
1083
+ <span class='name'>before_id</span>
1084
+
1085
+
1086
+ <span class='type'>(<tt>string</tt>)</span>
1087
+
1088
+
1089
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1090
+
1091
+
1092
+ </li>
1093
+
1094
+ <li>
1095
+
1096
+ <span class='name'>limit</span>
1097
+
1098
+
1099
+ <span class='type'>(<tt>string</tt>)</span>
1100
+
1101
+
1102
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1103
+
1104
+
1105
+ </li>
1106
+
1107
+ <li>
1108
+
1109
+ <span class='name'>url</span>
1110
+
1111
+
1112
+ <span class='type'>(<tt>string</tt>)</span>
1113
+
1114
+
1115
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1116
+
1117
+
1118
+ &mdash;
1119
+ <div class='inline'>
1120
+ <p>optional and mutually exclusive from before_id and limit</p>
1121
+ </div>
1122
+
1123
+ </li>
1124
+
1125
+ </ul>
1126
+
1127
+ <p class="tag_title">Returns:</p>
1128
+ <ul class="return">
1129
+
1130
+ <li>
1131
+
1132
+
1133
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
1134
+
1135
+
1136
+
1137
+ &mdash;
1138
+ <div class='inline'>
1139
+ <p>result from the API request</p>
1140
+ </div>
1141
+
1142
+ </li>
1143
+
1144
+ </ul>
1145
+
1146
+ </div><table class="source_code">
1147
+ <tr>
1148
+ <td>
1149
+ <pre class="lines">
1150
+
1151
+
1152
+ 120
1153
+ 121
1154
+ 122
1155
+ 123
1156
+ 124
1157
+ 125
1158
+ 126
1159
+ 127
1160
+ 128
1161
+ 129
1162
+ 130
1163
+ 131
1164
+ 132
1165
+ 133
1166
+ 134
1167
+ 135</pre>
1168
+ </td>
1169
+ <td>
1170
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/weighted_backends_client.rb', line 120</span>
1171
+
1172
+ <span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1173
+ <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1174
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
1175
+ <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
1176
+ <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
1177
+ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
1178
+ <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::WeightedBackendsClient::PATH (constant)">PATH</a></span></span>
1179
+ <span class='rparen'>)</span>
1180
+
1181
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
1182
+ <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1183
+ <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1184
+ <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::WeightedBackendsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1185
+ <span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/WeightedBackend.html" title="NgrokAPI::Models::WeightedBackend (class)">WeightedBackend</a></span></span>
1186
+ <span class='rparen'>)</span>
1187
+ <span class='kw'>end</span></pre>
1188
+ </td>
1189
+ </tr>
1190
+ </table>
1191
+ </div>
1192
+
1193
+ <div class="method_details ">
1194
+ <h3 class="signature " id="list!-instance_method">
1195
+
1196
+ #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
1197
+
1198
+
1199
+
1200
+
1201
+
1202
+ </h3><div class="docstring">
1203
+ <div class="discussion">
1204
+
1205
+ <p>List all Weighted backends on this account Throws an exception if API error.</p>
1206
+
1207
+ <p><a href="https://ngrok.com/docs/api#api-weighted-backends-list">ngrok.com/docs/api#api-weighted-backends-list</a></p>
1208
+
1209
+
1210
+ </div>
1211
+ </div>
1212
+ <div class="tags">
1213
+ <p class="tag_title">Parameters:</p>
1214
+ <ul class="param">
1215
+
1216
+ <li>
1217
+
1218
+ <span class='name'>before_id</span>
1219
+
1220
+
1221
+ <span class='type'>(<tt>string</tt>)</span>
1222
+
1223
+
1224
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1225
+
1226
+
1227
+ </li>
1228
+
1229
+ <li>
1230
+
1231
+ <span class='name'>limit</span>
1232
+
1233
+
1234
+ <span class='type'>(<tt>string</tt>)</span>
1235
+
1236
+
1237
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1238
+
1239
+
1240
+ </li>
1241
+
1242
+ <li>
1243
+
1244
+ <span class='name'>url</span>
1245
+
1246
+
1247
+ <span class='type'>(<tt>string</tt>)</span>
1248
+
1249
+
1250
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1251
+
1252
+
1253
+ &mdash;
1254
+ <div class='inline'>
1255
+ <p>optional and mutually exclusive from before_id and limit</p>
1256
+ </div>
1257
+
1258
+ </li>
1259
+
1260
+ </ul>
1261
+
1262
+ <p class="tag_title">Returns:</p>
1263
+ <ul class="return">
1264
+
1265
+ <li>
1266
+
1267
+
1268
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
1269
+
1270
+
1271
+
1272
+ &mdash;
1273
+ <div class='inline'>
1274
+ <p>result from the API request</p>
1275
+ </div>
1276
+
1277
+ </li>
1278
+
1279
+ </ul>
1280
+
1281
+ </div><table class="source_code">
1282
+ <tr>
1283
+ <td>
1284
+ <pre class="lines">
1285
+
1286
+
1287
+ 147
1288
+ 148
1289
+ 149
1290
+ 150
1291
+ 151
1292
+ 152
1293
+ 153
1294
+ 154
1295
+ 155
1296
+ 156
1297
+ 157
1298
+ 158
1299
+ 159
1300
+ 160
1301
+ 161
1302
+ 162
1303
+ 163
1304
+ 164</pre>
1305
+ </td>
1306
+ <td>
1307
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/weighted_backends_client.rb', line 147</span>
1308
+
1309
+ <span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1310
+ <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1311
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
1312
+ <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
1313
+ <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
1314
+ <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
1315
+ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
1316
+ <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::WeightedBackendsClient::PATH (constant)">PATH</a></span></span>
1317
+ <span class='rparen'>)</span>
1318
+
1319
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
1320
+ <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1321
+ <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1322
+ <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::WeightedBackendsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1323
+ <span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/WeightedBackend.html" title="NgrokAPI::Models::WeightedBackend (class)">WeightedBackend</a></span></span><span class='comma'>,</span>
1324
+ <span class='label'>danger:</span> <span class='kw'>true</span>
1325
+ <span class='rparen'>)</span>
1326
+ <span class='kw'>end</span></pre>
1327
+ </td>
1328
+ </tr>
1329
+ </table>
1330
+ </div>
1331
+
1332
+ <div class="method_details ">
1333
+ <h3 class="signature " id="update-instance_method">
1334
+
1335
+ #<strong>update</strong>(id: &quot;&quot;, description: nil, metadata: nil, backends: {}) &#x21d2; <tt><span class='object_link'><a href="../Models/WeightedBackend.html" title="NgrokAPI::Models::WeightedBackend (class)">NgrokAPI::Models::WeightedBackend</a></span></tt>
1336
+
1337
+
1338
+
1339
+
1340
+
1341
+ </h3><div class="docstring">
1342
+ <div class="discussion">
1343
+
1344
+ <p>Update Weighted backend by ID</p>
1345
+
1346
+ <p><a href="https://ngrok.com/docs/api#api-weighted-backends-update">ngrok.com/docs/api#api-weighted-backends-update</a></p>
1347
+
1348
+
1349
+ </div>
1350
+ </div>
1351
+ <div class="tags">
1352
+ <p class="tag_title">Parameters:</p>
1353
+ <ul class="param">
1354
+
1355
+ <li>
1356
+
1357
+ <span class='name'>id</span>
1358
+
1359
+
1360
+ <span class='type'>(<tt>string</tt>)</span>
1361
+
1362
+
1363
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1364
+
1365
+
1366
+ </li>
1367
+
1368
+ <li>
1369
+
1370
+ <span class='name'>description</span>
1371
+
1372
+
1373
+ <span class='type'>(<tt>string</tt>)</span>
1374
+
1375
+
1376
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1377
+
1378
+
1379
+ &mdash;
1380
+ <div class='inline'>
1381
+ <p>human-readable description of this backend. Optional</p>
1382
+ </div>
1383
+
1384
+ </li>
1385
+
1386
+ <li>
1387
+
1388
+ <span class='name'>metadata</span>
1389
+
1390
+
1391
+ <span class='type'>(<tt>string</tt>)</span>
1392
+
1393
+
1394
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1395
+
1396
+
1397
+ &mdash;
1398
+ <div class='inline'>
1399
+ <p>arbitrary user-defined machine-readable data of this backend. Optional</p>
1400
+ </div>
1401
+
1402
+ </li>
1403
+
1404
+ <li>
1405
+
1406
+ <span class='name'>backends</span>
1407
+
1408
+
1409
+ <span class='type'>(<tt>Map&lt;string, int64&gt;</tt>)</span>
1410
+
1411
+
1412
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1413
+
1414
+
1415
+ &mdash;
1416
+ <div class='inline'>
1417
+ <p>the ids of the child backends to their weights (0-10000)</p>
1418
+ </div>
1419
+
1420
+ </li>
1421
+
1422
+ </ul>
1423
+
1424
+ <p class="tag_title">Returns:</p>
1425
+ <ul class="return">
1426
+
1427
+ <li>
1428
+
1429
+
1430
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/WeightedBackend.html" title="NgrokAPI::Models::WeightedBackend (class)">NgrokAPI::Models::WeightedBackend</a></span></tt>)</span>
1431
+
1432
+
1433
+
1434
+ &mdash;
1435
+ <div class='inline'>
1436
+ <p>result from the API request</p>
1437
+ </div>
1438
+
1439
+ </li>
1440
+
1441
+ </ul>
1442
+
1443
+ </div><table class="source_code">
1444
+ <tr>
1445
+ <td>
1446
+ <pre class="lines">
1447
+
1448
+
1449
+ 176
1450
+ 177
1451
+ 178
1452
+ 179
1453
+ 180
1454
+ 181
1455
+ 182
1456
+ 183
1457
+ 184
1458
+ 185
1459
+ 186
1460
+ 187</pre>
1461
+ </td>
1462
+ <td>
1463
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/weighted_backends_client.rb', line 176</span>
1464
+
1465
+ <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>backends:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1466
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/backends/weighted/%{id}</span><span class='tstring_end'>&#39;</span></span>
1467
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1468
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1469
+ <span class='rbrace'>}</span>
1470
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1471
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
1472
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
1473
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:backends</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_backends'>backends</span> <span class='kw'>if</span> <span class='id identifier rubyid_backends'>backends</span>
1474
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
1475
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/WeightedBackend.html" title="NgrokAPI::Models::WeightedBackend (class)">WeightedBackend</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/WeightedBackend.html#initialize-instance_method" title="NgrokAPI::Models::WeightedBackend#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1476
+ <span class='kw'>end</span></pre>
1477
+ </td>
1478
+ </tr>
1479
+ </table>
1480
+ </div>
1481
+
1482
+ <div class="method_details ">
1483
+ <h3 class="signature " id="update!-instance_method">
1484
+
1485
+ #<strong>update!</strong>(id: &quot;&quot;, description: nil, metadata: nil, backends: {}) &#x21d2; <tt><span class='object_link'><a href="../Models/WeightedBackend.html" title="NgrokAPI::Models::WeightedBackend (class)">NgrokAPI::Models::WeightedBackend</a></span></tt>
1486
+
1487
+
1488
+
1489
+
1490
+
1491
+ </h3><div class="docstring">
1492
+ <div class="discussion">
1493
+
1494
+ <p>Update Weighted backend by ID Throws an exception if API error.</p>
1495
+
1496
+ <p><a href="https://ngrok.com/docs/api#api-weighted-backends-update">ngrok.com/docs/api#api-weighted-backends-update</a></p>
1497
+
1498
+
1499
+ </div>
1500
+ </div>
1501
+ <div class="tags">
1502
+ <p class="tag_title">Parameters:</p>
1503
+ <ul class="param">
1504
+
1505
+ <li>
1506
+
1507
+ <span class='name'>id</span>
1508
+
1509
+
1510
+ <span class='type'>(<tt>string</tt>)</span>
1511
+
1512
+
1513
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1514
+
1515
+
1516
+ </li>
1517
+
1518
+ <li>
1519
+
1520
+ <span class='name'>description</span>
1521
+
1522
+
1523
+ <span class='type'>(<tt>string</tt>)</span>
1524
+
1525
+
1526
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1527
+
1528
+
1529
+ &mdash;
1530
+ <div class='inline'>
1531
+ <p>human-readable description of this backend. Optional</p>
1532
+ </div>
1533
+
1534
+ </li>
1535
+
1536
+ <li>
1537
+
1538
+ <span class='name'>metadata</span>
1539
+
1540
+
1541
+ <span class='type'>(<tt>string</tt>)</span>
1542
+
1543
+
1544
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1545
+
1546
+
1547
+ &mdash;
1548
+ <div class='inline'>
1549
+ <p>arbitrary user-defined machine-readable data of this backend. Optional</p>
1550
+ </div>
1551
+
1552
+ </li>
1553
+
1554
+ <li>
1555
+
1556
+ <span class='name'>backends</span>
1557
+
1558
+
1559
+ <span class='type'>(<tt>Map&lt;string, int64&gt;</tt>)</span>
1560
+
1561
+
1562
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1563
+
1564
+
1565
+ &mdash;
1566
+ <div class='inline'>
1567
+ <p>the ids of the child backends to their weights (0-10000)</p>
1568
+ </div>
1569
+
1570
+ </li>
1571
+
1572
+ </ul>
1573
+
1574
+ <p class="tag_title">Returns:</p>
1575
+ <ul class="return">
1576
+
1577
+ <li>
1578
+
1579
+
1580
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/WeightedBackend.html" title="NgrokAPI::Models::WeightedBackend (class)">NgrokAPI::Models::WeightedBackend</a></span></tt>)</span>
1581
+
1582
+
1583
+
1584
+ &mdash;
1585
+ <div class='inline'>
1586
+ <p>result from the API request</p>
1587
+ </div>
1588
+
1589
+ </li>
1590
+
1591
+ </ul>
1592
+
1593
+ </div><table class="source_code">
1594
+ <tr>
1595
+ <td>
1596
+ <pre class="lines">
1597
+
1598
+
1599
+ 200
1600
+ 201
1601
+ 202
1602
+ 203
1603
+ 204
1604
+ 205
1605
+ 206
1606
+ 207
1607
+ 208
1608
+ 209
1609
+ 210
1610
+ 211</pre>
1611
+ </td>
1612
+ <td>
1613
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/weighted_backends_client.rb', line 200</span>
1614
+
1615
+ <span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>backends:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1616
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/backends/weighted/%{id}</span><span class='tstring_end'>&#39;</span></span>
1617
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1618
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1619
+ <span class='rbrace'>}</span>
1620
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1621
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
1622
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
1623
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:backends</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_backends'>backends</span> <span class='kw'>if</span> <span class='id identifier rubyid_backends'>backends</span>
1624
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
1625
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/WeightedBackend.html" title="NgrokAPI::Models::WeightedBackend (class)">WeightedBackend</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/WeightedBackend.html#initialize-instance_method" title="NgrokAPI::Models::WeightedBackend#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1626
+ <span class='kw'>end</span></pre>
1627
+ </td>
1628
+ </tr>
1629
+ </table>
1630
+ </div>
1631
+
1632
+ </div>
1633
+
1634
+ </div>
1635
+
1636
+ <div id="footer">
1637
+ Generated on Thu Mar 10 04:54:54 2022 by
1638
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1639
+ 0.9.27 (ruby-2.7.5).
1640
+ </div>
1641
+
1642
+ </div>
1643
+ </body>
1644
+ </html>