ngrok/ngrok-api-java
1
0
Fork 0
mirror of https://github.com/ngrok/ngrok-api-java.git synced 2026-06-16 16:54:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4 from ngrok/staging

Browse Source 
new java client release: 0.7.0
This commit is contained in:
Brian Tarricone
2022-05-01 09:15:18 -07:00
committed by GitHub
parent ee22768683 df9dffb870
commit 52efbb1fc4
903 changed files with 5020 additions and 4774 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2 -2
View File
@@ -67,12 +67,12 @@ public class Example {
public static void main(final String[] args) {
final var ngrok = Ngrok.createDefault();
ngrok.ipPolicies().create("allow").call().thenCompose(policy ->
ngrok.ipPolicies().create().call().thenCompose(policy ->
CompletableFuture.allOf(
Stream.of("24.0.0.0/8", "12.0.0.0/8")
.map(cidr ->
ngrok.ipPolicyRules()
.create(cidr, policy.getId())
.create(cidr, policy.getId(), "allow")
.call()
.toCompletableFuture()
)
docs/allclasses-index.html
+4 -4
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>All Classes and Interfaces (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>All Classes and Interfaces (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="class index">
<meta name="generator" content="javadoc/AllClassesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -72,7 +72,7 @@ loadScripts(document, 'script');</script>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/ngrok/services/AbuseReports.html" title="class in com.ngrok.services">AbuseReports</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Abuse Reports allow you to submit take-down requests for URLs hosted by
ngrok that violate ngrok's terms of service.</div>
ngrok that violate ngrok&#39;s terms of service.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/ngrok/definitions/AgentIngress.html" title="class in com.ngrok.definitions">AgentIngress</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
docs/allpackages-index.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>All Packages (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>All Packages (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="package index">
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
docs/com/ngrok/DefaultNgrokApiClient.Builder.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>DefaultNgrokApiClient.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>DefaultNgrokApiClient.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok, class: DefaultNgrokApiClient, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
docs/com/ngrok/DefaultNgrokApiClient.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>DefaultNgrokApiClient (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>DefaultNgrokApiClient (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok, class: DefaultNgrokApiClient">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
docs/com/ngrok/Ngrok.BackendsNamespace.html
+4 -4
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>Ngrok.BackendsNamespace (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>Ngrok.BackendsNamespace (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok, class: Ngrok, class: BackendsNamespace">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
@@ -186,7 +186,7 @@ loadScripts(document, 'script');</script>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="services/WeightedBackends.html" title="class in com.ngrok.services">WeightedBackends</a></span>&nbsp;<span class="element-name">weighted</span>()</div>
<div class="block">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's weight by the sum of all
traffic is calculated by dividing a backend&#39;s weight by the sum of all
weights.
See also <a href="https://ngrok.com/docs/api#api-weighted-backends">https://ngrok.com/docs/api#api-weighted-backends</a></div>
docs/com/ngrok/Ngrok.EdgeModulesNamespace.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>Ngrok.EdgeModulesNamespace (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>Ngrok.EdgeModulesNamespace (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok, class: Ngrok, class: EdgeModulesNamespace">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
docs/com/ngrok/Ngrok.EdgesNamespace.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>Ngrok.EdgesNamespace (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>Ngrok.EdgesNamespace (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok, class: Ngrok, class: EdgesNamespace">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
docs/com/ngrok/Ngrok.html
+9 -8
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>Ngrok (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>Ngrok (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok, class: Ngrok">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
@@ -140,7 +140,7 @@ loadScripts(document, 'script');</script>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#abuseReports()" class="member-name-link">abuseReports</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Abuse Reports allow you to submit take-down requests for URLs hosted by
ngrok that violate ngrok's terms of service.</div>
ngrok that violate ngrok&#39;s terms of service.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="services/AgentIngresses.html" title="class in com.ngrok.services">AgentIngresses</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#agentIngresses()" class="member-name-link">agentIngresses</a>()</code></div>
@@ -355,7 +355,7 @@ loadScripts(document, 'script');</script>
<h3>abuseReports</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="services/AbuseReports.html" title="class in com.ngrok.services">AbuseReports</a></span>&nbsp;<span class="element-name">abuseReports</span>()</div>
<div class="block">Abuse Reports allow you to submit take-down requests for URLs hosted by
ngrok that violate ngrok's terms of service.
ngrok that violate ngrok&#39;s terms of service.
See also <a href="https://ngrok.com/docs/api#api-abuse-reports">https://ngrok.com/docs/api#api-abuse-reports</a>.</div>
<dl class="notes">
@@ -383,7 +383,8 @@ loadScripts(document, 'script');</script>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="services/ApiKeys.html" title="class in com.ngrok.services">ApiKeys</a></span>&nbsp;<span class="element-name">apiKeys</span>()</div>
<div class="block">API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok
API</a>. You may use the API itself
to provision and manage API Keys but you'll need to provision your first API
to provision and manage API Keys but you&#39;ll need to provision your first
API
key from the <a href="https://dashboard.ngrok.com/api/keys">API Keys page</a>
on your
ngrok.com dashboard.
@@ -418,7 +419,7 @@ loadScripts(document, 'script');</script>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="services/Credentials.html" title="class in com.ngrok.services">Credentials</a></span>&nbsp;<span class="element-name">credentials</span>()</div>
<div class="block">Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
agent to connect the ngrok service as your account. They are installed with
the <code>ngrok authtoken</code> command or by specifying it in the
the <code>ngrok config add-authtoken</code> command or by specifying it in the
<code>ngrok.yml</code>
configuration file with the <code>authtoken</code> property.
@@ -554,7 +555,7 @@ loadScripts(document, 'script');</script>
<div class="block">Reserved Domains are hostnames that you can listen for traffic on. Domains
can be used to listen for http, https or tls traffic. You may use a domain
that you own by creating a CNAME record specified in the returned resource.
This CNAME record points traffic for that domain to ngrok's edge servers.
This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
See also <a href="https://ngrok.com/docs/api#api-reserved-domains">https://ngrok.com/docs/api#api-reserved-domains</a>.</div>
<dl class="notes">
docs/com/ngrok/NgrokApiClient.HttpMethod.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>NgrokApiClient.HttpMethod (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>NgrokApiClient.HttpMethod (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok, interface: NgrokApiClient, enum: HttpMethod">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
docs/com/ngrok/NgrokApiClient.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>NgrokApiClient (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>NgrokApiClient (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok, interface: NgrokApiClient">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
docs/com/ngrok/Version.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>Version (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>Version (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok, class: Version">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
docs/com/ngrok/class-use/DefaultNgrokApiClient.Builder.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>Uses of Class com.ngrok.DefaultNgrokApiClient.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>Uses of Class com.ngrok.DefaultNgrokApiClient.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="use: package: com.ngrok, class: DefaultNgrokApiClient, class: Builder">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/class-use/DefaultNgrokApiClient.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>Uses of Class com.ngrok.DefaultNgrokApiClient (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>Uses of Class com.ngrok.DefaultNgrokApiClient (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="use: package: com.ngrok, class: DefaultNgrokApiClient">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/class-use/Ngrok.BackendsNamespace.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>Uses of Class com.ngrok.Ngrok.BackendsNamespace (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>Uses of Class com.ngrok.Ngrok.BackendsNamespace (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="use: package: com.ngrok, class: Ngrok, class: BackendsNamespace">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/class-use/Ngrok.EdgeModulesNamespace.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>Uses of Class com.ngrok.Ngrok.EdgeModulesNamespace (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>Uses of Class com.ngrok.Ngrok.EdgeModulesNamespace (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="use: package: com.ngrok, class: Ngrok, class: EdgeModulesNamespace">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/class-use/Ngrok.EdgesNamespace.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>Uses of Class com.ngrok.Ngrok.EdgesNamespace (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>Uses of Class com.ngrok.Ngrok.EdgesNamespace (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="use: package: com.ngrok, class: Ngrok, class: EdgesNamespace">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/class-use/Ngrok.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>Uses of Class com.ngrok.Ngrok (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>Uses of Class com.ngrok.Ngrok (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="use: package: com.ngrok, class: Ngrok">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/class-use/NgrokApiClient.HttpMethod.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>Uses of Enum com.ngrok.NgrokApiClient.HttpMethod (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>Uses of Enum com.ngrok.NgrokApiClient.HttpMethod (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="use: package: com.ngrok, interface: NgrokApiClient, enum: HttpMethod">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/class-use/NgrokApiClient.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>Uses of Interface com.ngrok.NgrokApiClient (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>Uses of Interface com.ngrok.NgrokApiClient (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="use: package: com.ngrok, interface: NgrokApiClient">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/class-use/Version.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>Uses of Class com.ngrok.Version (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>Uses of Class com.ngrok.Version (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="use: package: com.ngrok, class: Version">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/AbuseReport.html
+5 -5
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>AbuseReport (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>AbuseReport (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: AbuseReport">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -247,7 +247,7 @@ loadScripts(document, 'script');</script>
<div class="block">a list of URLs containing suspected abusive content</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link"><code>URI</code></a></dd>
</dl>
</section>
</li>
@@ -282,7 +282,7 @@ loadScripts(document, 'script');</script>
<div class="block">an array of hostname statuses related to the report</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="AbuseReportHostname.html" title="class in com.ngrok.definitions">AbuseReportHostname</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="AbuseReportHostname.html" title="class in com.ngrok.definitions"><code>AbuseReportHostname</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/AbuseReportHostname.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>AbuseReportHostname (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>AbuseReportHostname (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: AbuseReportHostname">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/AgentIngress.html
+12 -12
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>AgentIngress (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>AgentIngress (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: AgentIngress">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -91,14 +91,14 @@ loadScripts(document, 'script');</script>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.net.URI,java.lang.String,java.lang.String,java.lang.String,java.util.List,java.util.List,java.lang.String)" class="member-name-link">AgentIngress</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id,
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.net.URI,java.lang.String,java.lang.String,java.lang.String,java.util.List,java.util.List,java.time.OffsetDateTime)" class="member-name-link">AgentIngress</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&nbsp;uri,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;description,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;metadata,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;domain,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;nsTargets,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;regionDomains,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;createdAt)</code></div>
<a href="https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html" title="class or interface in java.time" class="external-link">OffsetDateTime</a>&nbsp;createdAt)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a new instance of <a href="AgentIngress.html" title="class in com.ngrok.definitions"><code>AgentIngress</code></a>.</div>
</div>
@@ -119,7 +119,7 @@ loadScripts(document, 'script');</script>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;o)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html" title="class or interface in java.time" class="external-link">OffsetDateTime</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCreatedAt()" class="member-name-link">getCreatedAt</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">timestamp when the Agent Ingress was created, RFC 3339 format</div>
@@ -186,7 +186,7 @@ loadScripts(document, 'script');</script>
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(java.lang.String,java.net.URI,java.lang.String,java.lang.String,java.lang.String,java.util.List,java.util.List,java.lang.String)">
<section class="detail" id="&lt;init&gt;(java.lang.String,java.net.URI,java.lang.String,java.lang.String,java.lang.String,java.util.List,java.util.List,java.time.OffsetDateTime)">
<h3>AgentIngress</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">AgentIngress</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&nbsp;uri,
@@ -195,7 +195,7 @@ loadScripts(document, 'script');</script>
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;domain,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;nsTargets,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;regionDomains,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;createdAt)</span></div>
<a href="https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html" title="class or interface in java.time" class="external-link">OffsetDateTime</a>&nbsp;createdAt)</span></div>
<div class="block">Creates a new instance of <a href="AgentIngress.html" title="class in com.ngrok.definitions"><code>AgentIngress</code></a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
@@ -284,7 +284,7 @@ loadScripts(document, 'script');</script>
property these values will delegate control over the domain to ngrok</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
@@ -296,18 +296,18 @@ loadScripts(document, 'script');</script>
domain this value may increase over time as ngrok adds more regions</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCreatedAt()">
<h3>getCreatedAt</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getCreatedAt</span>()</div>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html" title="class or interface in java.time" class="external-link">OffsetDateTime</a></span>&nbsp;<span class="element-name">getCreatedAt</span>()</div>
<div class="block">timestamp when the Agent Ingress was created, RFC 3339 format</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html" title="class or interface in java.time" class="external-link"><code>OffsetDateTime</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/AgentIngressList.html
+4 -4
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>AgentIngressList (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>AgentIngressList (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: AgentIngressList">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -187,7 +187,7 @@ implements <a href="Pageable.html" title="interface in com.ngrok.definitions">Pa
<div class="block">the list of Agent Ingresses owned by this account</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="AgentIngress.html" title="class in com.ngrok.definitions">AgentIngress</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="AgentIngress.html" title="class in com.ngrok.definitions"><code>AgentIngress</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/ApiKey.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>ApiKey (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>ApiKey (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: ApiKey">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/ApiKeyList.html
+4 -4
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>ApiKeyList (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>ApiKeyList (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: ApiKeyList">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -187,7 +187,7 @@ implements <a href="Pageable.html" title="interface in com.ngrok.definitions">Pa
<div class="block">the list of API keys for this account</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="ApiKey.html" title="class in com.ngrok.definitions">ApiKey</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="ApiKey.html" title="class in com.ngrok.definitions"><code>ApiKey</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/AwsAuth.Builder.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>AwsAuth.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>AwsAuth.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: AwsAuth, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/AwsAuth.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>AwsAuth (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>AwsAuth (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: AwsAuth">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/AwsCredentials.Builder.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>AwsCredentials.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>AwsCredentials.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: AwsCredentials, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/AwsCredentials.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>AwsCredentials (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>AwsCredentials (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: AwsCredentials">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/AwsRole.Builder.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>AwsRole.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>AwsRole.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: AwsRole, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/AwsRole.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>AwsRole (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>AwsRole (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: AwsRole">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/CertificateAuthority.html
+5 -5
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>CertificateAuthority (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>CertificateAuthority (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: CertificateAuthority">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -348,7 +348,7 @@ loadScripts(document, 'script');</script>
<div class="block">set of actions the private key of this Certificate Authority can be used for</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
@@ -360,7 +360,7 @@ loadScripts(document, 'script');</script>
used for</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/CertificateAuthorityList.html
+4 -4
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>CertificateAuthorityList (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>CertificateAuthorityList (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: CertificateAuthorityList">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -187,7 +187,7 @@ implements <a href="Pageable.html" title="interface in com.ngrok.definitions">Pa
<div class="block">the list of all certificate authorities on this account</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="CertificateAuthority.html" title="class in com.ngrok.definitions">CertificateAuthority</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="CertificateAuthority.html" title="class in com.ngrok.definitions"><code>CertificateAuthority</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/Credential.html
+10 -10
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>Credential (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>Credential (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: Credential">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -147,7 +147,7 @@ loadScripts(document, 'script');</script>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getToken()" class="member-name-link">getToken</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">the credential's authtoken that can be used to authenticate an ngrok agent.</div>
<div class="block">the credential&#39;s authtoken that can be used to authenticate an ngrok agent.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUri()" class="member-name-link">getUri</a>()</code></div>
@@ -195,8 +195,8 @@ loadScripts(document, 'script');</script>
<dd><code>createdAt</code> - timestamp when the tunnel credential was created, RFC 3339 format</dd>
<dd><code>description</code> - human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.</dd>
<dd><code>metadata</code> - arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.</dd>
<dd><code>token</code> - the credential's authtoken that can be used to authenticate an ngrok agent. <strong>This value is only available one time, on the API response from credential creation, otherwise it is null.</strong></dd>
<dd><code>acl</code> - optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</dd>
<dd><code>token</code> - the credential&#39;s authtoken that can be used to authenticate an ngrok agent. <strong>This value is only available one time, on the API response from credential creation, otherwise it is null.</strong></dd>
<dd><code>acl</code> - optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>&#39;*&#39;</code> is equivalent to no acl at all and will explicitly permit all actions.</dd>
</dl>
</section>
</li>
@@ -269,7 +269,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="getToken()">
<h3>getToken</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">getToken</span>()</div>
<div class="block">the credential's authtoken that can be used to authenticate an ngrok agent.
<div class="block">the credential&#39;s authtoken that can be used to authenticate an ngrok agent.
<strong>This value is only available one time, on the API response from
credential creation, otherwise it is null.</strong></div>
<dl class="notes">
@@ -291,11 +291,11 @@ loadScripts(document, 'script');</script>
match multiple domains with a common suffix. For example, you may specify a rule
of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>,
<code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of
<code>'*'</code> is equivalent to no acl at all and will explicitly permit all
actions.</div>
<code>&#39;*&#39;</code> is equivalent to no acl at all and will explicitly
permit all actions.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/CredentialList.html
+4 -4
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>CredentialList (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>CredentialList (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: CredentialList">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -187,7 +187,7 @@ implements <a href="Pageable.html" title="interface in com.ngrok.definitions">Pa
<div class="block">the list of all tunnel credentials on this account</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="Credential.html" title="class in com.ngrok.definitions">Credential</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="Credential.html" title="class in com.ngrok.definitions"><code>Credential</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/Endpoint.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>Endpoint (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>Endpoint (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: Endpoint">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EndpointBackend.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointBackend (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointBackend (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointBackend">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EndpointBackendMutate.Builder.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointBackendMutate.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointBackendMutate.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointBackendMutate, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EndpointBackendMutate.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointBackendMutate (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointBackendMutate (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointBackendMutate">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EndpointCircuitBreaker.Builder.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointCircuitBreaker.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointCircuitBreaker.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointCircuitBreaker, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EndpointCircuitBreaker.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointCircuitBreaker (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointCircuitBreaker (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointCircuitBreaker">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EndpointCompression.Builder.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointCompression.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointCompression.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointCompression, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EndpointCompression.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointCompression (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointCompression (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointCompression">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EndpointIpPolicy.html
+5 -5
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointIpPolicy (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointIpPolicy (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointIpPolicy">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -156,7 +156,7 @@ loadScripts(document, 'script');</script>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>enabled</code> - <code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</dd>
<dd><code>ipPolicies</code> - the value of the <code>ip_policies</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="Ref.html" title="class in com.ngrok.definitions">Ref</a>&gt;</code></dd>
<dd><code>ipPolicies</code> - the value of the <code>ip_policies</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="Ref.html" title="class in com.ngrok.definitions"><code>Ref</code></a></dd>
</dl>
</section>
</li>
@@ -187,7 +187,7 @@ loadScripts(document, 'script');</script>
<div class="block">Fetches the value of the <code>ipPolicies</code> property.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="Ref.html" title="class in com.ngrok.definitions">Ref</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="Ref.html" title="class in com.ngrok.definitions"><code>Ref</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/EndpointIpPolicyMutate.Builder.html
+5 -5
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointIpPolicyMutate.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointIpPolicyMutate.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointIpPolicyMutate, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -180,7 +180,7 @@ loadScripts(document, 'script');</script>
access to the endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>ipPolicyIds</code> - the value of the <code>ip_policy_ids</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>ipPolicyIds</code> - the value of the <code>ip_policy_ids</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -194,7 +194,7 @@ loadScripts(document, 'script');</script>
access to the endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>ipPolicyIds</code> - the value of the <code>ip_policy_ids</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>ipPolicyIds</code> - the value of the <code>ip_policy_ids</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
docs/com/ngrok/definitions/EndpointIpPolicyMutate.html
+4 -4
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointIpPolicyMutate (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointIpPolicyMutate (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointIpPolicyMutate">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -185,7 +185,7 @@ loadScripts(document, 'script');</script>
access to the endpoint</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/EndpointList.html
+4 -4
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointList (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointList (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointList">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -187,7 +187,7 @@ implements <a href="Pageable.html" title="interface in com.ngrok.definitions">Pa
<div class="block">the list of all active endpoints on this account</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="Endpoint.html" title="class in com.ngrok.definitions">Endpoint</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="Endpoint.html" title="class in com.ngrok.definitions"><code>Endpoint</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/EndpointMutualTls.html
+4 -4
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointMutualTls (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointMutualTls (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointMutualTls">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -188,7 +188,7 @@ loadScripts(document, 'script');</script>
provided by concatenating them together.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="Ref.html" title="class in com.ngrok.definitions">Ref</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="Ref.html" title="class in com.ngrok.definitions"><code>Ref</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/EndpointMutualTlsMutate.Builder.html
+5 -5
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointMutualTlsMutate.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointMutualTlsMutate.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointMutualTlsMutate, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -180,7 +180,7 @@ loadScripts(document, 'script');</script>
certificate presented by the initiator of the TLS connection</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>certificateAuthorityIds</code> - the value of the <code>certificate_authority_ids</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>certificateAuthorityIds</code> - the value of the <code>certificate_authority_ids</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -194,7 +194,7 @@ loadScripts(document, 'script');</script>
certificate presented by the initiator of the TLS connection</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>certificateAuthorityIds</code> - the value of the <code>certificate_authority_ids</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>certificateAuthorityIds</code> - the value of the <code>certificate_authority_ids</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
docs/com/ngrok/definitions/EndpointMutualTlsMutate.html
+4 -4
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointMutualTlsMutate (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointMutualTlsMutate (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointMutualTlsMutate">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -185,7 +185,7 @@ loadScripts(document, 'script');</script>
certificate presented by the initiator of the TLS connection</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/EndpointOAuth.Builder.html
+5 -5
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointOAuth.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointOAuth.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointOAuth, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -293,7 +293,7 @@ loadScripts(document, 'script');</script>
<h3>cookiePrefix</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuth.Builder.html" title="class in com.ngrok.definitions">EndpointOAuth.Builder</a></span>&nbsp;<span class="element-name">cookiePrefix</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;cookiePrefix)</span></div>
<div class="block">the prefix of the session cookie that ngrok sets on the http client to cache
authentication. default is 'ngrok.'</div>
authentication. default is &#39;ngrok.&#39;</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>cookiePrefix</code> - the value of the <code>cookie_prefix</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
@@ -307,7 +307,7 @@ loadScripts(document, 'script');</script>
<h3>cookiePrefix</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuth.Builder.html" title="class in com.ngrok.definitions">EndpointOAuth.Builder</a></span>&nbsp;<span class="element-name">cookiePrefix</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;cookiePrefix)</span></div>
<div class="block">the prefix of the session cookie that ngrok sets on the http client to cache
authentication. default is 'ngrok.'</div>
authentication. default is &#39;ngrok.&#39;</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>cookiePrefix</code> - the value of the <code>cookie_prefix</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
docs/com/ngrok/definitions/EndpointOAuth.html
+4 -4
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointOAuth (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointOAuth (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointOAuth">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -236,7 +236,7 @@ loadScripts(document, 'script');</script>
<h3>getCookiePrefix</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getCookiePrefix</span>()</div>
<div class="block">the prefix of the session cookie that ngrok sets on the http client to cache
authentication. default is 'ngrok.'</div>
authentication. default is &#39;ngrok.&#39;</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
docs/com/ngrok/definitions/EndpointOAuthFacebook.Builder.html
+17 -17
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointOAuthFacebook.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointOAuthFacebook.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointOAuthFacebook, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -180,7 +180,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="clientId(java.lang.String)">
<h3>clientId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuthFacebook.Builder.html" title="class in com.ngrok.definitions">EndpointOAuthFacebook.Builder</a></span>&nbsp;<span class="element-name">clientId</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;clientId)</span></div>
<div class="block">the OAuth app client ID. retrieve it from the identity provider's dashboard
<div class="block">the OAuth app client ID. retrieve it from the identity provider&#39;s dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -197,7 +197,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="clientId(java.util.Optional)">
<h3>clientId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuthFacebook.Builder.html" title="class in com.ngrok.definitions">EndpointOAuthFacebook.Builder</a></span>&nbsp;<span class="element-name">clientId</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;clientId)</span></div>
<div class="block">the OAuth app client ID. retrieve it from the identity provider's dashboard
<div class="block">the OAuth app client ID. retrieve it from the identity provider&#39;s dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -214,9 +214,9 @@ loadScripts(document, 'script');</script>
<section class="detail" id="clientSecret(java.lang.String)">
<h3>clientSecret</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuthFacebook.Builder.html" title="class in com.ngrok.definitions">EndpointOAuthFacebook.Builder</a></span>&nbsp;<span class="element-name">clientSecret</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;clientSecret)</span></div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider's dashboard
where you created your own OAuth app. optional, see all of the caveats in the
docs for <code>client_id</code>.</div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider&#39;s
dashboard where you created your own OAuth app. optional, see all of the caveats
in the docs for <code>client_id</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>clientSecret</code> - the value of the <code>client_secret</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
@@ -229,9 +229,9 @@ loadScripts(document, 'script');</script>
<section class="detail" id="clientSecret(java.util.Optional)">
<h3>clientSecret</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuthFacebook.Builder.html" title="class in com.ngrok.definitions">EndpointOAuthFacebook.Builder</a></span>&nbsp;<span class="element-name">clientSecret</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;clientSecret)</span></div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider's dashboard
where you created your own OAuth app. optional, see all of the caveats in the
docs for <code>client_id</code>.</div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider&#39;s
dashboard where you created your own OAuth app. optional, see all of the caveats
in the docs for <code>client_id</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>clientSecret</code> - the value of the <code>client_secret</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
@@ -250,7 +250,7 @@ loadScripts(document, 'script');</script>
<code>client_secret</code> to set scopes)</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>scopes</code> - the value of the <code>scopes</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>scopes</code> - the value of the <code>scopes</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -266,7 +266,7 @@ loadScripts(document, 'script');</script>
<code>client_secret</code> to set scopes)</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>scopes</code> - the value of the <code>scopes</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>scopes</code> - the value of the <code>scopes</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -280,7 +280,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>emailAddresses</code> - the value of the <code>email_addresses</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>emailAddresses</code> - the value of the <code>email_addresses</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -294,7 +294,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>emailAddresses</code> - the value of the <code>email_addresses</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>emailAddresses</code> - the value of the <code>email_addresses</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -308,7 +308,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>emailDomains</code> - the value of the <code>email_domains</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>emailDomains</code> - the value of the <code>email_domains</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -322,7 +322,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>emailDomains</code> - the value of the <code>email_domains</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>emailDomains</code> - the value of the <code>email_domains</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
docs/com/ngrok/definitions/EndpointOAuthFacebook.html
+10 -10
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointOAuthFacebook (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointOAuthFacebook (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointOAuthFacebook">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -185,7 +185,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="getClientId()">
<h3>getClientId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">getClientId</span>()</div>
<div class="block">the OAuth app client ID. retrieve it from the identity provider's dashboard
<div class="block">the OAuth app client ID. retrieve it from the identity provider&#39;s dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -200,9 +200,9 @@ loadScripts(document, 'script');</script>
<section class="detail" id="getClientSecret()">
<h3>getClientSecret</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">getClientSecret</span>()</div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider's dashboard
where you created your own OAuth app. optional, see all of the caveats in the
docs for <code>client_id</code>.</div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider&#39;s
dashboard where you created your own OAuth app. optional, see all of the caveats
in the docs for <code>client_id</code>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
@@ -219,7 +219,7 @@ loadScripts(document, 'script');</script>
<code>client_secret</code> to set scopes)</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
@@ -231,7 +231,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
@@ -243,7 +243,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/EndpointOAuthGitHub.Builder.html
+31 -29
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointOAuthGitHub.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointOAuthGitHub.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointOAuthGitHub, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -200,7 +200,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="clientId(java.lang.String)">
<h3>clientId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuthGitHub.Builder.html" title="class in com.ngrok.definitions">EndpointOAuthGitHub.Builder</a></span>&nbsp;<span class="element-name">clientId</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;clientId)</span></div>
<div class="block">the OAuth app client ID. retrieve it from the identity provider's dashboard
<div class="block">the OAuth app client ID. retrieve it from the identity provider&#39;s dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -217,7 +217,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="clientId(java.util.Optional)">
<h3>clientId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuthGitHub.Builder.html" title="class in com.ngrok.definitions">EndpointOAuthGitHub.Builder</a></span>&nbsp;<span class="element-name">clientId</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;clientId)</span></div>
<div class="block">the OAuth app client ID. retrieve it from the identity provider's dashboard
<div class="block">the OAuth app client ID. retrieve it from the identity provider&#39;s dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -234,9 +234,9 @@ loadScripts(document, 'script');</script>
<section class="detail" id="clientSecret(java.lang.String)">
<h3>clientSecret</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuthGitHub.Builder.html" title="class in com.ngrok.definitions">EndpointOAuthGitHub.Builder</a></span>&nbsp;<span class="element-name">clientSecret</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;clientSecret)</span></div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider's dashboard
where you created your own OAuth app. optional, see all of the caveats in the
docs for <code>client_id</code>.</div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider&#39;s
dashboard where you created your own OAuth app. optional, see all of the caveats
in the docs for <code>client_id</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>clientSecret</code> - the value of the <code>client_secret</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
@@ -249,9 +249,9 @@ loadScripts(document, 'script');</script>
<section class="detail" id="clientSecret(java.util.Optional)">
<h3>clientSecret</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuthGitHub.Builder.html" title="class in com.ngrok.definitions">EndpointOAuthGitHub.Builder</a></span>&nbsp;<span class="element-name">clientSecret</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;clientSecret)</span></div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider's dashboard
where you created your own OAuth app. optional, see all of the caveats in the
docs for <code>client_id</code>.</div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider&#39;s
dashboard where you created your own OAuth app. optional, see all of the caveats
in the docs for <code>client_id</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>clientSecret</code> - the value of the <code>client_secret</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
@@ -270,7 +270,7 @@ loadScripts(document, 'script');</script>
<code>client_secret</code> to set scopes)</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>scopes</code> - the value of the <code>scopes</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>scopes</code> - the value of the <code>scopes</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -286,7 +286,7 @@ loadScripts(document, 'script');</script>
<code>client_secret</code> to set scopes)</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>scopes</code> - the value of the <code>scopes</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>scopes</code> - the value of the <code>scopes</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -300,7 +300,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>emailAddresses</code> - the value of the <code>email_addresses</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>emailAddresses</code> - the value of the <code>email_addresses</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -314,7 +314,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>emailAddresses</code> - the value of the <code>email_addresses</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>emailAddresses</code> - the value of the <code>email_addresses</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -328,7 +328,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>emailDomains</code> - the value of the <code>email_domains</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>emailDomains</code> - the value of the <code>email_domains</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -342,7 +342,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>emailDomains</code> - the value of the <code>email_domains</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>emailDomains</code> - the value of the <code>email_domains</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -353,11 +353,12 @@ loadScripts(document, 'script');</script>
<h3>teams</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuthGitHub.Builder.html" title="class in com.ngrok.definitions">EndpointOAuthGitHub.Builder</a></span>&nbsp;<span class="element-name">teams</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;teams)</span></div>
<div class="block">a list of github teams identifiers. users will be allowed access to the endpoint
if they are a member of any of these teams. identifiers should be in the 'slug'
format qualified with the org name, e.g. <code>org-name/team-name</code></div>
if they are a member of any of these teams. identifiers should be in the
&#39;slug&#39; format qualified with the org name, e.g.
<code>org-name/team-name</code></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>teams</code> - the value of the <code>teams</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>teams</code> - the value of the <code>teams</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -368,11 +369,12 @@ loadScripts(document, 'script');</script>
<h3>teams</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuthGitHub.Builder.html" title="class in com.ngrok.definitions">EndpointOAuthGitHub.Builder</a></span>&nbsp;<span class="element-name">teams</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&gt;&nbsp;teams)</span></div>
<div class="block">a list of github teams identifiers. users will be allowed access to the endpoint
if they are a member of any of these teams. identifiers should be in the 'slug'
format qualified with the org name, e.g. <code>org-name/team-name</code></div>
if they are a member of any of these teams. identifiers should be in the
&#39;slug&#39; format qualified with the org name, e.g.
<code>org-name/team-name</code></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>teams</code> - the value of the <code>teams</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>teams</code> - the value of the <code>teams</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -383,11 +385,11 @@ loadScripts(document, 'script');</script>
<h3>organizations</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuthGitHub.Builder.html" title="class in com.ngrok.definitions">EndpointOAuthGitHub.Builder</a></span>&nbsp;<span class="element-name">organizations</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;organizations)</span></div>
<div class="block">a list of github org identifiers. users who are members of any of the listed
organizations will be allowed access. identifiers should be the organization's
'slug'</div>
organizations will be allowed access. identifiers should be the
organization&#39;s &#39;slug&#39;</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>organizations</code> - the value of the <code>organizations</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>organizations</code> - the value of the <code>organizations</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -398,11 +400,11 @@ loadScripts(document, 'script');</script>
<h3>organizations</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuthGitHub.Builder.html" title="class in com.ngrok.definitions">EndpointOAuthGitHub.Builder</a></span>&nbsp;<span class="element-name">organizations</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&gt;&nbsp;organizations)</span></div>
<div class="block">a list of github org identifiers. users who are members of any of the listed
organizations will be allowed access. identifiers should be the organization's
'slug'</div>
organizations will be allowed access. identifiers should be the
organization&#39;s &#39;slug&#39;</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>organizations</code> - the value of the <code>organizations</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>organizations</code> - the value of the <code>organizations</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
docs/com/ngrok/definitions/EndpointOAuthGitHub.html
+17 -16
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointOAuthGitHub (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointOAuthGitHub (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointOAuthGitHub">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -195,7 +195,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="getClientId()">
<h3>getClientId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">getClientId</span>()</div>
<div class="block">the OAuth app client ID. retrieve it from the identity provider's dashboard
<div class="block">the OAuth app client ID. retrieve it from the identity provider&#39;s dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -210,9 +210,9 @@ loadScripts(document, 'script');</script>
<section class="detail" id="getClientSecret()">
<h3>getClientSecret</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">getClientSecret</span>()</div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider's dashboard
where you created your own OAuth app. optional, see all of the caveats in the
docs for <code>client_id</code>.</div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider&#39;s
dashboard where you created your own OAuth app. optional, see all of the caveats
in the docs for <code>client_id</code>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
@@ -229,7 +229,7 @@ loadScripts(document, 'script');</script>
<code>client_secret</code> to set scopes)</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
@@ -241,7 +241,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
@@ -253,7 +253,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
@@ -262,11 +262,12 @@ loadScripts(document, 'script');</script>
<h3>getTeams</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">getTeams</span>()</div>
<div class="block">a list of github teams identifiers. users will be allowed access to the endpoint
if they are a member of any of these teams. identifiers should be in the 'slug'
format qualified with the org name, e.g. <code>org-name/team-name</code></div>
if they are a member of any of these teams. identifiers should be in the
&#39;slug&#39; format qualified with the org name, e.g.
<code>org-name/team-name</code></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
@@ -275,11 +276,11 @@ loadScripts(document, 'script');</script>
<h3>getOrganizations</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">getOrganizations</span>()</div>
<div class="block">a list of github org identifiers. users who are members of any of the listed
organizations will be allowed access. identifiers should be the organization's
'slug'</div>
organizations will be allowed access. identifiers should be the
organization&#39;s &#39;slug&#39;</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/EndpointOAuthGoogle.Builder.html
+17 -17
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointOAuthGoogle.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointOAuthGoogle.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointOAuthGoogle, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -180,7 +180,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="clientId(java.lang.String)">
<h3>clientId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuthGoogle.Builder.html" title="class in com.ngrok.definitions">EndpointOAuthGoogle.Builder</a></span>&nbsp;<span class="element-name">clientId</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;clientId)</span></div>
<div class="block">the OAuth app client ID. retrieve it from the identity provider's dashboard
<div class="block">the OAuth app client ID. retrieve it from the identity provider&#39;s dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -197,7 +197,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="clientId(java.util.Optional)">
<h3>clientId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuthGoogle.Builder.html" title="class in com.ngrok.definitions">EndpointOAuthGoogle.Builder</a></span>&nbsp;<span class="element-name">clientId</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;clientId)</span></div>
<div class="block">the OAuth app client ID. retrieve it from the identity provider's dashboard
<div class="block">the OAuth app client ID. retrieve it from the identity provider&#39;s dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -214,9 +214,9 @@ loadScripts(document, 'script');</script>
<section class="detail" id="clientSecret(java.lang.String)">
<h3>clientSecret</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuthGoogle.Builder.html" title="class in com.ngrok.definitions">EndpointOAuthGoogle.Builder</a></span>&nbsp;<span class="element-name">clientSecret</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;clientSecret)</span></div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider's dashboard
where you created your own OAuth app. optional, see all of the caveats in the
docs for <code>client_id</code>.</div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider&#39;s
dashboard where you created your own OAuth app. optional, see all of the caveats
in the docs for <code>client_id</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>clientSecret</code> - the value of the <code>client_secret</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
@@ -229,9 +229,9 @@ loadScripts(document, 'script');</script>
<section class="detail" id="clientSecret(java.util.Optional)">
<h3>clientSecret</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuthGoogle.Builder.html" title="class in com.ngrok.definitions">EndpointOAuthGoogle.Builder</a></span>&nbsp;<span class="element-name">clientSecret</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;clientSecret)</span></div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider's dashboard
where you created your own OAuth app. optional, see all of the caveats in the
docs for <code>client_id</code>.</div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider&#39;s
dashboard where you created your own OAuth app. optional, see all of the caveats
in the docs for <code>client_id</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>clientSecret</code> - the value of the <code>client_secret</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
@@ -250,7 +250,7 @@ loadScripts(document, 'script');</script>
<code>client_secret</code> to set scopes)</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>scopes</code> - the value of the <code>scopes</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>scopes</code> - the value of the <code>scopes</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -266,7 +266,7 @@ loadScripts(document, 'script');</script>
<code>client_secret</code> to set scopes)</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>scopes</code> - the value of the <code>scopes</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>scopes</code> - the value of the <code>scopes</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -280,7 +280,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>emailAddresses</code> - the value of the <code>email_addresses</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>emailAddresses</code> - the value of the <code>email_addresses</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -294,7 +294,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>emailAddresses</code> - the value of the <code>email_addresses</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>emailAddresses</code> - the value of the <code>email_addresses</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -308,7 +308,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>emailDomains</code> - the value of the <code>email_domains</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>emailDomains</code> - the value of the <code>email_domains</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -322,7 +322,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>emailDomains</code> - the value of the <code>email_domains</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>emailDomains</code> - the value of the <code>email_domains</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
docs/com/ngrok/definitions/EndpointOAuthGoogle.html
+10 -10
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointOAuthGoogle (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointOAuthGoogle (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointOAuthGoogle">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -185,7 +185,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="getClientId()">
<h3>getClientId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">getClientId</span>()</div>
<div class="block">the OAuth app client ID. retrieve it from the identity provider's dashboard
<div class="block">the OAuth app client ID. retrieve it from the identity provider&#39;s dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -200,9 +200,9 @@ loadScripts(document, 'script');</script>
<section class="detail" id="getClientSecret()">
<h3>getClientSecret</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">getClientSecret</span>()</div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider's dashboard
where you created your own OAuth app. optional, see all of the caveats in the
docs for <code>client_id</code>.</div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider&#39;s
dashboard where you created your own OAuth app. optional, see all of the caveats
in the docs for <code>client_id</code>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
@@ -219,7 +219,7 @@ loadScripts(document, 'script');</script>
<code>client_secret</code> to set scopes)</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
@@ -231,7 +231,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
@@ -243,7 +243,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/EndpointOAuthMicrosoft.Builder.html
+17 -17
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointOAuthMicrosoft.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointOAuthMicrosoft.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointOAuthMicrosoft, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -180,7 +180,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="clientId(java.lang.String)">
<h3>clientId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuthMicrosoft.Builder.html" title="class in com.ngrok.definitions">EndpointOAuthMicrosoft.Builder</a></span>&nbsp;<span class="element-name">clientId</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;clientId)</span></div>
<div class="block">the OAuth app client ID. retrieve it from the identity provider's dashboard
<div class="block">the OAuth app client ID. retrieve it from the identity provider&#39;s dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -197,7 +197,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="clientId(java.util.Optional)">
<h3>clientId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuthMicrosoft.Builder.html" title="class in com.ngrok.definitions">EndpointOAuthMicrosoft.Builder</a></span>&nbsp;<span class="element-name">clientId</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;clientId)</span></div>
<div class="block">the OAuth app client ID. retrieve it from the identity provider's dashboard
<div class="block">the OAuth app client ID. retrieve it from the identity provider&#39;s dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -214,9 +214,9 @@ loadScripts(document, 'script');</script>
<section class="detail" id="clientSecret(java.lang.String)">
<h3>clientSecret</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuthMicrosoft.Builder.html" title="class in com.ngrok.definitions">EndpointOAuthMicrosoft.Builder</a></span>&nbsp;<span class="element-name">clientSecret</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;clientSecret)</span></div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider's dashboard
where you created your own OAuth app. optional, see all of the caveats in the
docs for <code>client_id</code>.</div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider&#39;s
dashboard where you created your own OAuth app. optional, see all of the caveats
in the docs for <code>client_id</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>clientSecret</code> - the value of the <code>client_secret</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
@@ -229,9 +229,9 @@ loadScripts(document, 'script');</script>
<section class="detail" id="clientSecret(java.util.Optional)">
<h3>clientSecret</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOAuthMicrosoft.Builder.html" title="class in com.ngrok.definitions">EndpointOAuthMicrosoft.Builder</a></span>&nbsp;<span class="element-name">clientSecret</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;clientSecret)</span></div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider's dashboard
where you created your own OAuth app. optional, see all of the caveats in the
docs for <code>client_id</code>.</div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider&#39;s
dashboard where you created your own OAuth app. optional, see all of the caveats
in the docs for <code>client_id</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>clientSecret</code> - the value of the <code>client_secret</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
@@ -250,7 +250,7 @@ loadScripts(document, 'script');</script>
<code>client_secret</code> to set scopes)</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>scopes</code> - the value of the <code>scopes</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>scopes</code> - the value of the <code>scopes</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -266,7 +266,7 @@ loadScripts(document, 'script');</script>
<code>client_secret</code> to set scopes)</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>scopes</code> - the value of the <code>scopes</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>scopes</code> - the value of the <code>scopes</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -280,7 +280,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>emailAddresses</code> - the value of the <code>email_addresses</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>emailAddresses</code> - the value of the <code>email_addresses</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -294,7 +294,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>emailAddresses</code> - the value of the <code>email_addresses</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>emailAddresses</code> - the value of the <code>email_addresses</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -308,7 +308,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>emailDomains</code> - the value of the <code>email_domains</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>emailDomains</code> - the value of the <code>email_domains</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -322,7 +322,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>emailDomains</code> - the value of the <code>email_domains</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>emailDomains</code> - the value of the <code>email_domains</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
docs/com/ngrok/definitions/EndpointOAuthMicrosoft.html
+10 -10
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointOAuthMicrosoft (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointOAuthMicrosoft (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointOAuthMicrosoft">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -185,7 +185,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="getClientId()">
<h3>getClientId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">getClientId</span>()</div>
<div class="block">the OAuth app client ID. retrieve it from the identity provider's dashboard
<div class="block">the OAuth app client ID. retrieve it from the identity provider&#39;s dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -200,9 +200,9 @@ loadScripts(document, 'script');</script>
<section class="detail" id="getClientSecret()">
<h3>getClientSecret</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">getClientSecret</span>()</div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider's dashboard
where you created your own OAuth app. optional, see all of the caveats in the
docs for <code>client_id</code>.</div>
<div class="block">the OAuth app client secret. retrieve if from the identity provider&#39;s
dashboard where you created your own OAuth app. optional, see all of the caveats
in the docs for <code>client_id</code>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
@@ -219,7 +219,7 @@ loadScripts(document, 'script');</script>
<code>client_secret</code> to set scopes)</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
@@ -231,7 +231,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
@@ -243,7 +243,7 @@ loadScripts(document, 'script');</script>
allowed access to the endpoint</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/EndpointOAuthProvider.Builder.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointOAuthProvider.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointOAuthProvider.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointOAuthProvider, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EndpointOAuthProvider.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointOAuthProvider (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointOAuthProvider (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointOAuthProvider">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EndpointOidc.Builder.html
+21 -19
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointOidc.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointOidc.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointOidc, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -106,22 +106,22 @@ loadScripts(document, 'script');</script>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="EndpointOidc.Builder.html" title="class in com.ngrok.definitions">EndpointOidc.Builder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clientId(java.lang.String)" class="member-name-link">clientId</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;clientId)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The OIDC app's client ID and OIDC audience.</div>
<div class="block">The OIDC app&#39;s client ID and OIDC audience.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="EndpointOidc.Builder.html" title="class in com.ngrok.definitions">EndpointOidc.Builder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clientId(java.util.Optional)" class="member-name-link">clientId</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;clientId)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The OIDC app's client ID and OIDC audience.</div>
<div class="block">The OIDC app&#39;s client ID and OIDC audience.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="EndpointOidc.Builder.html" title="class in com.ngrok.definitions">EndpointOidc.Builder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clientSecret(java.lang.String)" class="member-name-link">clientSecret</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;clientSecret)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The OIDC app's client secret.</div>
<div class="block">The OIDC app&#39;s client secret.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="EndpointOidc.Builder.html" title="class in com.ngrok.definitions">EndpointOidc.Builder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clientSecret(java.util.Optional)" class="member-name-link">clientSecret</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;clientSecret)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The OIDC app's client secret.</div>
<div class="block">The OIDC app&#39;s client secret.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="EndpointOidc.Builder.html" title="class in com.ngrok.definitions">EndpointOidc.Builder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#cookiePrefix(java.lang.String)" class="member-name-link">cookiePrefix</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;cookiePrefix)</code></div>
@@ -164,12 +164,12 @@ loadScripts(document, 'script');</script>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="EndpointOidc.Builder.html" title="class in com.ngrok.definitions">EndpointOidc.Builder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#issuer(java.lang.String)" class="member-name-link">issuer</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;issuer)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">URL of the OIDC "OpenID provider".</div>
<div class="block">URL of the OIDC &#34;OpenID provider&#34;.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="EndpointOidc.Builder.html" title="class in com.ngrok.definitions">EndpointOidc.Builder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#issuer(java.util.Optional)" class="member-name-link">issuer</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;issuer)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">URL of the OIDC "OpenID provider".</div>
<div class="block">URL of the OIDC &#34;OpenID provider&#34;.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="EndpointOidc.Builder.html" title="class in com.ngrok.definitions">EndpointOidc.Builder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#maximumDuration(java.time.Duration)" class="member-name-link">maximumDuration</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a>&nbsp;maximumDuration)</code></div>
@@ -279,7 +279,7 @@ loadScripts(document, 'script');</script>
<h3>cookiePrefix</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOidc.Builder.html" title="class in com.ngrok.definitions">EndpointOidc.Builder</a></span>&nbsp;<span class="element-name">cookiePrefix</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;cookiePrefix)</span></div>
<div class="block">the prefix of the session cookie that ngrok sets on the http client to cache
authentication. default is 'ngrok.'</div>
authentication. default is &#39;ngrok.&#39;</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>cookiePrefix</code> - the value of the <code>cookie_prefix</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
@@ -293,7 +293,7 @@ loadScripts(document, 'script');</script>
<h3>cookiePrefix</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOidc.Builder.html" title="class in com.ngrok.definitions">EndpointOidc.Builder</a></span>&nbsp;<span class="element-name">cookiePrefix</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;cookiePrefix)</span></div>
<div class="block">the prefix of the session cookie that ngrok sets on the http client to cache
authentication. default is 'ngrok.'</div>
authentication. default is &#39;ngrok.&#39;</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>cookiePrefix</code> - the value of the <code>cookie_prefix</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
@@ -364,7 +364,8 @@ loadScripts(document, 'script');</script>
<section class="detail" id="issuer(java.lang.String)">
<h3>issuer</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOidc.Builder.html" title="class in com.ngrok.definitions">EndpointOidc.Builder</a></span>&nbsp;<span class="element-name">issuer</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;issuer)</span></div>
<div class="block">URL of the OIDC "OpenID provider". This is the base URL used for discovery.</div>
<div class="block">URL of the OIDC &#34;OpenID provider&#34;. This is the base URL used for
discovery.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>issuer</code> - the value of the <code>issuer</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
@@ -377,7 +378,8 @@ loadScripts(document, 'script');</script>
<section class="detail" id="issuer(java.util.Optional)">
<h3>issuer</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOidc.Builder.html" title="class in com.ngrok.definitions">EndpointOidc.Builder</a></span>&nbsp;<span class="element-name">issuer</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;issuer)</span></div>
<div class="block">URL of the OIDC "OpenID provider". This is the base URL used for discovery.</div>
<div class="block">URL of the OIDC &#34;OpenID provider&#34;. This is the base URL used for
discovery.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>issuer</code> - the value of the <code>issuer</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
@@ -390,7 +392,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="clientId(java.lang.String)">
<h3>clientId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOidc.Builder.html" title="class in com.ngrok.definitions">EndpointOidc.Builder</a></span>&nbsp;<span class="element-name">clientId</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;clientId)</span></div>
<div class="block">The OIDC app's client ID and OIDC audience.</div>
<div class="block">The OIDC app&#39;s client ID and OIDC audience.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>clientId</code> - the value of the <code>client_id</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
@@ -403,7 +405,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="clientId(java.util.Optional)">
<h3>clientId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOidc.Builder.html" title="class in com.ngrok.definitions">EndpointOidc.Builder</a></span>&nbsp;<span class="element-name">clientId</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;clientId)</span></div>
<div class="block">The OIDC app's client ID and OIDC audience.</div>
<div class="block">The OIDC app&#39;s client ID and OIDC audience.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>clientId</code> - the value of the <code>client_id</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
@@ -416,7 +418,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="clientSecret(java.lang.String)">
<h3>clientSecret</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOidc.Builder.html" title="class in com.ngrok.definitions">EndpointOidc.Builder</a></span>&nbsp;<span class="element-name">clientSecret</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;clientSecret)</span></div>
<div class="block">The OIDC app's client secret.</div>
<div class="block">The OIDC app&#39;s client secret.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>clientSecret</code> - the value of the <code>client_secret</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
@@ -429,7 +431,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="clientSecret(java.util.Optional)">
<h3>clientSecret</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointOidc.Builder.html" title="class in com.ngrok.definitions">EndpointOidc.Builder</a></span>&nbsp;<span class="element-name">clientSecret</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;clientSecret)</span></div>
<div class="block">The OIDC app's client secret.</div>
<div class="block">The OIDC app&#39;s client secret.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>clientSecret</code> - the value of the <code>client_secret</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
@@ -445,7 +447,7 @@ loadScripts(document, 'script');</script>
<div class="block">The set of scopes to request from the OIDC identity provider.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>scopes</code> - the value of the <code>scopes</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>scopes</code> - the value of the <code>scopes</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -458,7 +460,7 @@ loadScripts(document, 'script');</script>
<div class="block">The set of scopes to request from the OIDC identity provider.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>scopes</code> - the value of the <code>scopes</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>scopes</code> - the value of the <code>scopes</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
docs/com/ngrok/definitions/EndpointOidc.html
+12 -11
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointOidc (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointOidc (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointOidc">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -117,12 +117,12 @@ loadScripts(document, 'script');</script>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getClientId()" class="member-name-link">getClientId</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The OIDC app's client ID and OIDC audience.</div>
<div class="block">The OIDC app&#39;s client ID and OIDC audience.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getClientSecret()" class="member-name-link">getClientSecret</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The OIDC app's client secret.</div>
<div class="block">The OIDC app&#39;s client secret.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCookiePrefix()" class="member-name-link">getCookiePrefix</a>()</code></div>
@@ -146,7 +146,7 @@ loadScripts(document, 'script');</script>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getIssuer()" class="member-name-link">getIssuer</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">URL of the OIDC "OpenID provider".</div>
<div class="block">URL of the OIDC &#34;OpenID provider&#34;.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaximumDuration()" class="member-name-link">getMaximumDuration</a>()</code></div>
@@ -231,7 +231,7 @@ loadScripts(document, 'script');</script>
<h3>getCookiePrefix</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getCookiePrefix</span>()</div>
<div class="block">the prefix of the session cookie that ngrok sets on the http client to cache
authentication. default is 'ngrok.'</div>
authentication. default is &#39;ngrok.&#39;</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
@@ -267,7 +267,8 @@ loadScripts(document, 'script');</script>
<section class="detail" id="getIssuer()">
<h3>getIssuer</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getIssuer</span>()</div>
<div class="block">URL of the OIDC "OpenID provider". This is the base URL used for discovery.</div>
<div class="block">URL of the OIDC &#34;OpenID provider&#34;. This is the base URL used for
discovery.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
@@ -278,7 +279,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="getClientId()">
<h3>getClientId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getClientId</span>()</div>
<div class="block">The OIDC app's client ID and OIDC audience.</div>
<div class="block">The OIDC app&#39;s client ID and OIDC audience.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
@@ -289,7 +290,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="getClientSecret()">
<h3>getClientSecret</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getClientSecret</span>()</div>
<div class="block">The OIDC app's client secret.</div>
<div class="block">The OIDC app&#39;s client secret.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
@@ -303,7 +304,7 @@ loadScripts(document, 'script');</script>
<div class="block">The set of scopes to request from the OIDC identity provider.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/EndpointRequestHeaders.Builder.html
+7 -7
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointRequestHeaders.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointRequestHeaders.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointRequestHeaders, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -192,7 +192,7 @@ loadScripts(document, 'script');</script>
before being sent to the upstream application server</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>add</code> - the value of the <code>add</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>add</code> - the value of the <code>add</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>Map</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -206,7 +206,7 @@ loadScripts(document, 'script');</script>
before being sent to the upstream application server</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>add</code> - the value of the <code>add</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>add</code> - the value of the <code>add</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>Map</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -220,7 +220,7 @@ loadScripts(document, 'script');</script>
sent to the upstream application server</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>remove</code> - the value of the <code>remove</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>remove</code> - the value of the <code>remove</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -234,7 +234,7 @@ loadScripts(document, 'script');</script>
sent to the upstream application server</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>remove</code> - the value of the <code>remove</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>remove</code> - the value of the <code>remove</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
docs/com/ngrok/definitions/EndpointRequestHeaders.html
+5 -5
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointRequestHeaders (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointRequestHeaders (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointRequestHeaders">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -191,7 +191,7 @@ loadScripts(document, 'script');</script>
before being sent to the upstream application server</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>Map</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
@@ -203,7 +203,7 @@ loadScripts(document, 'script');</script>
sent to the upstream application server</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/EndpointResponseHeaders.Builder.html
+7 -7
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointResponseHeaders.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointResponseHeaders.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointResponseHeaders, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -192,7 +192,7 @@ loadScripts(document, 'script');</script>
returned to the HTTP client</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>add</code> - the value of the <code>add</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>add</code> - the value of the <code>add</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>Map</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -206,7 +206,7 @@ loadScripts(document, 'script');</script>
returned to the HTTP client</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>add</code> - the value of the <code>add</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>add</code> - the value of the <code>add</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>Map</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -220,7 +220,7 @@ loadScripts(document, 'script');</script>
the HTTP client</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>remove</code> - the value of the <code>remove</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>remove</code> - the value of the <code>remove</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -234,7 +234,7 @@ loadScripts(document, 'script');</script>
the HTTP client</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>remove</code> - the value of the <code>remove</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>remove</code> - the value of the <code>remove</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
docs/com/ngrok/definitions/EndpointResponseHeaders.html
+5 -5
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointResponseHeaders (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointResponseHeaders (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointResponseHeaders">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -191,7 +191,7 @@ loadScripts(document, 'script');</script>
returned to the HTTP client</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>Map</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
@@ -203,7 +203,7 @@ loadScripts(document, 'script');</script>
the HTTP client</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/EndpointSaml.html
+22 -22
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointSaml (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointSaml (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointSaml">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -134,7 +134,7 @@ loadScripts(document, 'script');</script>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAssertionConsumerServiceUrl()" class="member-name-link">getAssertionConsumerServiceUrl</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The public URL of the SP's Assertion Consumer Service.</div>
<div class="block">The public URL of the SP&#39;s Assertion Consumer Service.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAuthorizedGroups()" class="member-name-link">getAuthorizedGroups</a>()</code></div>
@@ -157,7 +157,7 @@ loadScripts(document, 'script');</script>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEntityId()" class="member-name-link">getEntityId</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The SP Entity's unique ID.</div>
<div class="block">The SP Entity&#39;s unique ID.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getForceAuthn()" class="member-name-link">getForceAuthn</a>()</code></div>
@@ -186,7 +186,7 @@ loadScripts(document, 'script');</script>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMetadataUrl()" class="member-name-link">getMetadataUrl</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">A public URL where the SP's metadata is hosted.</div>
<div class="block">A public URL where the SP&#39;s metadata is hosted.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNameidFormat()" class="member-name-link">getNameidFormat</a>()</code></div>
@@ -208,7 +208,7 @@ loadScripts(document, 'script');</script>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSingleLogoutUrl()" class="member-name-link">getSingleLogoutUrl</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The public URL of the SP's Single Logout Service.</div>
<div class="block">The public URL of the SP&#39;s Single Logout Service.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div>
@@ -256,18 +256,18 @@ loadScripts(document, 'script');</script>
<dt>Parameters:</dt>
<dd><code>enabled</code> - <code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</dd>
<dd><code>optionsPassthrough</code> - Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.</dd>
<dd><code>cookiePrefix</code> - the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'</dd>
<dd><code>cookiePrefix</code> - the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is &#39;ngrok.&#39;</dd>
<dd><code>inactivityTimeout</code> - Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.</dd>
<dd><code>maximumDuration</code> - Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.</dd>
<dd><code>idpMetadata</code> - The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.</dd>
<dd><code>forceAuthn</code> - If true, indicates that whenever we redirect a user to the IdP for authentication that the IdP must prompt the user for authentication credentials even if the user already has a valid session with the IdP.</dd>
<dd><code>allowIdpInitiated</code> - If true, the IdP may initiate a login directly (e.g. the user does not need to visit the endpoint first and then be redirected). The IdP should set the <code>RelayState</code> parameter to the target URL of the resource they want the user to be redirected to after the SAML login assertion has been processed.</dd>
<dd><code>authorizedGroups</code> - If present, only users who are a member of one of the listed groups may access the target endpoint.</dd>
<dd><code>entityId</code> - The SP Entity's unique ID. This always takes the form of a URL. In ngrok's implementation, this URL is the same as the metadata URL. This will need to be specified to the IdP as configuration.</dd>
<dd><code>assertionConsumerServiceUrl</code> - The public URL of the SP's Assertion Consumer Service. This is where the IdP will redirect to during an authentication flow. This will need to be specified to the IdP as configuration.</dd>
<dd><code>singleLogoutUrl</code> - The public URL of the SP's Single Logout Service. This is where the IdP will redirect to during a single logout flow. This will optionally need to be specified to the IdP as configuration.</dd>
<dd><code>requestSigningCertificatePem</code> - PEM-encoded x.509 certificate of the key pair that is used to sign all SAML requests that the ngrok SP makes to the IdP. Many IdPs do not support request signing verification, but we highly recommend specifying this in the IdP's configuration if it is supported.</dd>
<dd><code>metadataUrl</code> - A public URL where the SP's metadata is hosted. If an IdP supports dynamic configuration, this is the URL it can use to retrieve the SP metadata.</dd>
<dd><code>entityId</code> - The SP Entity&#39;s unique ID. This always takes the form of a URL. In ngrok&#39;s implementation, this URL is the same as the metadata URL. This will need to be specified to the IdP as configuration.</dd>
<dd><code>assertionConsumerServiceUrl</code> - The public URL of the SP&#39;s Assertion Consumer Service. This is where the IdP will redirect to during an authentication flow. This will need to be specified to the IdP as configuration.</dd>
<dd><code>singleLogoutUrl</code> - The public URL of the SP&#39;s Single Logout Service. This is where the IdP will redirect to during a single logout flow. This will optionally need to be specified to the IdP as configuration.</dd>
<dd><code>requestSigningCertificatePem</code> - PEM-encoded x.509 certificate of the key pair that is used to sign all SAML requests that the ngrok SP makes to the IdP. Many IdPs do not support request signing verification, but we highly recommend specifying this in the IdP&#39;s configuration if it is supported.</dd>
<dd><code>metadataUrl</code> - A public URL where the SP&#39;s metadata is hosted. If an IdP supports dynamic configuration, this is the URL it can use to retrieve the SP metadata.</dd>
<dd><code>nameidFormat</code> - Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of <code>urn:oasis:names:tc:SAML:2.0:nameid-format:persistent</code> will be used. A subset of the allowed values enumerated by the SAML specification are supported.</dd>
</dl>
</section>
@@ -309,7 +309,7 @@ loadScripts(document, 'script');</script>
<h3>getCookiePrefix</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getCookiePrefix</span>()</div>
<div class="block">the prefix of the session cookie that ngrok sets on the http client to cache
authentication. default is 'ngrok.'</div>
authentication. default is &#39;ngrok.&#39;</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
@@ -388,7 +388,7 @@ loadScripts(document, 'script');</script>
the target endpoint.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
@@ -396,9 +396,9 @@ loadScripts(document, 'script');</script>
<section class="detail" id="getEntityId()">
<h3>getEntityId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getEntityId</span>()</div>
<div class="block">The SP Entity's unique ID. This always takes the form of a URL. In ngrok's
implementation, this URL is the same as the metadata URL. This will need to be
specified to the IdP as configuration.</div>
<div class="block">The SP Entity&#39;s unique ID. This always takes the form of a URL. In
ngrok&#39;s implementation, this URL is the same as the metadata URL. This will
need to be specified to the IdP as configuration.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
@@ -409,7 +409,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="getAssertionConsumerServiceUrl()">
<h3>getAssertionConsumerServiceUrl</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></span>&nbsp;<span class="element-name">getAssertionConsumerServiceUrl</span>()</div>
<div class="block">The public URL of the SP's Assertion Consumer Service. This is where the IdP
<div class="block">The public URL of the SP&#39;s Assertion Consumer Service. This is where the IdP
will redirect to during an authentication flow. This will need to be specified
to the IdP as configuration.</div>
<dl class="notes">
@@ -422,7 +422,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="getSingleLogoutUrl()">
<h3>getSingleLogoutUrl</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></span>&nbsp;<span class="element-name">getSingleLogoutUrl</span>()</div>
<div class="block">The public URL of the SP's Single Logout Service. This is where the IdP will
<div class="block">The public URL of the SP&#39;s Single Logout Service. This is where the IdP will
redirect to during a single logout flow. This will optionally need to be
specified to the IdP as configuration.</div>
<dl class="notes">
@@ -437,7 +437,7 @@ loadScripts(document, 'script');</script>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getRequestSigningCertificatePem</span>()</div>
<div class="block">PEM-encoded x.509 certificate of the key pair that is used to sign all SAML
requests that the ngrok SP makes to the IdP. Many IdPs do not support request
signing verification, but we highly recommend specifying this in the IdP's
signing verification, but we highly recommend specifying this in the IdP&#39;s
configuration if it is supported.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -449,7 +449,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="getMetadataUrl()">
<h3>getMetadataUrl</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></span>&nbsp;<span class="element-name">getMetadataUrl</span>()</div>
<div class="block">A public URL where the SP's metadata is hosted. If an IdP supports dynamic
<div class="block">A public URL where the SP&#39;s metadata is hosted. If an IdP supports dynamic
configuration, this is the URL it can use to retrieve the SP metadata.</div>
<dl class="notes">
<dt>Returns:</dt>
docs/com/ngrok/definitions/EndpointSamlMutate.Builder.html
+7 -7
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointSamlMutate.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointSamlMutate.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointSamlMutate, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -297,7 +297,7 @@ loadScripts(document, 'script');</script>
<h3>cookiePrefix</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointSamlMutate.Builder.html" title="class in com.ngrok.definitions">EndpointSamlMutate.Builder</a></span>&nbsp;<span class="element-name">cookiePrefix</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;cookiePrefix)</span></div>
<div class="block">the prefix of the session cookie that ngrok sets on the http client to cache
authentication. default is 'ngrok.'</div>
authentication. default is &#39;ngrok.&#39;</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>cookiePrefix</code> - the value of the <code>cookie_prefix</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
@@ -311,7 +311,7 @@ loadScripts(document, 'script');</script>
<h3>cookiePrefix</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="EndpointSamlMutate.Builder.html" title="class in com.ngrok.definitions">EndpointSamlMutate.Builder</a></span>&nbsp;<span class="element-name">cookiePrefix</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;cookiePrefix)</span></div>
<div class="block">the prefix of the session cookie that ngrok sets on the http client to cache
authentication. default is 'ngrok.'</div>
authentication. default is &#39;ngrok.&#39;</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>cookiePrefix</code> - the value of the <code>cookie_prefix</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
@@ -476,7 +476,7 @@ loadScripts(document, 'script');</script>
the target endpoint.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>authorizedGroups</code> - the value of the <code>authorized_groups</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd><code>authorizedGroups</code> - the value of the <code>authorized_groups</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
@@ -490,7 +490,7 @@ loadScripts(document, 'script');</script>
the target endpoint.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>authorizedGroups</code> - the value of the <code>authorized_groups</code> parameter as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dd><code>authorizedGroups</code> - the value of the <code>authorized_groups</code> parameter as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, wrapped in an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a></dd>
<dt>Returns:</dt>
<dd>this builder instance</dd>
</dl>
docs/com/ngrok/definitions/EndpointSamlMutate.html
+5 -5
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointSamlMutate (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointSamlMutate (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointSamlMutate">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -240,7 +240,7 @@ loadScripts(document, 'script');</script>
<h3>getCookiePrefix</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getCookiePrefix</span>()</div>
<div class="block">the prefix of the session cookie that ngrok sets on the http client to cache
authentication. default is 'ngrok.'</div>
authentication. default is &#39;ngrok.&#39;</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
@@ -319,7 +319,7 @@ loadScripts(document, 'script');</script>
the target endpoint.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/EndpointTlsTermination.Builder.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointTlsTermination.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointTlsTermination.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointTlsTermination, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EndpointTlsTermination.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointTlsTermination (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointTlsTermination (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointTlsTermination">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EndpointTlsTerminationAtEdge.Builder.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointTlsTerminationAtEdge.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointTlsTerminationAtEdge.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointTlsTerminationAtEdge, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EndpointTlsTerminationAtEdge.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointTlsTerminationAtEdge (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointTlsTerminationAtEdge (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointTlsTerminationAtEdge">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EndpointWebhookValidation.Builder.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointWebhookValidation.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointWebhookValidation.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointWebhookValidation, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EndpointWebhookValidation.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointWebhookValidation (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointWebhookValidation (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointWebhookValidation">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EndpointWebsocketTcpConverter.Builder.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointWebsocketTcpConverter.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointWebsocketTcpConverter.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointWebsocketTcpConverter, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EndpointWebsocketTcpConverter.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EndpointWebsocketTcpConverter (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EndpointWebsocketTcpConverter (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EndpointWebsocketTcpConverter">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EventDestination.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EventDestination (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EventDestination (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EventDestination">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EventDestinationList.html
+4 -4
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EventDestinationList (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EventDestinationList (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EventDestinationList">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -187,7 +187,7 @@ implements <a href="Pageable.html" title="interface in com.ngrok.definitions">Pa
<div class="block">The list of all Event Destinations on this account.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="EventDestination.html" title="class in com.ngrok.definitions">EventDestination</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="EventDestination.html" title="class in com.ngrok.definitions"><code>EventDestination</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/EventSource.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EventSource (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EventSource (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EventSource">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EventSourceList.html
+4 -4
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EventSourceList (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EventSourceList (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EventSourceList">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -174,7 +174,7 @@ loadScripts(document, 'script');</script>
<div class="block">The list of all Event Sources for an Event Subscription</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="EventSource.html" title="class in com.ngrok.definitions">EventSource</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="EventSource.html" title="class in com.ngrok.definitions"><code>EventSource</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/EventSourceReplace.Builder.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EventSourceReplace.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EventSourceReplace.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EventSourceReplace, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EventSourceReplace.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EventSourceReplace (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EventSourceReplace (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EventSourceReplace">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EventSubscription.html
+5 -5
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EventSubscription (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EventSubscription (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EventSubscription">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -271,7 +271,7 @@ loadScripts(document, 'script');</script>
<div class="block">Sources containing the types for which this event subscription will trigger</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="EventSource.html" title="class in com.ngrok.definitions">EventSource</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="EventSource.html" title="class in com.ngrok.definitions"><code>EventSource</code></a></dd>
</dl>
</section>
</li>
@@ -282,7 +282,7 @@ loadScripts(document, 'script');</script>
<div class="block">Destinations to which these events will be sent</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="Ref.html" title="class in com.ngrok.definitions">Ref</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="Ref.html" title="class in com.ngrok.definitions"><code>Ref</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/EventSubscriptionList.html
+4 -4
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EventSubscriptionList (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EventSubscriptionList (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EventSubscriptionList">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -187,7 +187,7 @@ implements <a href="Pageable.html" title="interface in com.ngrok.definitions">Pa
<div class="block">The list of all Event Subscriptions on this account.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="EventSubscription.html" title="class in com.ngrok.definitions">EventSubscription</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="EventSubscription.html" title="class in com.ngrok.definitions"><code>EventSubscription</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/EventTarget.Builder.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EventTarget.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EventTarget.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EventTarget, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EventTarget.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EventTarget (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EventTarget (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EventTarget">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EventTargetCloudwatchLogs.Builder.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EventTargetCloudwatchLogs.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EventTargetCloudwatchLogs.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EventTargetCloudwatchLogs, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EventTargetCloudwatchLogs.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EventTargetCloudwatchLogs (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EventTargetCloudwatchLogs (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EventTargetCloudwatchLogs">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EventTargetFirehose.Builder.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EventTargetFirehose.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EventTargetFirehose.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EventTargetFirehose, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EventTargetFirehose.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EventTargetFirehose (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EventTargetFirehose (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EventTargetFirehose">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EventTargetKinesis.Builder.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EventTargetKinesis.Builder (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EventTargetKinesis.Builder (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EventTargetKinesis, class: Builder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/EventTargetKinesis.html
+3 -3
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>EventTargetKinesis (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>EventTargetKinesis (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: EventTargetKinesis">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
docs/com/ngrok/definitions/FailoverBackend.html
+11 -11
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>FailoverBackend (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>FailoverBackend (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: FailoverBackend">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -91,8 +91,8 @@ loadScripts(document, 'script');</script>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.String,java.time.OffsetDateTime,java.lang.String,java.lang.String,java.util.List)" class="member-name-link">FailoverBackend</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;uri,
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.net.URI,java.time.OffsetDateTime,java.lang.String,java.lang.String,java.util.List)" class="member-name-link">FailoverBackend</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&nbsp;uri,
<a href="https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html" title="class or interface in java.time" class="external-link">OffsetDateTime</a>&nbsp;createdAt,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;description,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;metadata,
@@ -142,7 +142,7 @@ loadScripts(document, 'script');</script>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">arbitrary user-defined machine-readable data of this backend.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUri()" class="member-name-link">getUri</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">URI of the FailoverBackend API resource</div>
@@ -171,10 +171,10 @@ loadScripts(document, 'script');</script>
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(java.lang.String,java.lang.String,java.time.OffsetDateTime,java.lang.String,java.lang.String,java.util.List)">
<section class="detail" id="&lt;init&gt;(java.lang.String,java.net.URI,java.time.OffsetDateTime,java.lang.String,java.lang.String,java.util.List)">
<h3>FailoverBackend</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">FailoverBackend</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;uri,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&nbsp;uri,
<a href="https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html" title="class or interface in java.time" class="external-link">OffsetDateTime</a>&nbsp;createdAt,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;description,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;metadata,
@@ -213,11 +213,11 @@ loadScripts(document, 'script');</script>
<li>
<section class="detail" id="getUri()">
<h3>getUri</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getUri</span>()</div>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></span>&nbsp;<span class="element-name">getUri</span>()</div>
<div class="block">URI of the FailoverBackend API resource</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link"><code>URI</code></a></dd>
</dl>
</section>
</li>
@@ -261,7 +261,7 @@ loadScripts(document, 'script');</script>
<div class="block">the ids of the child backends in order</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/FailoverBackendList.html
+4 -4
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>FailoverBackendList (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>FailoverBackendList (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: FailoverBackendList">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -187,7 +187,7 @@ implements <a href="Pageable.html" title="interface in com.ngrok.definitions">Pa
<div class="block">the list of all Failover backends on this account</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="FailoverBackend.html" title="class in com.ngrok.definitions">FailoverBackend</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> of <a href="FailoverBackend.html" title="class in com.ngrok.definitions"><code>FailoverBackend</code></a></dd>
</dl>
</section>
</li>
docs/com/ngrok/definitions/HttpResponseBackend.html
+11 -11
View File
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Apr 11 19:37:27 GMT 2022 -->
<title>HttpResponseBackend (ngrok Java API client 0.4.0 API)</title>
<!-- Generated by javadoc (17) on Sun May 01 16:05:19 GMT 2022 -->
<title>HttpResponseBackend (ngrok Java API client 0.6.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-11">
<meta name="dc.created" content="2022-05-01">
<meta name="description" content="declaration: package: com.ngrok.definitions, class: HttpResponseBackend">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -91,8 +91,8 @@ loadScripts(document, 'script');</script>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.String,java.time.OffsetDateTime,java.lang.String,java.lang.String,java.lang.String,java.util.Map,java.lang.Integer)" class="member-name-link">HttpResponseBackend</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;uri,
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.net.URI,java.time.OffsetDateTime,java.lang.String,java.lang.String,java.lang.String,java.util.Map,java.lang.Integer)" class="member-name-link">HttpResponseBackend</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&nbsp;uri,
<a href="https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html" title="class or interface in java.time" class="external-link">OffsetDateTime</a>&nbsp;createdAt,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;description,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;metadata,
@@ -154,7 +154,7 @@ loadScripts(document, 'script');</script>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">status code to return</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUri()" class="member-name-link">getUri</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">URI of the HTTPResponseBackend API resource</div>
@@ -183,10 +183,10 @@ loadScripts(document, 'script');</script>
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(java.lang.String,java.lang.String,java.time.OffsetDateTime,java.lang.String,java.lang.String,java.lang.String,java.util.Map,java.lang.Integer)">
<section class="detail" id="&lt;init&gt;(java.lang.String,java.net.URI,java.time.OffsetDateTime,java.lang.String,java.lang.String,java.lang.String,java.util.Map,java.lang.Integer)">
<h3>HttpResponseBackend</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">HttpResponseBackend</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;uri,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&nbsp;uri,
<a href="https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html" title="class or interface in java.time" class="external-link">OffsetDateTime</a>&nbsp;createdAt,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;description,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;metadata,
@@ -229,11 +229,11 @@ loadScripts(document, 'script');</script>
<li>
<section class="detail" id="getUri()">
<h3>getUri</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getUri</span>()</div>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></span>&nbsp;<span class="element-name">getUri</span>()</div>
<div class="block">URI of the HTTPResponseBackend API resource</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link"><code>URI</code></a></dd>
</dl>
</section>
</li>
@@ -288,7 +288,7 @@ loadScripts(document, 'script');</script>
<div class="block">headers to return</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the value of the property as a <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dd>the value of the property as a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>Map</code></a> of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></dd>
</dl>
</section>
</li>

Some files were not shown because too many files have changed in this diff Show More