diff --git a/docs/CNAME b/docs/CNAME
new file mode 100644
index 0000000..a6af7b0
--- /dev/null
+++ b/docs/CNAME
@@ -0,0 +1 @@
+java-api.docs.ngrok.com
diff --git a/docs/allclasses-index.html b/docs/allclasses-index.html
new file mode 100644
index 0000000..500a307
--- /dev/null
+++ b/docs/allclasses-index.html
@@ -0,0 +1,682 @@
+
+
+
+
+
+All Classes (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
All Classes Interface Summary Class Summary Enum Summary Exception Summary
+
+
+
+
+
+
+
+
+
+
+
Abuse Reports allow you to submit take-down requests for URLs hosted by
+ ngrok that violate ngrok's terms of service.
+
+
+
+
+
+
+
+
+
+
A class encapsulating the
ApiKey resource.
+
+
+
+
+
+
+
+
A class encapsulating the
AwsAuth resource.
+
+
+
+
+
+
+
+
+
+
A class encapsulating the
AwsRole resource.
+
+
+
+
+
+
Certificate Authorities are x509 certificates that are used to sign other
+ x509 certificates.
+
+
+
+
+
+
+
+
+
+
+
+
Tunnel Credentials are ngrok agent authtokens.
+
+
+
+
Default implementation of
NgrokApiClient based on the Armeria HTTP client.
+
+
+
+
Builder class for the default API client.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Endpoint Configurations are a reusable group of modules that encapsulate how
+ traffic to a domain or address is handled.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
IP Policies are reusable groups of CIDR ranges with an allow or
+ deny
+ action.
+
+
+
+
A class encapsulating the
IpPolicy resource.
+
+
+
+
+
+
+
+
+
+
IP Policy Rules are the IPv4 or IPv6 CIDRs entries that
+ make up an IP Policy.
+
+
+
+
+
+
+
+
An IP restriction is a restriction placed on the CIDRs that are allowed to
+ initate traffic to a specific aspect of your ngrok account.
+
+
+
+
Main entry point for the ngrok API.
+
+
+
+
+
+
+
+
Representation of an API error from ngrok.
+
+
+
+
Wrapper class that holds a single page of a
Pageable response.
+
+
+
+
Interface indicating a resource type that can have more than one page of responses.
+
+
+
+
A class encapsulating the
Ref resource.
+
+
+
+
+
+
+
+
Reserved Addresses are TCP addresses that can be used to listen for traffic.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Reserved Domains are hostnames that you can listen for traffic on.
+
+
+
+
An SSH Certificate Authority is a pair of an SSH Certificate and its private
+ key that can be used to sign other SSH host and user certificates.
+
+
+
+
+
+
+
+
+
+
+
+
SSH Credentials are SSH public keys that can be used to start SSH tunnels
+ via the ngrok SSH tunnel gateway.
+
+
+
+
+
+
+
+
SSH Host Certificates along with the corresponding private key allows an SSH
+ server to assert its authenticity to connecting SSH clients who trust the
+ SSH Certificate Authority that was used to sign the certificate.
+
+
+
+
+
+
+
+
SSH User Certificates are presented by SSH clients when connecting to an SSH
+ server to authenticate their connection.
+
+
+
+
+
+
+
+
TLS Certificates are pairs of x509 certificates and their matching private
+ key that can be used to terminate TLS traffic.
+
+
+
+
+
+
A class encapsulating the
Tunnel resource.
+
+
+
+
+
+
Tunnels provide endpoints to access services exposed by a running ngrok
+ agent tunnel session or an SSH reverse tunnel session.
+
+
+
+
+
+
+
+
Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
+ sessions that are running and connected to the ngrok service.
+
+
+
+
Client version information
+
+
+
+
+
+
+
All Packages (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+Package Summary
+
+
+
+
+
DefaultNgrokApiClient.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+DefaultNgrokApiClient
+public static class DefaultNgrokApiClient.Builder
+
extends Object Builder class for the default API client.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Sets the API base URI.
+
+
+
+
+
Sets the API base URI.
+
+
+
+
+
Builds the ngrok API client instance.
+
+
+
httpClient
+
+
Sets the HTTP client to use to make requests.
+
+
+
+
+
Sets the HTTP client to use to make requests.
+
+
+
objectMapper
+
+
Sets the Jackson object mapper to use to serialize request bodies and deserialize response bodies.
+
+
+
+
+
Sets the Jackson object mapper to use to serialize request bodies and deserialize response bodies.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+httpClient
+
+Sets the HTTP client to use to make requests.
+
+Parameters:
+httpClient - a HTTP clientReturns:
+the client builder
+
+
+
+
+
+httpClient
+
+Sets the HTTP client to use to make requests.
+
+Parameters:
+httpClient - an optional HTTP clientReturns:
+the client builder
+
+
+
+
+
+
+
+
+
+
+
+objectMapper
+
+Sets the Jackson object mapper to use to serialize request bodies and deserialize response bodies.
+
+ Be sure to pass something that can handle
Optional and
OffsetDateTime.
+Parameters:
+objectMapper - an object mapperReturns:
+the client builder
+See Also:
+Jdk8Module,
+JavaTimeModule
+
+
+
+
+objectMapper
+
+Sets the Jackson object mapper to use to serialize request bodies and deserialize response bodies.
+
+ Be sure to pass something that can handle
Optional and
OffsetDateTime.
+Parameters:
+objectMapper - an object mapperReturns:
+the client builder
+See Also:
+Jdk8Module,
+JavaTimeModule
+
+
+
+
+build
+
+Builds the ngrok API client instance.
+
+Returns:
+an api client
+
+
+
+
+
+
+
+
+
+
+
+
+
DefaultNgrokApiClient (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
Builder class for the default API client.
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Creates a new ngrok API client builder.
+
+
static com.linecorp.armeria.client.WebClient
+
+
+
Creates a new default Armeria WebClient.
+
+
+
+
+
Sends a request to the ngrok API.
+
+
+
+
+
Sends a GET request directly to the specified URI.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+newBuilder
+
+Creates a new ngrok API client builder.
+
+Parameters:
+apiKey - API key used to access the ngrok APIReturns:
+a client builder
+
+
+
+
+
+newDefaultHttpClient
+public static com.linecorp.armeria.client.WebClient newDefaultHttpClient ()
+Creates a new default Armeria WebClient.
+
+Returns:
+a http client
+
+
+
+
+
+sendRequest
+
+Sends a GET request directly to the specified URI.
+
+Specified by:
+sendRequest NgrokApiClient Type Parameters:
+O - the return type for the API responseParameters:
+uri - a URI to send the request toresponseClass - the type of a Jackson-annotated POJO representing the HTTP response bodyReturns:
+a future encapsulating the response type
+
+
+
+
+
+sendRequest
+
+Sends a request to the ngrok API.
+
+Specified by:
+sendRequest NgrokApiClient Type Parameters:
+O - the return type for the API responseParameters:
+method - the HTTP method to useendpoint - the endpoint (under the base URI) to send the request toqueryParams - any query parameters to send along with the request (parameters with an empty
+ value will not be sent)bodyParamsStream - any JSON body parameters to send along withthe request (parameters with an empty
+ value will not be sent). If this stream is empty, no body should be sent.responseClass - an optional type for a Jackson-annotated POJO representing the HTTP response bodyReturns:
+a future encapsulating the response type (will be Void
+
+
+
+
+
+
+
+
+
+
+
+
+
Ngrok.PointcfgModuleNamespace (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+Ngrok
+public class Ngrok.PointcfgModuleNamespace
+
extends Object A namespace object for PointcfgModule.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+logging
+
+
+
+Returns:
+a service client
+
+
+
+
+
+circuitBreaker
+
+
+
+Returns:
+a service client
+
+
+
+
+
+compression
+
+
+
+Returns:
+a service client
+
+
+
+
+
+tlsTermination
+
+
+
+Returns:
+a service client
+
+
+
+
+
+ipPolicy
+
+
+
+Returns:
+a service client
+
+
+
+
+
+mutualTls
+
+
+
+Returns:
+a service client
+
+
+
+
+
+
+
+
+
+
+
+oauth
+
+
+
+Returns:
+a service client
+
+
+
+
+
+webhookValidation
+
+
+
+Returns:
+a service client
+
+
+
+
+
+saml
+
+
+
+Returns:
+a service client
+
+
+
+
+
+oidc
+
+
+
+Returns:
+a service client
+
+
+
+
+
+
+
+
+
+
+
+
+
Ngrok (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class Ngrok
+
extends Object Main entry point for the ngrok API.
+
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A namespace object for PointcfgModule.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Create a new ngrok API instance.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Abuse Reports allow you to submit take-down requests for URLs hosted by
+ ngrok that violate ngrok's terms of service.
+
+
+
+
+
Creates a service client for AgentIngresses.
+
+
+
+
+
+
+
+
Certificate Authorities are x509 certificates that are used to sign other
+ x509 certificates.
+
+
+
+
+
Creates a new ngrok API instance using the default API client.
+
+
+
+
+
Creates a new ngrok API instance using the default API client.
+
+
+
+
+
Tunnel Credentials are ngrok agent authtokens.
+
+
+
+
+
Endpoint Configurations are a reusable group of modules that encapsulate how
+ traffic to a domain or address is handled.
+
+
+
+
+
Creates a service client for EventDestinations.
+
+
+
+
+
Creates a service client for EventSources.
+
+
+
+
+
Creates a service client for EventStreams.
+
+
+
+
+
Creates a service client for EventSubscriptions.
+
+
+
+
+
IP Policies are reusable groups of CIDR ranges with an allow or
+ deny
+ action.
+
+
+
+
+
IP Policy Rules are the IPv4 or IPv6 CIDRs entries that
+ make up an IP Policy.
+
+
+
+
+
An IP restriction is a restriction placed on the CIDRs that are allowed to
+ initate traffic to a specific aspect of your ngrok account.
+
+
+
+
+
Creates a namespace object for PointcfgModule.
+
+
+
+
+
Reserved Addresses are TCP addresses that can be used to listen for traffic.
+
+
+
+
+
Reserved Domains are hostnames that you can listen for traffic on.
+
+
+
+
+
An SSH Certificate Authority is a pair of an SSH Certificate and its private
+ key that can be used to sign other SSH host and user certificates.
+
+
+
+
+
SSH Credentials are SSH public keys that can be used to start SSH tunnels
+ via the ngrok SSH tunnel gateway.
+
+
+
+
+
SSH Host Certificates along with the corresponding private key allows an SSH
+ server to assert its authenticity to connecting SSH clients who trust the
+ SSH Certificate Authority that was used to sign the certificate.
+
+
+
+
+
SSH User Certificates are presented by SSH clients when connecting to an SSH
+ server to authenticate their connection.
+
+
+
+
+
TLS Certificates are pairs of x509 certificates and their matching private
+ key that can be used to terminate TLS traffic.
+
+
+
+
+
Tunnels provide endpoints to access services exposed by a running ngrok
+ agent tunnel session or an SSH reverse tunnel session.
+
+
+
+
+
Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
+ sessions that are running and connected to the ngrok service.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+createDefault
+
+Creates a new ngrok API instance using the default API client.
+
+Parameters:
+apiKey - API key used to access the ngrok APIReturns:
+an ngrok API instance
+
+
+
+
+
+createDefault
+public static Ngrok createDefault ()
Creates a new ngrok API instance using the default API client.
+
+ The API key is pulled from the environment variable NGROK_API_KEY.
+
+Returns:
+an ngrok API instance
+
+
+
+
+
+abuseReports
+
+
+
+Returns:
+a service client
+
+
+
+
+
+agentIngresses
+
+
+
+Returns:
+a service client
+
+
+
+
+
+apiKeys
+
+
+
+Returns:
+a service client
+
+
+
+
+
+certificateAuthorities
+
+Certificate Authorities are x509 certificates that are used to sign other
+ x509 certificates. Attach a Certificate Authority to the Mutual TLS module
+ to verify that the TLS certificate presented by a client has been signed by
+ this CA. Certificate Authorities are used only for mTLS validation only and
+ thus a private key is not included in the resource.
+
+ See also
https://ngrok.com/docs/api#api-certificate-authorities .
+Returns:
+a service client
+
+
+
+
+
+credentials
+
+Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
+ agent to connect the ngrok service as your account. They are installed with
+ the
ngrok authtoken command or by specifying it in the
+
ngrok.yml
+ configuration file with the
authtoken property.
+
+ See also
https://ngrok.com/docs/api#api-credentials .
+Returns:
+a service client
+
+
+
+
+
+endpointConfigurations
+
+Endpoint Configurations are a reusable group of modules that encapsulate how
+ traffic to a domain or address is handled. Endpoint configurations are only
+ applied to Domains and TCP Addresses they have been attached to.
+
+ See also
https://ngrok.com/docs/api#api-endpoint-configurations .
+Returns:
+a service client
+
+
+
+
+
+eventStreams
+
+
+
+Returns:
+a service client
+
+
+
+
+
+eventDestinations
+
+
+
+Returns:
+a service client
+
+
+
+
+
+eventSubscriptions
+
+
+
+Returns:
+a service client
+
+
+
+
+
+eventSources
+
+
+
+Returns:
+a service client
+
+
+
+
+
+ipPolicies
+
+IP Policies are reusable groups of CIDR ranges with an
allow or
+
deny
+ action. They can be attached to endpoints via the Endpoint Configuration IP
+ Policy module. They can also be used with IP Restrictions to control source
+ IP ranges that can start tunnel sessions and connect to the API and dashboard.
+
+ See also
https://ngrok.com/docs/api#api-ip-policies .
+Returns:
+a service client
+
+
+
+
+
+ipPolicyRules
+
+
+
+Returns:
+a service client
+
+
+
+
+
+ipRestrictions
+
+An IP restriction is a restriction placed on the CIDRs that are allowed to
+ initate traffic to a specific aspect of your ngrok account. An IP
+ restriction has a type which defines the ingress it applies to. IP
+ restrictions can be used to enforce the source IPs that can make API
+ requests, log in to the dashboard, start ngrok agents, and connect to your
+ public-facing endpoints.
+
+ See also
https://ngrok.com/docs/api#api-ip-restrictions .
+Returns:
+a service client
+
+
+
+
+
+reservedAddrs
+
+
+
+Returns:
+a service client
+
+
+
+
+
+reservedDomains
+
+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.
+
+ See also
https://ngrok.com/docs/api#api-reserved-domains .
+Returns:
+a service client
+
+
+
+
+
+sshCertificateAuthorities
+
+
+
+Returns:
+a service client
+
+
+
+
+
+sshCredentials
+
+
+
+Returns:
+a service client
+
+
+
+
+
+sshHostCertificates
+
+SSH Host Certificates along with the corresponding private key allows an SSH
+ server to assert its authenticity to connecting SSH clients who trust the
+ SSH Certificate Authority that was used to sign the certificate.
+
+ See also
https://ngrok.com/docs/api#api-ssh-host-certificates .
+Returns:
+a service client
+
+
+
+
+
+sshUserCertificates
+
+SSH User Certificates are presented by SSH clients when connecting to an SSH
+ server to authenticate their connection. The SSH server must trust the SSH
+ Certificate Authority used to sign the certificate.
+
+ See also
https://ngrok.com/docs/api#api-ssh-user-certificates .
+Returns:
+a service client
+
+
+
+
+
+tlsCertificates
+
+TLS Certificates are pairs of x509 certificates and their matching private
+ key that can be used to terminate TLS traffic. TLS certificates are unused
+ until they are attached to a Domain. TLS Certificates may also be
+ provisioned by ngrok automatically for domains on which you have enabled
+ automated certificate provisioning.
+
+ See also
https://ngrok.com/docs/api#api-tls-certificates .
+Returns:
+a service client
+
+
+
+
+
+tunnelSessions
+
+Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
+ sessions that are running and connected to the ngrok service. Each tunnel
+ session can include one or more Tunnels.
+
+ See also
https://ngrok.com/docs/api#api-tunnel-sessions .
+Returns:
+a service client
+
+
+
+
+
+tunnels
+
+
+
+Returns:
+a service client
+
+
+
+
+
+pointcfgModule
+
+Creates a namespace object for PointcfgModule.
+
+Returns:
+a namespace object
+
+
+
+
+
+
+
+
+
+
+
+
+
NgrokApiClient.HttpMethod (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Nested Class Summary
+
+
+
+
+
+
+Enum Constant Summary
+Enum Constants
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Returns the enum constant of this type with the specified name.
+
+
+
+
+
Returns an array containing the constants of this enum type, in
+the order they are declared.
+
+
+
+
+
Methods inherited from class java.lang.Enum
+
clone , compareTo , describeConstable , equals , finalize , getDeclaringClass , hashCode , name , ordinal , toString , valueOf
+
+
+
+
+
+
+
+
+Enum Constant Details
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+values
+
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+
+Returns:
+an array containing the constants of this enum type, in the order they are declared
+
+
+
+
+
+valueOf
+
+Returns the enum constant of this type with the specified name.
+The string must match exactly an identifier used to declare an
+enum constant in this type. (Extraneous whitespace characters are
+not permitted.)
+
+Parameters:
+name - the name of the enum constant to be returned.Returns:
+the enum constant with the specified name
+Throws:
+IllegalArgumentException NullPointerException
+
+
+
+
+
+
+
+
+
+
+
+
NgrokApiClient (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+All Known Implementing Classes:
+DefaultNgrokApiClient
+public interface NgrokApiClient
+API client interface.
+
+ Concrete implementations can be written and passed to
Ngrok on construction
+ in order to make HTTP requests or test business logic.
+See Also:
+DefaultNgrokApiClient
+
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Field Summary
+Fields
+
+
+
+
+
+
+
+
The default base URI for the public ngrok API server
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Abstract Methods
+
+
+
+
+
+
+
+
+
Sends a request to the ngrok API.
+
+
+
+
+
Sends a GET request directly to the specified URI.
+
+
+
+
+
+
+
+
+
+
+
+
+Field Details
+
+
+
+DEFAULT_BASE_URI
+static final URI DEFAULT_BASE_URI The default base URI for the public ngrok API server
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+sendRequest
+
+Sends a GET request directly to the specified URI.
+
+Type Parameters:
+O - the return type for the API responseParameters:
+uri - a URI to send the request toresponseClass - the type of a Jackson-annotated POJO representing the HTTP response bodyReturns:
+a future encapsulating the response type
+
+
+
+
+
+sendRequest
+
+Sends a request to the ngrok API.
+
+Type Parameters:
+O - the return type for the API responseParameters:
+method - the HTTP method to useendpoint - the endpoint (under the base URI) to send the request toqueryParams - any query parameters to send along with the request (parameters with an empty
+ value will not be sent)bodyParams - any JSON body parameters to send along withthe request (parameters with an empty
+ value will not be sent). If this stream is empty, no body should be sent.responseClass - an optional type for a Jackson-annotated POJO representing the HTTP response bodyReturns:
+a future encapsulating the response type (will be Void
+
+
+
+
+
+
+
+
+
+
+
+
+
Version (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public abstract class Version
+
extends Object Client version information
+
+
+
+
+
+
+Field Summary
+Fields
+
+
+
+
+
+
+
+
The ngrok API version in use
+
+
+
+
+
This API client's version string
+
+
+
+
+
+
+Method Summary
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.DefaultNgrokApiClient.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
DefaultNgrokApiClient.Builder. baseUri URI baseUri)
+
+
Sets the API base URI.
+
+
+
+
+
Sets the API base URI.
+
+
+
DefaultNgrokApiClient.Builder. httpClient
+
+
Sets the HTTP client to use to make requests.
+
+
+
DefaultNgrokApiClient.Builder. httpClient Optional <com.linecorp.armeria.client.WebClient> httpClient)
+
+
Sets the HTTP client to use to make requests.
+
+
+
+
+
Creates a new ngrok API client builder.
+
+
+
DefaultNgrokApiClient.Builder. objectMapper
+
+
Sets the Jackson object mapper to use to serialize request bodies and deserialize response bodies.
+
+
+
DefaultNgrokApiClient.Builder. objectMapper Optional <com.fasterxml.jackson.databind.ObjectMapper> objectMapper)
+
+
Sets the Jackson object mapper to use to serialize request bodies and deserialize response bodies.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.DefaultNgrokApiClient (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
DefaultNgrokApiClient.Builder. build
+
+
Builds the ngrok API client instance.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.Ngrok.PointcfgModuleNamespace (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a namespace object for PointcfgModule.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.Ngrok (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a new ngrok API instance using the default API client.
+
+
+
+
+
Creates a new ngrok API instance using the default API client.
+
+
+
+
+
+
+
+
+
Uses of Enum com.ngrok.NgrokApiClient.HttpMethod (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns the enum constant of this type with the specified name.
+
+
+
NgrokApiClient.HttpMethod. values
+
+
Returns an array containing the constants of this enum type, in
+the order they are declared.
+
+
+
+
+
+
+
+
+
Sends a request to the ngrok API.
+
+
+
+
+
Sends a request to the ngrok API.
+
+
+
+
+
+
+
+
+
Uses of Interface com.ngrok.NgrokApiClient (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
class
+
+
+
Default implementation of
NgrokApiClient based on the Armeria HTTP client.
+
+
+
+
+
+
+
+
+
Create a new ngrok API instance.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a new sub-client for AbuseReports.
+
+
+
+
+
Creates a new sub-client for AgentIngresses.
+
+
+
+
+
Creates a new sub-client for ApiKeys.
+
+
+
+
+
Creates a new sub-client for CertificateAuthorities.
+
+
+
+
+
Creates a new sub-client for Credentials.
+
+
+
+
+
Creates a new sub-client for EndpointCircuitBreakerModule.
+
+
+
+
+
Creates a new sub-client for EndpointCompressionModule.
+
+
+
+
+
Creates a new sub-client for EndpointConfigurations.
+
+
+
+
+
Creates a new sub-client for EndpointIpPolicyModule.
+
+
+
+
+
Creates a new sub-client for EndpointLoggingModule.
+
+
+
+
+
Creates a new sub-client for EndpointMutualTlsModule.
+
+
+
+
+
Creates a new sub-client for EndpointOAuthModule.
+
+
+
+
+
Creates a new sub-client for EndpointOidcModule.
+
+
+
+
+
Creates a new sub-client for EndpointRequestHeadersModule.
+
+
+
+
+
Creates a new sub-client for EndpointResponseHeadersModule.
+
+
+
+
+
Creates a new sub-client for EndpointSamlModule.
+
+
+
+
+
Creates a new sub-client for EndpointTlsTerminationModule.
+
+
+
+
+
Creates a new sub-client for EndpointWebhookValidationModule.
+
+
+
+
+
Creates a new sub-client for EventDestinations.
+
+
+
+
+
Creates a new sub-client for EventSources.
+
+
+
+
+
Creates a new sub-client for EventStreams.
+
+
+
+
+
Creates a new sub-client for EventSubscriptions.
+
+
+
+
+
Creates a new sub-client for IpPolicies.
+
+
+
+
+
Creates a new sub-client for IpPolicyRules.
+
+
+
+
+
Creates a new sub-client for IpRestrictions.
+
+
+
+
+
Creates a new sub-client for ReservedAddrs.
+
+
+
+
+
Creates a new sub-client for ReservedDomains.
+
+
+
+
+
Creates a new sub-client for SshCertificateAuthorities.
+
+
+
+
+
Creates a new sub-client for SshCredentials.
+
+
+
+
+
Creates a new sub-client for SshHostCertificates.
+
+
+
+
+
Creates a new sub-client for SshUserCertificates.
+
+
+
+
+
Creates a new sub-client for TlsCertificates.
+
+
+
+
+
Creates a new sub-client for Tunnels.
+
+
+
+
+
Creates a new sub-client for TunnelSessions.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.Version (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+No usage of com.ngrok.Version
+
+
+
AbuseReport (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class AbuseReport
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
timestamp that the abuse report record was created in RFC 3339 format
+
+
+
+
+
an array of hostname statuses related to the report
+
+
+
+
+
ID of the abuse report
+
+
+
+
+
arbitrary user-defined data about this abuse report.
+
+
+
+
+
Indicates whether ngrok has processed the abuse report.
+
+
+
+
+
URI of the abuse report API resource
+
+
+
+
+
a list of URLs containing suspected abusive content
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+AbuseReport
+
+
+
+Parameters:
+id - ID of the abuse reporturi - URI of the abuse report API resourcecreatedAt - timestamp that the abuse report record was created in RFC 3339 formaturls - a list of URLs containing suspected abusive contentmetadata - arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.status - Indicates whether ngrok has processed the abuse report. one of PENDING, PROCESSED, or PARTIALLY_PROCESSEDhostnames - an array of hostname statuses related to the report
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+ID of the abuse report
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getUri
+
+URI of the abuse report API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getCreatedAt
+
+timestamp that the abuse report record was created in RFC 3339 format
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getUrls
+
+a list of URLs containing suspected abusive content
+
+Returns:
+the value of the property as a List <URI >
+
+
+
+
+
+
+
+
+getStatus
+
+Indicates whether ngrok has processed the abuse report. one of
+ PENDING, PROCESSED, or
+ PARTIALLY_PROCESSED
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getHostnames
+
+an array of hostname statuses related to the report
+
+Returns:
+the value of the property as a List <AbuseReportHostname >
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
AbuseReportHostname (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class AbuseReportHostname
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
the hostname ngrok has parsed out of one of the reported URLs in this abuse
+ report
+
+
+
+
+
indicates what action ngrok has taken against the hostname.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+AbuseReportHostname
+public AbuseReportHostname
(String hostname,
+ String status)
+Parameters:
+hostname - the hostname ngrok has parsed out of one of the reported URLs in this abuse reportstatus - indicates what action ngrok has taken against the hostname. one of PENDING, BANNED, UNBANNED, or IGNORE
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getHostname
+
+the hostname ngrok has parsed out of one of the reported URLs in this abuse
+ report
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getStatus
+
+indicates what action ngrok has taken against the hostname. one of
+ PENDING, BANNED, UNBANNED, or
+ IGNORE
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
AgentIngress (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class AgentIngress
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
timestamp when the Agent Ingress was created, RFC 3339 format
+
+
+
+
+
human-readable description of the use of this Agent Ingress.
+
+
+
+
+
the domain that you own to be used as the base domain name to generate regional
+ agent ingress domains.
+
+
+
+
+
unique Agent Ingress resource identifier
+
+
+
+
+
arbitrary user-defined machine-readable data of this Agent Ingress.
+
+
+
+
+
a list of target values to use as the values of NS records for the domain
+ property these values will delegate control over the domain to ngrok
+
+
+
+
+
a list of regional agent ingress domains that are subdomains of the value of
+ domain this value may increase over time as ngrok adds more regions
+
+
+
+
+
URI to the API resource of this Agent ingress
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+AgentIngress
+
+
+
+Parameters:
+id - unique Agent Ingress resource identifieruri - URI to the API resource of this Agent ingressdescription - human-readable description of the use of this Agent Ingress. optional, max 255 bytes.metadata - arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytesdomain - the domain that you own to be used as the base domain name to generate regional agent ingress domains.nsTargets - a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrokregionDomains - a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regionscreatedAt - timestamp when the Agent Ingress was created, RFC 3339 format
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+unique Agent Ingress resource identifier
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getUri
+
+URI to the API resource of this Agent ingress
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getDescription
+public String getDescription ()
human-readable description of the use of this Agent Ingress. optional, max 255
+ bytes.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+getDomain
+
+the domain that you own to be used as the base domain name to generate regional
+ agent ingress domains.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getNsTargets
+
+a list of target values to use as the values of NS records for the domain
+ property these values will delegate control over the domain to ngrok
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+getRegionDomains
+
+a list of regional agent ingress domains that are subdomains of the value of
+ domain this value may increase over time as ngrok adds more regions
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+getCreatedAt
+
+timestamp when the Agent Ingress was created, RFC 3339 format
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
AgentIngressList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Pageable
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
the list of Agent Ingresses owned by this account
+
+
+
+
+
URI of the next page, or null if there is no next page
+
+
+
+
+
URI of the Agent Ingress list API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+AgentIngressList
+
+
+
+Parameters:
+ingresses - the list of Agent Ingresses owned by this accounturi - URI of the Agent Ingress list API resourcenextPageUri - URI of the next page, or null if there is no next page
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getIngresses
+
+the list of Agent Ingresses owned by this account
+
+Returns:
+the value of the property as a List <AgentIngress >
+
+
+
+
+
+getUri
+
+URI of the Agent Ingress list API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getNextPageUri
+
+URI of the next page, or null if there is no next page
+
+Specified by:
+getNextPageUri Pageable Returns:
+the value of the property as a URIOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
ApiKey (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class ApiKey
+
extends Object A class encapsulating the
ApiKey resource.
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new instance of
ApiKey.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
timestamp when the api key was created, RFC 3339 format
+
+
+
+
+
human-readable description of what uses the API key to authenticate.
+
+
+
+
+
unique API key resource identifier
+
+
+
+
+
arbitrary user-defined data of this API key.
+
+
+
+
+
the bearer token that can be placed into the Authorization header to
+ authenticate request to the ngrok API.
+
+
+
+
+
URI to the API resource of this API key
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+ApiKey
+
+Creates a new instance of
ApiKey.
+Parameters:
+id - unique API key resource identifieruri - URI to the API resource of this API keydescription - human-readable description of what uses the API key to authenticate. optional, max 255 bytes.metadata - arbitrary user-defined data of this API key. optional, max 4096 bytescreatedAt - timestamp when the api key was created, RFC 3339 formattoken - the bearer token that can be placed into the Authorization header to authenticate request to the ngrok API. This value is only available one time, on the API response from key creation. Otherwise it is null.
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+unique API key resource identifier
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getUri
+
+URI to the API resource of this API key
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getDescription
+public String getDescription ()
human-readable description of what uses the API key to authenticate. optional,
+ max 255 bytes.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+getCreatedAt
+
+timestamp when the api key was created, RFC 3339 format
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getToken
+
+the bearer token that can be placed into the Authorization header to
+ authenticate request to the ngrok API. This value is only available one
+ time, on the API response from key creation. Otherwise it is null.
+
+Returns:
+the value of the property as a StringOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
ApiKeyList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Pageable
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
the list of API keys for this account
+
+
+
+
+
URI of the next page, or null if there is no next page
+
+
+
+
+
URI of the API keys list API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+ApiKeyList
+
+
+
+Parameters:
+keys - the list of API keys for this accounturi - URI of the API keys list API resourcenextPageUri - URI of the next page, or null if there is no next page
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getKeys
+
+the list of API keys for this account
+
+Returns:
+the value of the property as a List <ApiKey >
+
+
+
+
+
+getUri
+
+URI of the API keys list API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getNextPageUri
+
+URI of the next page, or null if there is no next page
+
+Specified by:
+getNextPageUri Pageable Returns:
+the value of the property as a URIOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
AwsAuth.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+AwsAuth
+public static class AwsAuth.Builder
+
extends Object
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
Credentials to your AWS account if you prefer ngrok to sign in with long-term
+ access keys.
+
+
+
+
+
Credentials to your AWS account if you prefer ngrok to sign in with long-term
+ access keys.
+
+
+
+
+
A role for ngrok to assume on your behalf to deposit events into your AWS
+ account.
+
+
+
+
+
A role for ngrok to assume on your behalf to deposit events into your AWS
+ account.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+role
+
+A role for ngrok to assume on your behalf to deposit events into your AWS
+ account.
+
+Parameters:
+role - the value of the role parameter as a AwsRoleReturns:
+this builder instance
+
+
+
+
+
+role
+
+A role for ngrok to assume on your behalf to deposit events into your AWS
+ account.
+
+Parameters:
+role - the value of the role parameter as a AwsRoleOptionalReturns:
+this builder instance
+
+
+
+
+
+creds
+
+Credentials to your AWS account if you prefer ngrok to sign in with long-term
+ access keys.
+
+Parameters:
+creds - the value of the creds parameter as a AwsCredentialsReturns:
+this builder instance
+
+
+
+
+
+creds
+
+Credentials to your AWS account if you prefer ngrok to sign in with long-term
+ access keys.
+
+Parameters:
+creds - the value of the creds parameter as a AwsCredentialsOptionalReturns:
+this builder instance
+
+
+
+
+
+build
+
+
+
+Returns:
+a new AwsAuth
+
+
+
+
+
+
+
+
+
+
+
+
+
AwsAuth (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class AwsAuth
+
extends Object A class encapsulating the
AwsAuth resource.
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
Credentials to your AWS account if you prefer ngrok to sign in with long-term
+ access keys.
+
+
+
+
+
A role for ngrok to assume on your behalf to deposit events into your AWS
+ account.
+
+
int
+
+
+
+
+
+
Creates a new builder for the
AwsAuth type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getRole
+
+A role for ngrok to assume on your behalf to deposit events into your AWS
+ account.
+
+Returns:
+the value of the property as a AwsRoleOptional
+
+
+
+
+
+getCreds
+
+Credentials to your AWS account if you prefer ngrok to sign in with long-term
+ access keys.
+
+Returns:
+the value of the property as a AwsCredentialsOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
AwsCredentials.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+AwsCredentials
+public static class AwsCredentials.Builder
+
extends Object
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+
AwsCredentials (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class AwsCredentials
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
The ID portion of an AWS access key.
+
+
+
+
+
The secret portion of an AWS access key.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+newBuilder
+
+
+
+Parameters:
+awsAccessKeyId - The ID portion of an AWS access key.awsSecretAccessKey - The secret portion of an AWS access key.Returns:
+a new AwsCredentials.Builder
+
+
+
+
+
+getAwsAccessKeyId
+public String getAwsAccessKeyId ()
The ID portion of an AWS access key.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getAwsSecretAccessKey
+
+The secret portion of an AWS access key.
+
+Returns:
+the value of the property as a StringOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
AwsRole.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+AwsRole
+public static class AwsRole.Builder
+
extends Object
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+build
+
+
+
+Returns:
+a new AwsRole
+
+
+
+
+
+
+
+
+
+
+
+
+
AwsRole (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class AwsRole
+
extends Object A class encapsulating the
AwsRole resource.
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
An ARN that specifies the role that ngrok should use to deliver to the
+ configured target.
+
+
int
+
+
+
+
+
+
Creates a new builder for the
AwsRole type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+newBuilder
+
+Creates a new builder for the
AwsRole type.
+Parameters:
+roleArn - An ARN that specifies the role that ngrok should use to deliver to the configured target.Returns:
+a new AwsRole.Builder
+
+
+
+
+
+getRoleArn
+
+An ARN that specifies the role that ngrok should use to deliver to the
+ configured target.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
CertificateAuthority (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class CertificateAuthority
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
CertificateAuthority String id,
+ URI uri,
+ OffsetDateTime createdAt,
+ String description,
+ String metadata,
+ String caPem,
+ String subjectCommonName,
+ OffsetDateTime notBefore,
+ OffsetDateTime notAfter,
+ List <String > keyUsages,
+ List <String > extendedKeyUsages)
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
raw PEM of the Certificate Authority
+
+
+
+
+
timestamp when the Certificate Authority was created, RFC 3339 format
+
+
+
+
+
human-readable description of this Certificate Authority.
+
+
+
+
+
extended set of actions the private key of this Certificate Authority can be
+ used for
+
+
+
+
+
unique identifier for this Certificate Authority
+
+
+
+
+
set of actions the private key of this Certificate Authority can be used for
+
+
+
+
+
arbitrary user-defined machine-readable data of this Certificate Authority.
+
+
+
+
+
timestamp when this Certificate Authority becomes invalid, RFC 3339 format
+
+
+
+
+
timestamp when this Certificate Authority becomes valid, RFC 3339 format
+
+
+
+
+
subject common name of the Certificate Authority
+
+
+
+
+
URI of the Certificate Authority API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+CertificateAuthority
+public CertificateAuthority
(String id,
+ URI uri,
+ OffsetDateTime createdAt,
+ String description,
+ String metadata,
+ String caPem,
+ String subjectCommonName,
+ OffsetDateTime notBefore,
+ OffsetDateTime notAfter,
+ List <String > keyUsages,
+ List <String > extendedKeyUsages)
+Parameters:
+id - unique identifier for this Certificate Authorityuri - URI of the Certificate Authority API resourcecreatedAt - timestamp when the Certificate Authority was created, RFC 3339 formatdescription - human-readable description of this Certificate Authority. optional, max 255 bytes.metadata - arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.caPem - raw PEM of the Certificate AuthoritysubjectCommonName - subject common name of the Certificate AuthoritynotBefore - timestamp when this Certificate Authority becomes valid, RFC 3339 formatnotAfter - timestamp when this Certificate Authority becomes invalid, RFC 3339 formatkeyUsages - set of actions the private key of this Certificate Authority can be used forextendedKeyUsages - extended set of actions the private key of this Certificate Authority can be used for
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+unique identifier for this Certificate Authority
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getUri
+
+URI of the Certificate Authority API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getCreatedAt
+
+timestamp when the Certificate Authority was created, RFC 3339 format
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getDescription
+public String getDescription ()
human-readable description of this Certificate Authority. optional, max 255
+ bytes.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+getCaPem
+
+raw PEM of the Certificate Authority
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getSubjectCommonName
+public String getSubjectCommonName ()
subject common name of the Certificate Authority
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getNotBefore
+
+timestamp when this Certificate Authority becomes valid, RFC 3339 format
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getNotAfter
+
+timestamp when this Certificate Authority becomes invalid, RFC 3339 format
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getKeyUsages
+
+set of actions the private key of this Certificate Authority can be used for
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+getExtendedKeyUsages
+
+extended set of actions the private key of this Certificate Authority can be
+ used for
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
CertificateAuthorityList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Pageable
+public class CertificateAuthorityList
+
extends Object
+implements Pageable
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
the list of all certificate authorities on this account
+
+
+
+
+
URI of the next page, or null if there is no next page
+
+
+
+
+
URI of the certificates authorities list API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+CertificateAuthorityList
+
+
+
+Parameters:
+certificateAuthorities - the list of all certificate authorities on this accounturi - URI of the certificates authorities list API resourcenextPageUri - URI of the next page, or null if there is no next page
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getCertificateAuthorities
+
+the list of all certificate authorities on this account
+
+Returns:
+the value of the property as a List <CertificateAuthority >
+
+
+
+
+
+getUri
+
+URI of the certificates authorities list API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getNextPageUri
+
+URI of the next page, or null if there is no next page
+
+Specified by:
+getNextPageUri Pageable Returns:
+the value of the property as a URIOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Credential (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class Credential
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
optional list of ACL rules.
+
+
+
+
+
timestamp when the tunnel credential was created, RFC 3339 format
+
+
+
+
+
human-readable description of who or what will use the credential to
+ authenticate.
+
+
+
+
+
unique tunnel credential resource identifier
+
+
+
+
+
arbitrary user-defined machine-readable data of this credential.
+
+
+
+
+
the credential's authtoken that can be used to authenticate an ngrok client.
+
+
+
+
+
URI of the tunnel credential API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+Credential
+
+
+
+Parameters:
+id - unique tunnel credential resource identifieruri - URI of the tunnel credential API resourcecreatedAt - timestamp when the tunnel credential was created, RFC 3339 formatdescription - human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.metadata - arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.token - the credential's authtoken that can be used to authenticate an ngrok client. This value is only available one time, on the API response from credential creation, otherwise it is null. acl - optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the bind rule. The bind 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 bind:example.ngrok.io. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of bind:*.example.com which will allow x.example.com, y.example.com, *.example.com, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+unique tunnel credential resource identifier
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getUri
+
+URI of the tunnel credential API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getCreatedAt
+
+timestamp when the tunnel credential was created, RFC 3339 format
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getDescription
+public String getDescription ()
human-readable description of who or what will use the credential to
+ authenticate. Optional, max 255 bytes.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+getToken
+
+the credential's authtoken that can be used to authenticate an ngrok client.
+ This value is only available one time, on the API response from
+ credential creation, otherwise it is null.
+
+Returns:
+the value of the property as a StringOptional
+
+
+
+
+
+getAcl
+
+optional list of ACL rules. If unspecified, the credential will have no
+ restrictions. The only allowed ACL rule at this time is the bind
+ rule. The bind 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
+ bind:example.ngrok.io. Bind rules may specify a leading wildcard to
+ match multiple domains with a common suffix. For example, you may specify a rule
+ of bind:*.example.com which will allow x.example.com,
+ y.example.com, *.example.com, etc. A rule of
+ '*' is equivalent to no acl at all and will explicitly permit all
+ actions.
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
CredentialList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Pageable
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
the list of all tunnel credentials on this account
+
+
+
+
+
URI of the next page, or null if there is no next page
+
+
+
+
+
URI of the tunnel credential list API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+CredentialList
+
+
+
+Parameters:
+credentials - the list of all tunnel credentials on this accounturi - URI of the tunnel credential list API resourcenextPageUri - URI of the next page, or null if there is no next page
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getCredentials
+
+the list of all tunnel credentials on this account
+
+Returns:
+the value of the property as a List <Credential >
+
+
+
+
+
+getUri
+
+URI of the tunnel credential list API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getNextPageUri
+
+URI of the next page, or null if there is no next page
+
+Specified by:
+getNextPageUri Pageable Returns:
+the value of the property as a URIOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointCircuitBreaker.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
Error threshold percentage should be between 0 - 1.0, not 0-100.0
+
+
+
+
+
Error threshold percentage should be between 0 - 1.0, not 0-100.0
+
+
+
+
+
Integer number of buckets into which metrics are retained.
+
+
+
+
+
Integer number of buckets into which metrics are retained.
+
+
+
+
+
Integer number of seconds in the statistical rolling window that metrics are
+ retained for.
+
+
+
+
+
Integer number of seconds in the statistical rolling window that metrics are
+ retained for.
+
+
+
+
+
Integer number of seconds after which the circuit is tripped to wait before
+ re-evaluating upstream health
+
+
+
+
+
Integer number of seconds after which the circuit is tripped to wait before
+ re-evaluating upstream health
+
+
+
+
+
Integer number of requests in a rolling window that will trip the circuit.
+
+
+
+
+
Integer number of requests in a rolling window that will trip the circuit.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a booleanReturns:
+this builder instance
+
+
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a boolean, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+trippedDuration
+
+Integer number of seconds after which the circuit is tripped to wait before
+ re-evaluating upstream health
+
+Parameters:
+trippedDuration - the value of the tripped_duration parameter as a DurationReturns:
+this builder instance
+
+
+
+
+
+trippedDuration
+
+Integer number of seconds after which the circuit is tripped to wait before
+ re-evaluating upstream health
+
+Parameters:
+trippedDuration - the value of the tripped_duration parameter as a DurationOptionalReturns:
+this builder instance
+
+
+
+
+
+rollingWindow
+
+Integer number of seconds in the statistical rolling window that metrics are
+ retained for.
+
+Parameters:
+rollingWindow - the value of the rolling_window parameter as a longReturns:
+this builder instance
+
+
+
+
+
+rollingWindow
+
+Integer number of seconds in the statistical rolling window that metrics are
+ retained for.
+
+Parameters:
+rollingWindow - the value of the rolling_window parameter as a long, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+numBuckets
+
+Integer number of buckets into which metrics are retained. Max 128.
+
+Parameters:
+numBuckets - the value of the num_buckets parameter as a longReturns:
+this builder instance
+
+
+
+
+
+numBuckets
+
+Integer number of buckets into which metrics are retained. Max 128.
+
+Parameters:
+numBuckets - the value of the num_buckets parameter as a long, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+volumeThreshold
+
+Integer number of requests in a rolling window that will trip the circuit.
+ Helpful if traffic volume is low.
+
+Parameters:
+volumeThreshold - the value of the volume_threshold parameter as a longReturns:
+this builder instance
+
+
+
+
+
+volumeThreshold
+
+Integer number of requests in a rolling window that will trip the circuit.
+ Helpful if traffic volume is low.
+
+Parameters:
+volumeThreshold - the value of the volume_threshold parameter as a long, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+errorThresholdPercentage
+
+Error threshold percentage should be between 0 - 1.0, not 0-100.0
+
+Parameters:
+errorThresholdPercentage - the value of the error_threshold_percentage parameter as a doubleReturns:
+this builder instance
+
+
+
+
+
+errorThresholdPercentage
+
+Error threshold percentage should be between 0 - 1.0, not 0-100.0
+
+Parameters:
+errorThresholdPercentage - the value of the error_threshold_percentage parameter as a double, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointCircuitBreaker (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointCircuitBreaker
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
double
+
+
+
Error threshold percentage should be between 0 - 1.0, not 0-100.0
+
+
long
+
+
+
Integer number of buckets into which metrics are retained.
+
+
long
+
+
+
Integer number of seconds in the statistical rolling window that metrics are
+ retained for.
+
+
+
+
+
Integer number of seconds after which the circuit is tripped to wait before
+ re-evaluating upstream health
+
+
long
+
+
+
Integer number of requests in a rolling window that will trip the circuit.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getEnabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Returns:
+the value of the property as a boolean wrapped in an Optional
+
+
+
+
+
+getTrippedDuration
+
+Integer number of seconds after which the circuit is tripped to wait before
+ re-evaluating upstream health
+
+Returns:
+the value of the property as a Duration
+
+
+
+
+
+getRollingWindow
+public long getRollingWindow ()
+Integer number of seconds in the statistical rolling window that metrics are
+ retained for.
+
+Returns:
+the value of the property as a long
+
+
+
+
+
+getNumBuckets
+public long getNumBuckets ()
+Integer number of buckets into which metrics are retained. Max 128.
+
+Returns:
+the value of the property as a long
+
+
+
+
+
+getVolumeThreshold
+public long getVolumeThreshold ()
+Integer number of requests in a rolling window that will trip the circuit.
+ Helpful if traffic volume is low.
+
+Returns:
+the value of the property as a long
+
+
+
+
+
+getErrorThresholdPercentage
+public double getErrorThresholdPercentage ()
+Error threshold percentage should be between 0 - 1.0, not 0-100.0
+
+Returns:
+the value of the property as a double
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointCompression.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a booleanReturns:
+this builder instance
+
+
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a boolean, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointCompression (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointCompression
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getEnabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Returns:
+the value of the property as a boolean wrapped in an Optional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointConfiguration (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointConfiguration
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
EndpointConfiguration String id,
+ String type,
+ String description,
+ String metadata,
+ OffsetDateTime createdAt,
+ URI uri,
+ Optional <EndpointCircuitBreaker > circuitBreaker,
+ Optional <EndpointCompression > compression,
+ Optional <EndpointRequestHeaders > requestHeaders,
+ Optional <EndpointResponseHeaders > responseHeaders,
+ Optional <EndpointIpPolicy > ipPolicy,
+ Optional <EndpointMutualTls > mutualTls,
+ Optional <EndpointTlsTermination > tlsTermination,
+ Optional <EndpointWebhookValidation > webhookValidation,
+ Optional <EndpointOAuth > oauth,
+ Optional <EndpointLogging > logging,
+ Optional <EndpointSaml > saml,
+ Optional <EndpointOidc > oidc)
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
circuit breaker module configuration or null
+
+
+
+
+
compression module configuration or null
+
+
+
+
+
timestamp when the endpoint configuration was created, RFC 3339 format
+
+
+
+
+
human-readable description of what this endpoint configuration will be do when
+ applied or what traffic it will be applied to.
+
+
+
+
+
unique identifier of this endpoint configuration
+
+
+
+
+
ip policy module configuration or null
+
+
+
+
+
logging module configuration or null
+
+
+
+
+
arbitrary user-defined machine-readable data of this endpoint configuration.
+
+
+
+
+
mutual TLS module configuration or null
+
+
+
+
+
oauth module configuration or null
+
+
+
+
+
oidc module configuration or null
+
+
+
+
+
request headers module configuration or null
+
+
+
+
+
response headers module configuration or null
+
+
+
+
+
saml module configuration or null
+
+
+
+
+
TLS termination module configuration or null
+
+
+
+
+
they type of traffic this endpoint configuration can be applied to.
+
+
+
+
+
URI of the endpoint configuration API resource
+
+
+
+
+
webhook validation module configuration or null
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EndpointConfiguration
+public EndpointConfiguration
(String id,
+ String type,
+ String description,
+ String metadata,
+ OffsetDateTime createdAt,
+ URI uri,
+ Optional <EndpointCircuitBreaker > circuitBreaker,
+ Optional <EndpointCompression > compression,
+ Optional <EndpointRequestHeaders > requestHeaders,
+ Optional <EndpointResponseHeaders > responseHeaders,
+ Optional <EndpointIpPolicy > ipPolicy,
+ Optional <EndpointMutualTls > mutualTls,
+ Optional <EndpointTlsTermination > tlsTermination,
+ Optional <EndpointWebhookValidation > webhookValidation,
+ Optional <EndpointOAuth > oauth,
+ Optional <EndpointLogging > logging,
+ Optional <EndpointSaml > saml,
+ Optional <EndpointOidc > oidc)
+Parameters:
+id - unique identifier of this endpoint configurationtype - they type of traffic this endpoint configuration can be applied to. one of: http, https, tcpdescription - human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytesmetadata - arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.createdAt - timestamp when the endpoint configuration was created, RFC 3339 formaturi - URI of the endpoint configuration API resourcecircuitBreaker - circuit breaker module configuration or nullcompression - compression module configuration or nullrequestHeaders - request headers module configuration or nullresponseHeaders - response headers module configuration or nullipPolicy - ip policy module configuration or nullmutualTls - mutual TLS module configuration or nulltlsTermination - TLS termination module configuration or nullwebhookValidation - webhook validation module configuration or nulloauth - oauth module configuration or nulllogging - logging module configuration or nullsaml - saml module configuration or nulloidc - oidc module configuration or null
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+unique identifier of this endpoint configuration
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getType
+
+they type of traffic this endpoint configuration can be applied to. one of:
+ http, https, tcp
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getDescription
+public String getDescription ()
human-readable description of what this endpoint configuration will be do when
+ applied or what traffic it will be applied to. Optional, max 255 bytes
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+getCreatedAt
+
+timestamp when the endpoint configuration was created, RFC 3339 format
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getUri
+
+URI of the endpoint configuration API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getCircuitBreaker
+
+circuit breaker module configuration or null
+
+Returns:
+the value of the property as a EndpointCircuitBreakerOptional
+
+
+
+
+
+getCompression
+
+compression module configuration or null
+
+Returns:
+the value of the property as a EndpointCompressionOptional
+
+
+
+
+
+
+
+
+
+
+
+getIpPolicy
+
+ip policy module configuration or null
+
+Returns:
+the value of the property as a EndpointIpPolicyOptional
+
+
+
+
+
+getMutualTls
+
+mutual TLS module configuration or null
+
+Returns:
+the value of the property as a EndpointMutualTlsOptional
+
+
+
+
+
+getTlsTermination
+
+TLS termination module configuration or null
+
+Returns:
+the value of the property as a EndpointTlsTerminationOptional
+
+
+
+
+
+getWebhookValidation
+
+webhook validation module configuration or null
+
+Returns:
+the value of the property as a EndpointWebhookValidationOptional
+
+
+
+
+
+getOauth
+
+oauth module configuration or null
+
+Returns:
+the value of the property as a EndpointOAuthOptional
+
+
+
+
+
+getLogging
+
+logging module configuration or null
+
+Returns:
+the value of the property as a EndpointLoggingOptional
+
+
+
+
+
+getSaml
+
+saml module configuration or null
+
+Returns:
+the value of the property as a EndpointSamlOptional
+
+
+
+
+
+getOidc
+
+oidc module configuration or null
+
+Returns:
+the value of the property as a EndpointOidcOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointConfigurationList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Pageable
+public class EndpointConfigurationList
+
extends Object
+implements Pageable
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
the list of all endpoint configurations on this account
+
+
+
+
+
URI of the next page, or null if there is no next page
+
+
+
+
+
URI of the endpoint configurations list API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EndpointConfigurationList
+
+
+
+Parameters:
+endpointConfigurations - the list of all endpoint configurations on this accounturi - URI of the endpoint configurations list API resourcenextPageUri - URI of the next page, or null if there is no next page
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getEndpointConfigurations
+
+the list of all endpoint configurations on this account
+
+Returns:
+the value of the property as a List <EndpointConfiguration >
+
+
+
+
+
+getUri
+
+URI of the endpoint configurations list API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getNextPageUri
+
+URI of the next page, or null if there is no next page
+
+Specified by:
+getNextPageUri Pageable Returns:
+the value of the property as a URIOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointIpPolicy (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointIpPolicy
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
Fetches the value of the ipPolicies property.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EndpointIpPolicy
+
+
+
+Parameters:
+enabled - true if the module will be applied to traffic, false to disable. default true if unspecifiedipPolicies - the value of the ip_policies parameter as a List <Ref >
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getEnabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Returns:
+the value of the property as a boolean wrapped in an Optional
+
+
+
+
+
+getIpPolicies
+
+Fetches the value of the ipPolicies property.
+
+Returns:
+the value of the property as a List <Ref >
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointIpPolicyMutate.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
list of all IP policies that will be used to check if a source IP is allowed
+ access to the endpoint
+
+
+
+
+
list of all IP policies that will be used to check if a source IP is allowed
+ access to the endpoint
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a booleanReturns:
+this builder instance
+
+
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a boolean, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+ipPolicyIds
+
+list of all IP policies that will be used to check if a source IP is allowed
+ access to the endpoint
+
+Parameters:
+ipPolicyIds - the value of the ip_policy_ids parameter as a List <String >Returns:
+this builder instance
+
+
+
+
+
+ipPolicyIds
+
+list of all IP policies that will be used to check if a source IP is allowed
+ access to the endpoint
+
+Parameters:
+ipPolicyIds - the value of the ip_policy_ids parameter as a List <String >OptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointIpPolicyMutate (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointIpPolicyMutate
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
list of all IP policies that will be used to check if a source IP is allowed
+ access to the endpoint
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getEnabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Returns:
+the value of the property as a boolean wrapped in an Optional
+
+
+
+
+
+getIpPolicyIds
+
+list of all IP policies that will be used to check if a source IP is allowed
+ access to the endpoint
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointLogging (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointLogging
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
list of all EventStreams that will be used to configure and export this
+ endpoint's logs
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EndpointLogging
+
+
+
+Parameters:
+enabled - true if the module will be applied to traffic, false to disable. default true if unspecifiedeventStreams - list of all EventStreams that will be used to configure and export this endpoint's logs
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getEnabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Returns:
+the value of the property as a boolean wrapped in an Optional
+
+
+
+
+
+getEventStreams
+
+list of all EventStreams that will be used to configure and export this
+ endpoint's logs
+
+Returns:
+the value of the property as a List <Ref >
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointLoggingMutate.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
list of all EventStreams that will be used to configure and export this
+ endpoint's logs
+
+
+
+
+
list of all EventStreams that will be used to configure and export this
+ endpoint's logs
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a booleanReturns:
+this builder instance
+
+
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a boolean, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+eventStreamIds
+
+list of all EventStreams that will be used to configure and export this
+ endpoint's logs
+
+Parameters:
+eventStreamIds - the value of the event_stream_ids parameter as a List <String >Returns:
+this builder instance
+
+
+
+
+
+eventStreamIds
+
+list of all EventStreams that will be used to configure and export this
+ endpoint's logs
+
+Parameters:
+eventStreamIds - the value of the event_stream_ids parameter as a List <String >OptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointLoggingMutate (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointLoggingMutate
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
list of all EventStreams that will be used to configure and export this
+ endpoint's logs
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getEnabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Returns:
+the value of the property as a boolean wrapped in an Optional
+
+
+
+
+
+getEventStreamIds
+
+list of all EventStreams that will be used to configure and export this
+ endpoint's logs
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointMutualTls (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointMutualTls
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
PEM-encoded CA certificates that will be used to validate.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EndpointMutualTls
+
+
+
+Parameters:
+enabled - true if the module will be applied to traffic, false to disable. default true if unspecifiedcertificateAuthorities - PEM-encoded CA certificates that will be used to validate. Multiple CAs may be provided by concatenating them together.
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getEnabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Returns:
+the value of the property as a boolean wrapped in an Optional
+
+
+
+
+
+getCertificateAuthorities
+public List <Ref >getCertificateAuthorities ()
PEM-encoded CA certificates that will be used to validate. Multiple CAs may be
+ provided by concatenating them together.
+
+Returns:
+the value of the property as a List <Ref >
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointMutualTlsMutate.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
list of certificate authorities that will be used to validate the TLS client
+ certificate presnted by the initiatiator of the TLS connection
+
+
+
+
+
list of certificate authorities that will be used to validate the TLS client
+ certificate presnted by the initiatiator of the TLS connection
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a booleanReturns:
+this builder instance
+
+
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a boolean, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+certificateAuthorityIds
+
+list of certificate authorities that will be used to validate the TLS client
+ certificate presnted by the initiatiator of the TLS connection
+
+Parameters:
+certificateAuthorityIds - the value of the certificate_authority_ids parameter as a List <String >Returns:
+this builder instance
+
+
+
+
+
+certificateAuthorityIds
+
+list of certificate authorities that will be used to validate the TLS client
+ certificate presnted by the initiatiator of the TLS connection
+
+Parameters:
+certificateAuthorityIds - the value of the certificate_authority_ids parameter as a List <String >OptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointMutualTlsMutate (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointMutualTlsMutate
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
list of certificate authorities that will be used to validate the TLS client
+ certificate presnted by the initiatiator of the TLS connection
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getEnabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Returns:
+the value of the property as a boolean wrapped in an Optional
+
+
+
+
+
+getCertificateAuthorityIds
+
+list of certificate authorities that will be used to validate the TLS client
+ certificate presnted by the initiatiator of the TLS connection
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuth.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointOAuth
+public static class EndpointOAuth.Builder
+
extends Object
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Integer number of seconds after which ngrok guarantees it will refresh user
+ state from the identity provider and recheck whether the user is still
+ authorized to access the endpoint.
+
+
+
+
+
Integer number of seconds after which ngrok guarantees it will refresh user
+ state from the identity provider and recheck whether the user is still
+ authorized to access the endpoint.
+
+
+
+
+
+
+
+
the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+
+
+
+
the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
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.
+
+
+
+
+
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.
+
+
+
+
+
Integer number of seconds of the maximum duration of an authenticated session.
+
+
+
+
+
Integer number of seconds of the maximum duration of an authenticated session.
+
+
+
+
+
Do not enforce authentication on HTTP OPTIONS requests.
+
+
+
+
+
Do not enforce authentication on HTTP OPTIONS requests.
+
+
+
+
+
an object which defines the identity provider to use for authentication and
+ configuration for who may access the endpoint
+
+
+
+
+
an object which defines the identity provider to use for authentication and
+ configuration for who may access the endpoint
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a booleanReturns:
+this builder instance
+
+
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a boolean, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+provider
+
+an object which defines the identity provider to use for authentication and
+ configuration for who may access the endpoint
+
+Parameters:
+provider - the value of the provider parameter as a EndpointOAuthProviderReturns:
+this builder instance
+
+
+
+
+
+provider
+
+an object which defines the identity provider to use for authentication and
+ configuration for who may access the endpoint
+
+Parameters:
+provider - the value of the provider parameter as a EndpointOAuthProviderOptionalReturns:
+this builder instance
+
+
+
+
+
+optionsPassthrough
+
+Do not enforce authentication on HTTP OPTIONS requests. necessary if you are
+ supporting CORS.
+
+Parameters:
+optionsPassthrough - the value of the options_passthrough parameter as a booleanReturns:
+this builder instance
+
+
+
+
+
+optionsPassthrough
+
+Do not enforce authentication on HTTP OPTIONS requests. necessary if you are
+ supporting CORS.
+
+Parameters:
+optionsPassthrough - the value of the options_passthrough parameter as a boolean, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+cookiePrefix
+
+the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication. default is 'ngrok.'
+
+Parameters:
+cookiePrefix - the value of the cookie_prefix parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+cookiePrefix
+
+the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication. default is 'ngrok.'
+
+Parameters:
+cookiePrefix - the value of the cookie_prefix parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+inactivityTimeout
+
+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.
+
+Parameters:
+inactivityTimeout - the value of the inactivity_timeout parameter as a longReturns:
+this builder instance
+
+
+
+
+
+inactivityTimeout
+
+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.
+
+Parameters:
+inactivityTimeout - the value of the inactivity_timeout parameter as a long, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+maximumDuration
+
+Integer number of seconds of the maximum duration of an authenticated session.
+ After this period is exceeded, a user must reauthenticate.
+
+Parameters:
+maximumDuration - the value of the maximum_duration parameter as a DurationReturns:
+this builder instance
+
+
+
+
+
+maximumDuration
+
+Integer number of seconds of the maximum duration of an authenticated session.
+ After this period is exceeded, a user must reauthenticate.
+
+Parameters:
+maximumDuration - the value of the maximum_duration parameter as a DurationOptionalReturns:
+this builder instance
+
+
+
+
+
+authCheckInterval
+
+Integer number of seconds after which ngrok guarantees it will refresh user
+ state from the identity provider and recheck whether the user is still
+ authorized to access the endpoint. This is the preferred tunable to use to
+ enforce a minimum amount of time after which a revoked user will no longer be
+ able to access the resource.
+
+Parameters:
+authCheckInterval - the value of the auth_check_interval parameter as a longReturns:
+this builder instance
+
+
+
+
+
+authCheckInterval
+
+Integer number of seconds after which ngrok guarantees it will refresh user
+ state from the identity provider and recheck whether the user is still
+ authorized to access the endpoint. This is the preferred tunable to use to
+ enforce a minimum amount of time after which a revoked user will no longer be
+ able to access the resource.
+
+Parameters:
+authCheckInterval - the value of the auth_check_interval parameter as a long, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuth (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointOAuth
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
long
+
+
+
Integer number of seconds after which ngrok guarantees it will refresh user
+ state from the identity provider and recheck whether the user is still
+ authorized to access the endpoint.
+
+
+
+
+
the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
long
+
+
+
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.
+
+
+
+
+
Integer number of seconds of the maximum duration of an authenticated session.
+
+
boolean
+
+
+
Do not enforce authentication on HTTP OPTIONS requests.
+
+
+
+
+
an object which defines the identity provider to use for authentication and
+ configuration for who may access the endpoint
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getEnabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Returns:
+the value of the property as a boolean wrapped in an Optional
+
+
+
+
+
+getProvider
+
+an object which defines the identity provider to use for authentication and
+ configuration for who may access the endpoint
+
+Returns:
+the value of the property as a EndpointOAuthProvider
+
+
+
+
+
+getOptionsPassthrough
+public boolean getOptionsPassthrough ()
+Do not enforce authentication on HTTP OPTIONS requests. necessary if you are
+ supporting CORS.
+
+Returns:
+the value of the property as a boolean
+
+
+
+
+
+getCookiePrefix
+public String getCookiePrefix ()
the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication. default is 'ngrok.'
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getInactivityTimeout
+public long getInactivityTimeout ()
+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.
+
+Returns:
+the value of the property as a long
+
+
+
+
+
+getMaximumDuration
+
+Integer number of seconds of the maximum duration of an authenticated session.
+ After this period is exceeded, a user must reauthenticate.
+
+Returns:
+the value of the property as a Duration
+
+
+
+
+
+getAuthCheckInterval
+public long getAuthCheckInterval ()
+Integer number of seconds after which ngrok guarantees it will refresh user
+ state from the identity provider and recheck whether the user is still
+ authorized to access the endpoint. This is the preferred tunable to use to
+ enforce a minimum amount of time after which a revoked user will no longer be
+ able to access the resource.
+
+Returns:
+the value of the property as a long
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuthFacebook.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
the OAuth app client ID.
+
+
+
+
+
the OAuth app client ID.
+
+
+
+
+
the OAuth app client secret.
+
+
+
+
+
the OAuth app client secret.
+
+
+
+
+
a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+
+
+
+
a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+clientId
+
+the OAuth app client ID. retrieve it from the identity provider'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
+ well.
+
+Parameters:
+clientId - the value of the client_id parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+clientId
+
+the OAuth app client ID. retrieve it from the identity provider'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
+ well.
+
+Parameters:
+clientId - the value of the client_id parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+clientSecret
+
+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 client_id.
+
+Parameters:
+clientSecret - the value of the client_secret parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+clientSecret
+
+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 client_id.
+
+Parameters:
+clientSecret - the value of the client_secret parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+scopes
+
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for. these may not be set if you are using the ngrok-managed
+ oauth app (i.e. you must pass both client_id and
+ client_secret to set scopes)
+
+Parameters:
+scopes - the value of the scopes parameter as a List <String >Returns:
+this builder instance
+
+
+
+
+
+scopes
+
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for. these may not be set if you are using the ngrok-managed
+ oauth app (i.e. you must pass both client_id and
+ client_secret to set scopes)
+
+Parameters:
+scopes - the value of the scopes parameter as a List <String >OptionalReturns:
+this builder instance
+
+
+
+
+
+emailAddresses
+
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Parameters:
+emailAddresses - the value of the email_addresses parameter as a List <String >Returns:
+this builder instance
+
+
+
+
+
+emailAddresses
+
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Parameters:
+emailAddresses - the value of the email_addresses parameter as a List <String >OptionalReturns:
+this builder instance
+
+
+
+
+
+emailDomains
+
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Parameters:
+emailDomains - the value of the email_domains parameter as a List <String >Returns:
+this builder instance
+
+
+
+
+
+emailDomains
+
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Parameters:
+emailDomains - the value of the email_domains parameter as a List <String >OptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuthFacebook (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointOAuthFacebook
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
the OAuth app client ID.
+
+
+
+
+
the OAuth app client secret.
+
+
+
+
+
a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getClientId
+
+the OAuth app client ID. retrieve it from the identity provider'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
+ well.
+
+Returns:
+the value of the property as a StringOptional
+
+
+
+
+
+getClientSecret
+
+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 client_id.
+
+Returns:
+the value of the property as a StringOptional
+
+
+
+
+
+getScopes
+
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for. these may not be set if you are using the ngrok-managed
+ oauth app (i.e. you must pass both client_id and
+ client_secret to set scopes)
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+getEmailAddresses
+
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+getEmailDomains
+
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuthGitHub.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
the OAuth app client ID.
+
+
+
+
+
the OAuth app client ID.
+
+
+
+
+
the OAuth app client secret.
+
+
+
+
+
the OAuth app client secret.
+
+
+
+
+
a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of github org identifiers.
+
+
+
+
+
a list of github org identifiers.
+
+
+
+
+
a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+
+
+
+
a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+
+
+
+
a list of github teams identifiers.
+
+
+
+
+
a list of github teams identifiers.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+clientId
+
+the OAuth app client ID. retrieve it from the identity provider'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
+ well.
+
+Parameters:
+clientId - the value of the client_id parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+clientId
+
+the OAuth app client ID. retrieve it from the identity provider'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
+ well.
+
+Parameters:
+clientId - the value of the client_id parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+clientSecret
+
+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 client_id.
+
+Parameters:
+clientSecret - the value of the client_secret parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+clientSecret
+
+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 client_id.
+
+Parameters:
+clientSecret - the value of the client_secret parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+scopes
+
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for. these may not be set if you are using the ngrok-managed
+ oauth app (i.e. you must pass both client_id and
+ client_secret to set scopes)
+
+Parameters:
+scopes - the value of the scopes parameter as a List <String >Returns:
+this builder instance
+
+
+
+
+
+scopes
+
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for. these may not be set if you are using the ngrok-managed
+ oauth app (i.e. you must pass both client_id and
+ client_secret to set scopes)
+
+Parameters:
+scopes - the value of the scopes parameter as a List <String >OptionalReturns:
+this builder instance
+
+
+
+
+
+emailAddresses
+
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Parameters:
+emailAddresses - the value of the email_addresses parameter as a List <String >Returns:
+this builder instance
+
+
+
+
+
+emailAddresses
+
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Parameters:
+emailAddresses - the value of the email_addresses parameter as a List <String >OptionalReturns:
+this builder instance
+
+
+
+
+
+emailDomains
+
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Parameters:
+emailDomains - the value of the email_domains parameter as a List <String >Returns:
+this builder instance
+
+
+
+
+
+emailDomains
+
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Parameters:
+emailDomains - the value of the email_domains parameter as a List <String >OptionalReturns:
+this builder instance
+
+
+
+
+
+teams
+
+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. org-name/team-name
+
+Parameters:
+teams - the value of the teams parameter as a List <String >Returns:
+this builder instance
+
+
+
+
+
+teams
+
+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. org-name/team-name
+
+Parameters:
+teams - the value of the teams parameter as a List <String >OptionalReturns:
+this builder instance
+
+
+
+
+
+organizations
+
+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'
+
+Parameters:
+organizations - the value of the organizations parameter as a List <String >Returns:
+this builder instance
+
+
+
+
+
+organizations
+
+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'
+
+Parameters:
+organizations - the value of the organizations parameter as a List <String >OptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuthGitHub (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointOAuthGitHub
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
the OAuth app client ID.
+
+
+
+
+
the OAuth app client secret.
+
+
+
+
+
a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of github org identifiers.
+
+
+
+
+
a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+
+
+
+
a list of github teams identifiers.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getClientId
+
+the OAuth app client ID. retrieve it from the identity provider'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
+ well.
+
+Returns:
+the value of the property as a StringOptional
+
+
+
+
+
+getClientSecret
+
+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 client_id.
+
+Returns:
+the value of the property as a StringOptional
+
+
+
+
+
+getScopes
+
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for. these may not be set if you are using the ngrok-managed
+ oauth app (i.e. you must pass both client_id and
+ client_secret to set scopes)
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+getEmailAddresses
+
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+getEmailDomains
+
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+getTeams
+
+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. org-name/team-name
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+getOrganizations
+
+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'
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuthGoogle.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
the OAuth app client ID.
+
+
+
+
+
the OAuth app client ID.
+
+
+
+
+
the OAuth app client secret.
+
+
+
+
+
the OAuth app client secret.
+
+
+
+
+
a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+
+
+
+
a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+clientId
+
+the OAuth app client ID. retrieve it from the identity provider'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
+ well.
+
+Parameters:
+clientId - the value of the client_id parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+clientId
+
+the OAuth app client ID. retrieve it from the identity provider'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
+ well.
+
+Parameters:
+clientId - the value of the client_id parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+clientSecret
+
+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 client_id.
+
+Parameters:
+clientSecret - the value of the client_secret parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+clientSecret
+
+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 client_id.
+
+Parameters:
+clientSecret - the value of the client_secret parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+scopes
+
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for. these may not be set if you are using the ngrok-managed
+ oauth app (i.e. you must pass both client_id and
+ client_secret to set scopes)
+
+Parameters:
+scopes - the value of the scopes parameter as a List <String >Returns:
+this builder instance
+
+
+
+
+
+scopes
+
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for. these may not be set if you are using the ngrok-managed
+ oauth app (i.e. you must pass both client_id and
+ client_secret to set scopes)
+
+Parameters:
+scopes - the value of the scopes parameter as a List <String >OptionalReturns:
+this builder instance
+
+
+
+
+
+emailAddresses
+
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Parameters:
+emailAddresses - the value of the email_addresses parameter as a List <String >Returns:
+this builder instance
+
+
+
+
+
+emailAddresses
+
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Parameters:
+emailAddresses - the value of the email_addresses parameter as a List <String >OptionalReturns:
+this builder instance
+
+
+
+
+
+emailDomains
+
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Parameters:
+emailDomains - the value of the email_domains parameter as a List <String >Returns:
+this builder instance
+
+
+
+
+
+emailDomains
+
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Parameters:
+emailDomains - the value of the email_domains parameter as a List <String >OptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuthGoogle (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointOAuthGoogle
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
the OAuth app client ID.
+
+
+
+
+
the OAuth app client secret.
+
+
+
+
+
a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getClientId
+
+the OAuth app client ID. retrieve it from the identity provider'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
+ well.
+
+Returns:
+the value of the property as a StringOptional
+
+
+
+
+
+getClientSecret
+
+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 client_id.
+
+Returns:
+the value of the property as a StringOptional
+
+
+
+
+
+getScopes
+
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for. these may not be set if you are using the ngrok-managed
+ oauth app (i.e. you must pass both client_id and
+ client_secret to set scopes)
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+getEmailAddresses
+
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+getEmailDomains
+
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuthMicrosoft.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
the OAuth app client ID.
+
+
+
+
+
the OAuth app client ID.
+
+
+
+
+
the OAuth app client secret.
+
+
+
+
+
the OAuth app client secret.
+
+
+
+
+
a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+
+
+
+
a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+clientId
+
+the OAuth app client ID. retrieve it from the identity provider'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
+ well.
+
+Parameters:
+clientId - the value of the client_id parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+clientId
+
+the OAuth app client ID. retrieve it from the identity provider'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
+ well.
+
+Parameters:
+clientId - the value of the client_id parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+clientSecret
+
+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 client_id.
+
+Parameters:
+clientSecret - the value of the client_secret parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+clientSecret
+
+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 client_id.
+
+Parameters:
+clientSecret - the value of the client_secret parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+scopes
+
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for. these may not be set if you are using the ngrok-managed
+ oauth app (i.e. you must pass both client_id and
+ client_secret to set scopes)
+
+Parameters:
+scopes - the value of the scopes parameter as a List <String >Returns:
+this builder instance
+
+
+
+
+
+scopes
+
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for. these may not be set if you are using the ngrok-managed
+ oauth app (i.e. you must pass both client_id and
+ client_secret to set scopes)
+
+Parameters:
+scopes - the value of the scopes parameter as a List <String >OptionalReturns:
+this builder instance
+
+
+
+
+
+emailAddresses
+
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Parameters:
+emailAddresses - the value of the email_addresses parameter as a List <String >Returns:
+this builder instance
+
+
+
+
+
+emailAddresses
+
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Parameters:
+emailAddresses - the value of the email_addresses parameter as a List <String >OptionalReturns:
+this builder instance
+
+
+
+
+
+emailDomains
+
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Parameters:
+emailDomains - the value of the email_domains parameter as a List <String >Returns:
+this builder instance
+
+
+
+
+
+emailDomains
+
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Parameters:
+emailDomains - the value of the email_domains parameter as a List <String >OptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuthMicrosoft (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointOAuthMicrosoft
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
the OAuth app client ID.
+
+
+
+
+
the OAuth app client secret.
+
+
+
+
+
a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getClientId
+
+the OAuth app client ID. retrieve it from the identity provider'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
+ well.
+
+Returns:
+the value of the property as a StringOptional
+
+
+
+
+
+getClientSecret
+
+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 client_id.
+
+Returns:
+the value of the property as a StringOptional
+
+
+
+
+
+getScopes
+
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for. these may not be set if you are using the ngrok-managed
+ oauth app (i.e. you must pass both client_id and
+ client_secret to set scopes)
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+getEmailAddresses
+
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+getEmailDomains
+
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuthProvider.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
configuration for using facebook as the identity provider
+
+
+
+
+
configuration for using facebook as the identity provider
+
+
+
+
+
configuration for using github as the identity provider
+
+
+
+
+
configuration for using github as the identity provider
+
+
+
+
+
configuration for using google as the identity provider
+
+
+
+
+
configuration for using google as the identity provider
+
+
+
+
+
configuration for using microsoft as the identity provider
+
+
+
+
+
configuration for using microsoft as the identity provider
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+github
+
+configuration for using github as the identity provider
+
+Parameters:
+github - the value of the github parameter as a EndpointOAuthGitHubReturns:
+this builder instance
+
+
+
+
+
+github
+
+configuration for using github as the identity provider
+
+Parameters:
+github - the value of the github parameter as a EndpointOAuthGitHubOptionalReturns:
+this builder instance
+
+
+
+
+
+facebook
+
+configuration for using facebook as the identity provider
+
+Parameters:
+facebook - the value of the facebook parameter as a EndpointOAuthFacebookReturns:
+this builder instance
+
+
+
+
+
+facebook
+
+configuration for using facebook as the identity provider
+
+Parameters:
+facebook - the value of the facebook parameter as a EndpointOAuthFacebookOptionalReturns:
+this builder instance
+
+
+
+
+
+microsoft
+
+configuration for using microsoft as the identity provider
+
+Parameters:
+microsoft - the value of the microsoft parameter as a EndpointOAuthMicrosoftReturns:
+this builder instance
+
+
+
+
+
+microsoft
+
+configuration for using microsoft as the identity provider
+
+Parameters:
+microsoft - the value of the microsoft parameter as a EndpointOAuthMicrosoftOptionalReturns:
+this builder instance
+
+
+
+
+
+google
+
+configuration for using google as the identity provider
+
+Parameters:
+google - the value of the google parameter as a EndpointOAuthGoogleReturns:
+this builder instance
+
+
+
+
+
+google
+
+configuration for using google as the identity provider
+
+Parameters:
+google - the value of the google parameter as a EndpointOAuthGoogleOptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuthProvider (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointOAuthProvider
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
configuration for using facebook as the identity provider
+
+
+
+
+
configuration for using github as the identity provider
+
+
+
+
+
configuration for using google as the identity provider
+
+
+
+
+
configuration for using microsoft as the identity provider
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getGithub
+
+configuration for using github as the identity provider
+
+Returns:
+the value of the property as a EndpointOAuthGitHubOptional
+
+
+
+
+
+getFacebook
+
+configuration for using facebook as the identity provider
+
+Returns:
+the value of the property as a EndpointOAuthFacebookOptional
+
+
+
+
+
+getMicrosoft
+
+configuration for using microsoft as the identity provider
+
+Returns:
+the value of the property as a EndpointOAuthMicrosoftOptional
+
+
+
+
+
+getGoogle
+
+configuration for using google as the identity provider
+
+Returns:
+the value of the property as a EndpointOAuthGoogleOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOidc.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointOidc
+public static class EndpointOidc.Builder
+
extends Object
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
The OIDC app's client ID and OIDC audience.
+
+
+
+
+
The OIDC app's client ID and OIDC audience.
+
+
+
+
+
The OIDC app's client secret.
+
+
+
+
+
The OIDC app's client secret.
+
+
+
+
+
the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+
+
+
+
the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
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.
+
+
+
+
+
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.
+
+
+
+
+
URL of the OIDC "OpenID provider".
+
+
+
+
+
URL of the OIDC "OpenID provider".
+
+
+
+
+
Integer number of seconds of the maximum duration of an authenticated session.
+
+
+
+
+
Integer number of seconds of the maximum duration of an authenticated session.
+
+
+
+
+
Do not enforce authentication on HTTP OPTIONS requests.
+
+
+
+
+
Do not enforce authentication on HTTP OPTIONS requests.
+
+
+
+
+
The set of scopes to request from the OIDC identity provider.
+
+
+
+
+
The set of scopes to request from the OIDC identity provider.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a booleanReturns:
+this builder instance
+
+
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a boolean, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+optionsPassthrough
+
+Do not enforce authentication on HTTP OPTIONS requests. necessary if you are
+ supporting CORS.
+
+Parameters:
+optionsPassthrough - the value of the options_passthrough parameter as a booleanReturns:
+this builder instance
+
+
+
+
+
+optionsPassthrough
+
+Do not enforce authentication on HTTP OPTIONS requests. necessary if you are
+ supporting CORS.
+
+Parameters:
+optionsPassthrough - the value of the options_passthrough parameter as a boolean, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+cookiePrefix
+
+the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication. default is 'ngrok.'
+
+Parameters:
+cookiePrefix - the value of the cookie_prefix parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+cookiePrefix
+
+the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication. default is 'ngrok.'
+
+Parameters:
+cookiePrefix - the value of the cookie_prefix parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+inactivityTimeout
+
+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.
+
+Parameters:
+inactivityTimeout - the value of the inactivity_timeout parameter as a longReturns:
+this builder instance
+
+
+
+
+
+inactivityTimeout
+
+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.
+
+Parameters:
+inactivityTimeout - the value of the inactivity_timeout parameter as a long, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+maximumDuration
+
+Integer number of seconds of the maximum duration of an authenticated session.
+ After this period is exceeded, a user must reauthenticate.
+
+Parameters:
+maximumDuration - the value of the maximum_duration parameter as a DurationReturns:
+this builder instance
+
+
+
+
+
+maximumDuration
+
+Integer number of seconds of the maximum duration of an authenticated session.
+ After this period is exceeded, a user must reauthenticate.
+
+Parameters:
+maximumDuration - the value of the maximum_duration parameter as a DurationOptionalReturns:
+this builder instance
+
+
+
+
+
+issuer
+
+URL of the OIDC "OpenID provider". This is the base URL used for discovery.
+
+Parameters:
+issuer - the value of the issuer parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+issuer
+
+URL of the OIDC "OpenID provider". This is the base URL used for discovery.
+
+Parameters:
+issuer - the value of the issuer parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+clientId
+
+The OIDC app's client ID and OIDC audience.
+
+Parameters:
+clientId - the value of the client_id parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+clientId
+
+The OIDC app's client ID and OIDC audience.
+
+Parameters:
+clientId - the value of the client_id parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+clientSecret
+
+The OIDC app's client secret.
+
+Parameters:
+clientSecret - the value of the client_secret parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+clientSecret
+
+The OIDC app's client secret.
+
+Parameters:
+clientSecret - the value of the client_secret parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+scopes
+
+The set of scopes to request from the OIDC identity provider.
+
+Parameters:
+scopes - the value of the scopes parameter as a List <String >Returns:
+this builder instance
+
+
+
+
+
+scopes
+
+The set of scopes to request from the OIDC identity provider.
+
+Parameters:
+scopes - the value of the scopes parameter as a List <String >OptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOidc (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointOidc
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
The OIDC app's client ID and OIDC audience.
+
+
+
+
+
The OIDC app's client secret.
+
+
+
+
+
the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
long
+
+
+
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.
+
+
+
+
+
URL of the OIDC "OpenID provider".
+
+
+
+
+
Integer number of seconds of the maximum duration of an authenticated session.
+
+
boolean
+
+
+
Do not enforce authentication on HTTP OPTIONS requests.
+
+
+
+
+
The set of scopes to request from the OIDC identity provider.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getEnabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Returns:
+the value of the property as a boolean wrapped in an Optional
+
+
+
+
+
+getOptionsPassthrough
+public boolean getOptionsPassthrough ()
+Do not enforce authentication on HTTP OPTIONS requests. necessary if you are
+ supporting CORS.
+
+Returns:
+the value of the property as a boolean
+
+
+
+
+
+getCookiePrefix
+public String getCookiePrefix ()
the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication. default is 'ngrok.'
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getInactivityTimeout
+public long getInactivityTimeout ()
+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.
+
+Returns:
+the value of the property as a long
+
+
+
+
+
+getMaximumDuration
+
+Integer number of seconds of the maximum duration of an authenticated session.
+ After this period is exceeded, a user must reauthenticate.
+
+Returns:
+the value of the property as a Duration
+
+
+
+
+
+getIssuer
+
+URL of the OIDC "OpenID provider". This is the base URL used for discovery.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getClientId
+
+The OIDC app's client ID and OIDC audience.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getClientSecret
+public String getClientSecret ()
The OIDC app's client secret.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getScopes
+
+The set of scopes to request from the OIDC identity provider.
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointRequestHeaders.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
a map of header key to header value that will be injected into the HTTP Request
+ before being sent to the upstream application server
+
+
+
+
+
a map of header key to header value that will be injected into the HTTP Request
+ before being sent to the upstream application server
+
+
+
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
a list of header names that will be removed from the HTTP Request before being
+ sent to the upstream application server
+
+
+
+
+
a list of header names that will be removed from the HTTP Request before being
+ sent to the upstream application server
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a booleanReturns:
+this builder instance
+
+
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a boolean, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+add
+
+a map of header key to header value that will be injected into the HTTP Request
+ before being sent to the upstream application server
+
+Parameters:
+add - the value of the add parameter as a Map <String ,String >Returns:
+this builder instance
+
+
+
+
+
+add
+
+a map of header key to header value that will be injected into the HTTP Request
+ before being sent to the upstream application server
+
+Parameters:
+add - the value of the add parameter as a Map <String ,String >OptionalReturns:
+this builder instance
+
+
+
+
+
+remove
+
+a list of header names that will be removed from the HTTP Request before being
+ sent to the upstream application server
+
+Parameters:
+remove - the value of the remove parameter as a List <String >Returns:
+this builder instance
+
+
+
+
+
+remove
+
+a list of header names that will be removed from the HTTP Request before being
+ sent to the upstream application server
+
+Parameters:
+remove - the value of the remove parameter as a List <String >OptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointRequestHeaders (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointRequestHeaders
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
a map of header key to header value that will be injected into the HTTP Request
+ before being sent to the upstream application server
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
a list of header names that will be removed from the HTTP Request before being
+ sent to the upstream application server
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getEnabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Returns:
+the value of the property as a boolean wrapped in an Optional
+
+
+
+
+
+getAdd
+
+a map of header key to header value that will be injected into the HTTP Request
+ before being sent to the upstream application server
+
+Returns:
+the value of the property as a Map <String ,String >
+
+
+
+
+
+getRemove
+
+a list of header names that will be removed from the HTTP Request before being
+ sent to the upstream application server
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointResponseHeaders.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
a map of header key to header value that will be injected into the HTTP Response
+ returned to the HTTP client
+
+
+
+
+
a map of header key to header value that will be injected into the HTTP Response
+ returned to the HTTP client
+
+
+
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
a list of header names that will be removed from the HTTP Response returned to
+ the HTTP client
+
+
+
+
+
a list of header names that will be removed from the HTTP Response returned to
+ the HTTP client
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a booleanReturns:
+this builder instance
+
+
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a boolean, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+add
+
+a map of header key to header value that will be injected into the HTTP Response
+ returned to the HTTP client
+
+Parameters:
+add - the value of the add parameter as a Map <String ,String >Returns:
+this builder instance
+
+
+
+
+
+add
+
+a map of header key to header value that will be injected into the HTTP Response
+ returned to the HTTP client
+
+Parameters:
+add - the value of the add parameter as a Map <String ,String >OptionalReturns:
+this builder instance
+
+
+
+
+
+remove
+
+a list of header names that will be removed from the HTTP Response returned to
+ the HTTP client
+
+Parameters:
+remove - the value of the remove parameter as a List <String >Returns:
+this builder instance
+
+
+
+
+
+remove
+
+a list of header names that will be removed from the HTTP Response returned to
+ the HTTP client
+
+Parameters:
+remove - the value of the remove parameter as a List <String >OptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointResponseHeaders (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointResponseHeaders
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
a map of header key to header value that will be injected into the HTTP Response
+ returned to the HTTP client
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
a list of header names that will be removed from the HTTP Response returned to
+ the HTTP client
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getEnabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Returns:
+the value of the property as a boolean wrapped in an Optional
+
+
+
+
+
+getAdd
+
+a map of header key to header value that will be injected into the HTTP Response
+ returned to the HTTP client
+
+Returns:
+the value of the property as a Map <String ,String >
+
+
+
+
+
+getRemove
+
+a list of header names that will be removed from the HTTP Response returned to
+ the HTTP client
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointSaml (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointSaml
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
EndpointSaml Optional <Boolean > enabled,
+ Boolean optionsPassthrough,
+ String cookiePrefix,
+ Long inactivityTimeout,
+ Duration maximumDuration,
+ String idpMetadata,
+ Boolean forceAuthn,
+ Optional <Boolean > allowIdpInitiated,
+ List <String > authorizedGroups,
+ String entityId,
+ URI assertionConsumerServiceUrl,
+ URI singleLogoutUrl,
+ String requestSigningCertificatePem,
+ URI metadataUrl,
+ String nameidFormat)
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
If true, the IdP may initiate a login directly (e.g.
+
+
+
+
+
The public URL of the SP's Assertion Consumer Service.
+
+
+
+
+
If present, only users who are a member of one of the listed groups may access
+ the target endpoint.
+
+
+
+
+
the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
The SP Entity's unique ID.
+
+
boolean
+
+
+
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.
+
+
+
+
+
The full XML IdP EntityDescriptor.
+
+
long
+
+
+
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.
+
+
+
+
+
Integer number of seconds of the maximum duration of an authenticated session.
+
+
+
+
+
A public URL where the SP's metadata is hosted.
+
+
+
+
+
Defines the name identifier format the SP expects the IdP to use in its
+ assertions to identify subjects.
+
+
boolean
+
+
+
Do not enforce authentication on HTTP OPTIONS requests.
+
+
+
+
+
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.
+
+
+
+
+
The public URL of the SP's Single Logout Service.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EndpointSaml
+public EndpointSaml
(Optional <Boolean > enabled,
+ Boolean optionsPassthrough,
+ String cookiePrefix,
+ Long inactivityTimeout,
+ Duration maximumDuration,
+ String idpMetadata,
+ Boolean forceAuthn,
+ Optional <Boolean > allowIdpInitiated,
+ List <String > authorizedGroups,
+ String entityId,
+ URI assertionConsumerServiceUrl,
+ URI singleLogoutUrl,
+ String requestSigningCertificatePem,
+ URI metadataUrl,
+ String nameidFormat)
+Parameters:
+enabled - true if the module will be applied to traffic, false to disable. default true if unspecifiedoptionsPassthrough - Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.cookiePrefix - the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'inactivityTimeout - 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.maximumDuration - Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.idpMetadata - The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.forceAuthn - 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.allowIdpInitiated - 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 RelayState parameter to the target URL of the resource they want the user to be redirected to after the SAML login assertion has been processed.authorizedGroups - If present, only users who are a member of one of the listed groups may access the target endpoint.entityId - 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.assertionConsumerServiceUrl - 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.singleLogoutUrl - 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.requestSigningCertificatePem - 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.metadataUrl - 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.nameidFormat - Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of urn:oasis:names:tc:SAML:2.0:nameid-format:persistent will be used. A subset of the allowed values enumerated by the SAML specification are supported.
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getEnabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Returns:
+the value of the property as a boolean wrapped in an Optional
+
+
+
+
+
+getOptionsPassthrough
+public boolean getOptionsPassthrough ()
+Do not enforce authentication on HTTP OPTIONS requests. necessary if you are
+ supporting CORS.
+
+Returns:
+the value of the property as a boolean
+
+
+
+
+
+getCookiePrefix
+public String getCookiePrefix ()
the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication. default is 'ngrok.'
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getInactivityTimeout
+public long getInactivityTimeout ()
+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.
+
+Returns:
+the value of the property as a long
+
+
+
+
+
+getMaximumDuration
+
+Integer number of seconds of the maximum duration of an authenticated session.
+ After this period is exceeded, a user must reauthenticate.
+
+Returns:
+the value of the property as a Duration
+
+
+
+
+
+
+
+
+getForceAuthn
+public boolean getForceAuthn ()
+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.
+
+Returns:
+the value of the property as a boolean
+
+
+
+
+
+getAllowIdpInitiated
+
+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
+ RelayState parameter to the target URL of the resource they want
+ the user to be redirected to after the SAML login assertion has been processed.
+
+Returns:
+the value of the property as a boolean wrapped in an Optional
+
+
+
+
+
+getAuthorizedGroups
+
+If present, only users who are a member of one of the listed groups may access
+ the target endpoint.
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+getEntityId
+
+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.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getAssertionConsumerServiceUrl
+public URI getAssertionConsumerServiceUrl ()
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.
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getSingleLogoutUrl
+public URI getSingleLogoutUrl ()
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.
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getRequestSigningCertificatePem
+public String getRequestSigningCertificatePem ()
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.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointSamlMutate.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
If true, the IdP may initiate a login directly (e.g.
+
+
+
+
+
If true, the IdP may initiate a login directly (e.g.
+
+
+
+
+
If present, only users who are a member of one of the listed groups may access
+ the target endpoint.
+
+
+
+
+
If present, only users who are a member of one of the listed groups may access
+ the target endpoint.
+
+
+
+
+
+
+
+
the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+
+
+
+
the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
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.
+
+
+
+
+
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.
+
+
+
+
+
The full XML IdP EntityDescriptor.
+
+
+
+
+
The full XML IdP EntityDescriptor.
+
+
+
+
+
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.
+
+
+
+
+
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.
+
+
+
+
+
Integer number of seconds of the maximum duration of an authenticated session.
+
+
+
+
+
Integer number of seconds of the maximum duration of an authenticated session.
+
+
+
+
+
Defines the name identifier format the SP expects the IdP to use in its
+ assertions to identify subjects.
+
+
+
+
+
Defines the name identifier format the SP expects the IdP to use in its
+ assertions to identify subjects.
+
+
+
+
+
Do not enforce authentication on HTTP OPTIONS requests.
+
+
+
+
+
Do not enforce authentication on HTTP OPTIONS requests.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a booleanReturns:
+this builder instance
+
+
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a boolean, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+optionsPassthrough
+
+Do not enforce authentication on HTTP OPTIONS requests. necessary if you are
+ supporting CORS.
+
+Parameters:
+optionsPassthrough - the value of the options_passthrough parameter as a booleanReturns:
+this builder instance
+
+
+
+
+
+optionsPassthrough
+
+Do not enforce authentication on HTTP OPTIONS requests. necessary if you are
+ supporting CORS.
+
+Parameters:
+optionsPassthrough - the value of the options_passthrough parameter as a boolean, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+cookiePrefix
+
+the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication. default is 'ngrok.'
+
+Parameters:
+cookiePrefix - the value of the cookie_prefix parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+cookiePrefix
+
+the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication. default is 'ngrok.'
+
+Parameters:
+cookiePrefix - the value of the cookie_prefix parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+inactivityTimeout
+
+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.
+
+Parameters:
+inactivityTimeout - the value of the inactivity_timeout parameter as a longReturns:
+this builder instance
+
+
+
+
+
+inactivityTimeout
+
+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.
+
+Parameters:
+inactivityTimeout - the value of the inactivity_timeout parameter as a long, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+maximumDuration
+
+Integer number of seconds of the maximum duration of an authenticated session.
+ After this period is exceeded, a user must reauthenticate.
+
+Parameters:
+maximumDuration - the value of the maximum_duration parameter as a DurationReturns:
+this builder instance
+
+
+
+
+
+maximumDuration
+
+Integer number of seconds of the maximum duration of an authenticated session.
+ After this period is exceeded, a user must reauthenticate.
+
+Parameters:
+maximumDuration - the value of the maximum_duration parameter as a DurationOptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+forceAuthn
+
+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.
+
+Parameters:
+forceAuthn - the value of the force_authn parameter as a booleanReturns:
+this builder instance
+
+
+
+
+
+forceAuthn
+
+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.
+
+Parameters:
+forceAuthn - the value of the force_authn parameter as a boolean, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+allowIdpInitiated
+
+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
+ RelayState parameter to the target URL of the resource they want
+ the user to be redirected to after the SAML login assertion has been processed.
+
+Parameters:
+allowIdpInitiated - the value of the allow_idp_initiated parameter as a booleanReturns:
+this builder instance
+
+
+
+
+
+allowIdpInitiated
+
+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
+ RelayState parameter to the target URL of the resource they want
+ the user to be redirected to after the SAML login assertion has been processed.
+
+Parameters:
+allowIdpInitiated - the value of the allow_idp_initiated parameter as a boolean, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+authorizedGroups
+
+If present, only users who are a member of one of the listed groups may access
+ the target endpoint.
+
+Parameters:
+authorizedGroups - the value of the authorized_groups parameter as a List <String >Returns:
+this builder instance
+
+
+
+
+
+authorizedGroups
+
+If present, only users who are a member of one of the listed groups may access
+ the target endpoint.
+
+Parameters:
+authorizedGroups - the value of the authorized_groups parameter as a List <String >OptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointSamlMutate (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointSamlMutate
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
If true, the IdP may initiate a login directly (e.g.
+
+
+
+
+
If present, only users who are a member of one of the listed groups may access
+ the target endpoint.
+
+
+
+
+
the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
boolean
+
+
+
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.
+
+
+
+
+
The full XML IdP EntityDescriptor.
+
+
long
+
+
+
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.
+
+
+
+
+
Integer number of seconds of the maximum duration of an authenticated session.
+
+
+
+
+
Defines the name identifier format the SP expects the IdP to use in its
+ assertions to identify subjects.
+
+
boolean
+
+
+
Do not enforce authentication on HTTP OPTIONS requests.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getEnabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Returns:
+the value of the property as a boolean wrapped in an Optional
+
+
+
+
+
+getOptionsPassthrough
+public boolean getOptionsPassthrough ()
+Do not enforce authentication on HTTP OPTIONS requests. necessary if you are
+ supporting CORS.
+
+Returns:
+the value of the property as a boolean
+
+
+
+
+
+getCookiePrefix
+public String getCookiePrefix ()
the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication. default is 'ngrok.'
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getInactivityTimeout
+public long getInactivityTimeout ()
+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.
+
+Returns:
+the value of the property as a long
+
+
+
+
+
+getMaximumDuration
+
+Integer number of seconds of the maximum duration of an authenticated session.
+ After this period is exceeded, a user must reauthenticate.
+
+Returns:
+the value of the property as a Duration
+
+
+
+
+
+
+
+
+getForceAuthn
+public boolean getForceAuthn ()
+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.
+
+Returns:
+the value of the property as a boolean
+
+
+
+
+
+getAllowIdpInitiated
+
+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
+ RelayState parameter to the target URL of the resource they want
+ the user to be redirected to after the SAML login assertion has been processed.
+
+Returns:
+the value of the property as a boolean wrapped in an Optional
+
+
+
+
+
+getAuthorizedGroups
+
+If present, only users who are a member of one of the listed groups may access
+ the target endpoint.
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointTlsTermination.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
The minimum TLS version used for termination and advertised to the client during
+ the TLS handshake.
+
+
+
+
+
The minimum TLS version used for termination and advertised to the client during
+ the TLS handshake.
+
+
+
+
+
edge if the ngrok edge should terminate TLS traffic,
+ upstream if TLS traffic should be passed through to the upstream
+ ngrok agent / application server for termination.
+
+
+
+
+
edge if the ngrok edge should terminate TLS traffic,
+ upstream if TLS traffic should be passed through to the upstream
+ ngrok agent / application server for termination.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a booleanReturns:
+this builder instance
+
+
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a boolean, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+terminateAt
+
+edge if the ngrok edge should terminate TLS traffic,
+ upstream if TLS traffic should be passed through to the upstream
+ ngrok agent / application server for termination. if upstream is
+ chosen, most other modules will be disallowed because they rely on the ngrok
+ edge being able to access the underlying traffic.
+
+Parameters:
+terminateAt - the value of the terminate_at parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+terminateAt
+
+edge if the ngrok edge should terminate TLS traffic,
+ upstream if TLS traffic should be passed through to the upstream
+ ngrok agent / application server for termination. if upstream is
+ chosen, most other modules will be disallowed because they rely on the ngrok
+ edge being able to access the underlying traffic.
+
+Parameters:
+terminateAt - the value of the terminate_at parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+minVersion
+
+The minimum TLS version used for termination and advertised to the client during
+ the TLS handshake. if unspecified, ngrok will choose an industry-safe default.
+ This value must be null if terminate_at is set to
+ upstream.
+
+Parameters:
+minVersion - the value of the min_version parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+minVersion
+
+The minimum TLS version used for termination and advertised to the client during
+ the TLS handshake. if unspecified, ngrok will choose an industry-safe default.
+ This value must be null if terminate_at is set to
+ upstream.
+
+Parameters:
+minVersion - the value of the min_version parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointTlsTermination (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointTlsTermination
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
The minimum TLS version used for termination and advertised to the client during
+ the TLS handshake.
+
+
+
+
+
edge if the ngrok edge should terminate TLS traffic,
+ upstream if TLS traffic should be passed through to the upstream
+ ngrok agent / application server for termination.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getEnabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Returns:
+the value of the property as a boolean wrapped in an Optional
+
+
+
+
+
+getTerminateAt
+public String getTerminateAt ()
edge if the ngrok edge should terminate TLS traffic,
+ upstream if TLS traffic should be passed through to the upstream
+ ngrok agent / application server for termination. if upstream is
+ chosen, most other modules will be disallowed because they rely on the ngrok
+ edge being able to access the underlying traffic.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getMinVersion
+
+The minimum TLS version used for termination and advertised to the client during
+ the TLS handshake. if unspecified, ngrok will choose an industry-safe default.
+ This value must be null if terminate_at is set to
+ upstream.
+
+Returns:
+the value of the property as a StringOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointWebhookValidation.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
a string indicating which webhook provider will be sending webhooks to this
+ endpoint.
+
+
+
+
+
a string indicating which webhook provider will be sending webhooks to this
+ endpoint.
+
+
+
+
+
a string secret used to validate requests from the given provider.
+
+
+
+
+
a string secret used to validate requests from the given provider.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a booleanReturns:
+this builder instance
+
+
+
+
+
+enabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Parameters:
+enabled - the value of the enabled parameter as a boolean, wrapped in an OptionalReturns:
+this builder instance
+
+
+
+
+
+provider
+
+a string indicating which webhook provider will be sending webhooks to this
+ endpoint. Value must be one of the supported providers: SLACK,
+ SNS, STRIPE, GITHUB, TWILIO,
+ SHOPIFY, GITLAB, INTERCOM,
+ SENDGRID, XERO.
+
+Parameters:
+provider - the value of the provider parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+provider
+
+a string indicating which webhook provider will be sending webhooks to this
+ endpoint. Value must be one of the supported providers: SLACK,
+ SNS, STRIPE, GITHUB, TWILIO,
+ SHOPIFY, GITLAB, INTERCOM,
+ SENDGRID, XERO.
+
+Parameters:
+provider - the value of the provider parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+secret
+
+a string secret used to validate requests from the given provider. All providers
+ except AWS SNS require a secret
+
+Parameters:
+secret - the value of the secret parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+secret
+
+a string secret used to validate requests from the given provider. All providers
+ except AWS SNS require a secret
+
+Parameters:
+secret - the value of the secret parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointWebhookValidation (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointWebhookValidation
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
a string indicating which webhook provider will be sending webhooks to this
+ endpoint.
+
+
+
+
+
a string secret used to validate requests from the given provider.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getEnabled
+
+true if the module will be applied to traffic, false
+ to disable. default true if unspecified
+
+Returns:
+the value of the property as a boolean wrapped in an Optional
+
+
+
+
+
+getProvider
+
+a string indicating which webhook provider will be sending webhooks to this
+ endpoint. Value must be one of the supported providers: SLACK,
+ SNS, STRIPE, GITHUB, TWILIO,
+ SHOPIFY, GITLAB, INTERCOM,
+ SENDGRID, XERO.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getSecret
+
+a string secret used to validate requests from the given provider. All providers
+ except AWS SNS require a secret
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventDestination (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EventDestination
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
Timestamp when the Event Destination was created, RFC 3339 format.
+
+
+
+
+
Human-readable description of the Event Destination.
+
+
+
+
+
The output format you would like to serialize events into when sending to their
+ target.
+
+
+
+
+
Unique identifier for this Event Destination.
+
+
+
+
+
Arbitrary user-defined machine-readable data of this Event Destination.
+
+
+
+
+
An object that encapsulates where and how to send your events.
+
+
+
+
+
URI of the Event Destination API resource.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EventDestination
+
+
+
+Parameters:
+id - Unique identifier for this Event Destination.metadata - Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.createdAt - Timestamp when the Event Destination was created, RFC 3339 format.description - Human-readable description of the Event Destination. Optional, max 255 bytes.format - The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.target - An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.uri - URI of the Event Destination API resource.
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+Unique identifier for this Event Destination.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+getCreatedAt
+
+Timestamp when the Event Destination was created, RFC 3339 format.
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getDescription
+public String getDescription ()
Human-readable description of the Event Destination. Optional, max 255 bytes.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+getTarget
+
+An object that encapsulates where and how to send your events. An event
+ destination must contain exactly one of the following objects, leaving the rest
+ null: kinesis, firehose, cloudwatch_logs,
+ or s3.
+
+Returns:
+the value of the property as a EventTarget
+
+
+
+
+
+getUri
+
+URI of the Event Destination API resource.
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventDestinationList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Pageable
+public class EventDestinationList
+
extends Object
+implements Pageable
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
The list of all Event Destinations on this account.
+
+
+
+
+
URI of the next page, or null if there is no next page.
+
+
+
+
+
URI of the Event Destinations list API resource.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EventDestinationList
+
+
+
+Parameters:
+eventDestinations - The list of all Event Destinations on this account.uri - URI of the Event Destinations list API resource.nextPageUri - URI of the next page, or null if there is no next page.
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getEventDestinations
+
+The list of all Event Destinations on this account.
+
+Returns:
+the value of the property as a List <EventDestination >
+
+
+
+
+
+getUri
+
+URI of the Event Destinations list API resource.
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getNextPageUri
+
+URI of the next page, or null if there is no next page.
+
+Specified by:
+getNextPageUri Pageable Returns:
+the value of the property as a URIOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventSource (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EventSource
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
Type of event for which an event subscription will trigger
+
+
+
+
+
URI of the Event Source API resource.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EventSource
+
+
+
+Parameters:
+type - Type of event for which an event subscription will triggeruri - URI of the Event Source API resource.
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getType
+
+Type of event for which an event subscription will trigger
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getUri
+
+URI of the Event Source API resource.
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventSourceList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EventSourceList
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
The list of all Event Sources for an Event Subscription
+
+
+
+
+
URI of the next page, or null if there is no next page.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EventSourceList
+
+
+
+Parameters:
+sources - The list of all Event Sources for an Event Subscriptionuri - URI of the next page, or null if there is no next page.
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getSources
+
+The list of all Event Sources for an Event Subscription
+
+Returns:
+the value of the property as a List <EventSource >
+
+
+
+
+
+getUri
+
+URI of the next page, or null if there is no next page.
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventSourceReplace.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
Type of event for which an event subscription will trigger
+
+
+
+
+
Type of event for which an event subscription will trigger
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+type
+
+Type of event for which an event subscription will trigger
+
+Parameters:
+type - the value of the type parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+type
+
+Type of event for which an event subscription will trigger
+
+Parameters:
+type - the value of the type parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventSourceReplace (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EventSourceReplace
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
Type of event for which an event subscription will trigger
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getType
+
+Type of event for which an event subscription will trigger
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventStream (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EventStream
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
Timestamp when the Event Stream was created, RFC 3339 format.
+
+
+
+
+
Human-readable description of the Event Stream.
+
+
+
+
+
A list of Event Destination IDs which should be used for this Event Stream.
+
+
+
+
+
The protocol that determines which events will be collected.
+
+
+
+
+
A list of protocol-specific fields you want to collect on each event.
+
+
+
+
+
Unique identifier for this Event Stream.
+
+
+
+
+
Arbitrary user-defined machine-readable data of this Event Stream.
+
+
double
+
+
+
The percentage of all events you would like to capture.
+
+
+
+
+
URI of the Event Stream API resource.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EventStream
+
+
+
+Parameters:
+id - Unique identifier for this Event Stream.uri - URI of the Event Stream API resource.createdAt - Timestamp when the Event Stream was created, RFC 3339 format.metadata - Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes.description - Human-readable description of the Event Stream. Optional, max 255 bytes.fields - A list of protocol-specific fields you want to collect on each event.eventType - The protocol that determines which events will be collected. Supported values are tcp_connection_closed and http_request_complete.destinationIds - A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.samplingRate - The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+Unique identifier for this Event Stream.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getUri
+
+URI of the Event Stream API resource.
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getCreatedAt
+
+Timestamp when the Event Stream was created, RFC 3339 format.
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+
+
+
+getDescription
+public String getDescription ()
Human-readable description of the Event Stream. Optional, max 255 bytes.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getFields
+
+A list of protocol-specific fields you want to collect on each event.
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+getEventType
+
+The protocol that determines which events will be collected. Supported values
+ are tcp_connection_closed and http_request_complete.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getDestinationIds
+
+A list of Event Destination IDs which should be used for this Event Stream.
+ Event Streams are required to have at least one Event Destination.
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+getSamplingRate
+public double getSamplingRate ()
+The percentage of all events you would like to capture. Valid values range from
+ 0.01, representing 1% of all events to 1.00, representing 100% of all events.
+
+Returns:
+the value of the property as a double
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventStreamList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Pageable
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
The list of all Event Streams on this account.
+
+
+
+
+
URI of the next page, or null if there is no next page.
+
+
+
+
+
URI of the Event Stream list API resource.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EventStreamList
+
+
+
+Parameters:
+eventStreams - The list of all Event Streams on this account.uri - URI of the Event Stream list API resource.nextPageUri - URI of the next page, or null if there is no next page.
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getEventStreams
+
+The list of all Event Streams on this account.
+
+Returns:
+the value of the property as a List <EventStream >
+
+
+
+
+
+getUri
+
+URI of the Event Stream list API resource.
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getNextPageUri
+
+URI of the next page, or null if there is no next page.
+
+Specified by:
+getNextPageUri Pageable Returns:
+the value of the property as a URIOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventSubscription (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EventSubscription
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
When the Event Subscription was created (RFC 3339 format).
+
+
+
+
+
Arbitrary customer supplied information intended to be human readable.
+
+
+
+
+
Destinations to which these events will be sent
+
+
+
+
+
Unique identifier for this Event Subscription.
+
+
+
+
+
Arbitrary customer supplied information intended to be machine readable.
+
+
+
+
+
Sources containing the types for which this event subscription will trigger
+
+
+
+
+
URI of the Event Subscription API resource.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EventSubscription
+
+
+
+Parameters:
+id - Unique identifier for this Event Subscription.uri - URI of the Event Subscription API resource.createdAt - When the Event Subscription was created (RFC 3339 format).metadata - Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.description - Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.sources - Sources containing the types for which this event subscription will triggerdestinations - Destinations to which these events will be sent
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+Unique identifier for this Event Subscription.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getUri
+
+URI of the Event Subscription API resource.
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getCreatedAt
+
+When the Event Subscription was created (RFC 3339 format).
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+
+
+
+getDescription
+public String getDescription ()
Arbitrary customer supplied information intended to be human readable. Optional,
+ max 255 chars.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getSources
+
+Sources containing the types for which this event subscription will trigger
+
+Returns:
+the value of the property as a List <EventSource >
+
+
+
+
+
+getDestinations
+
+Destinations to which these events will be sent
+
+Returns:
+the value of the property as a List <Ref >
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventSubscriptionList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Pageable
+public class EventSubscriptionList
+
extends Object
+implements Pageable
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
The list of all Event Subscriptions on this account.
+
+
+
+
+
URI of next page, or null if there is no next page.
+
+
+
+
+
URI of the Event Subscriptions list API resource.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EventSubscriptionList
+
+
+
+Parameters:
+eventSubscriptions - The list of all Event Subscriptions on this account.uri - URI of the Event Subscriptions list API resource.nextPageUri - URI of next page, or null if there is no next page.
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getEventSubscriptions
+
+The list of all Event Subscriptions on this account.
+
+Returns:
+the value of the property as a List <EventSubscription >
+
+
+
+
+
+getUri
+
+URI of the Event Subscriptions list API resource.
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getNextPageUri
+
+URI of next page, or null if there is no next page.
+
+Specified by:
+getNextPageUri Pageable Returns:
+the value of the property as a URIOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventTarget.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EventTarget
+public static class EventTarget.Builder
+
extends Object
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
Configuration used to send events to Amazon CloudWatch Logs.
+
+
+
+
+
Configuration used to send events to Amazon CloudWatch Logs.
+
+
+
+
+
Configuration used to send events to Amazon Kinesis Data Firehose.
+
+
+
+
+
Configuration used to send events to Amazon Kinesis Data Firehose.
+
+
+
+
+
Configuration used to send events to Amazon Kinesis.
+
+
+
+
+
Configuration used to send events to Amazon Kinesis.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+firehose
+
+Configuration used to send events to Amazon Kinesis Data Firehose.
+
+Parameters:
+firehose - the value of the firehose parameter as a EventTargetFirehoseReturns:
+this builder instance
+
+
+
+
+
+firehose
+
+Configuration used to send events to Amazon Kinesis Data Firehose.
+
+Parameters:
+firehose - the value of the firehose parameter as a EventTargetFirehoseOptionalReturns:
+this builder instance
+
+
+
+
+
+kinesis
+
+Configuration used to send events to Amazon Kinesis.
+
+Parameters:
+kinesis - the value of the kinesis parameter as a EventTargetKinesisReturns:
+this builder instance
+
+
+
+
+
+kinesis
+
+Configuration used to send events to Amazon Kinesis.
+
+Parameters:
+kinesis - the value of the kinesis parameter as a EventTargetKinesisOptionalReturns:
+this builder instance
+
+
+
+
+
+cloudwatchLogs
+
+Configuration used to send events to Amazon CloudWatch Logs.
+
+Parameters:
+cloudwatchLogs - the value of the cloudwatch_logs parameter as a EventTargetCloudwatchLogsReturns:
+this builder instance
+
+
+
+
+
+cloudwatchLogs
+
+Configuration used to send events to Amazon CloudWatch Logs.
+
+Parameters:
+cloudwatchLogs - the value of the cloudwatch_logs parameter as a EventTargetCloudwatchLogsOptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventTarget (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EventTarget
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
Configuration used to send events to Amazon CloudWatch Logs.
+
+
+
+
+
Configuration used to send events to Amazon Kinesis Data Firehose.
+
+
+
+
+
Configuration used to send events to Amazon Kinesis.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getFirehose
+
+Configuration used to send events to Amazon Kinesis Data Firehose.
+
+Returns:
+the value of the property as a EventTargetFirehoseOptional
+
+
+
+
+
+getKinesis
+
+Configuration used to send events to Amazon Kinesis.
+
+Returns:
+the value of the property as a EventTargetKinesisOptional
+
+
+
+
+
+getCloudwatchLogs
+
+Configuration used to send events to Amazon CloudWatch Logs.
+
+Returns:
+the value of the property as a EventTargetCloudwatchLogsOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventTargetCloudwatchLogs.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
+
+
+
An Amazon Resource Name specifying the CloudWatch Logs group to deposit events
+ into.
+
+
+
+
+
An Amazon Resource Name specifying the CloudWatch Logs group to deposit events
+ into.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+auth
+
+Configuration for how to authenticate into your AWS account. Exactly one of
+ role or creds should be configured.
+
+Parameters:
+auth - the value of the auth parameter as a AwsAuthReturns:
+this builder instance
+
+
+
+
+
+auth
+
+Configuration for how to authenticate into your AWS account. Exactly one of
+ role or creds should be configured.
+
+Parameters:
+auth - the value of the auth parameter as a AwsAuthOptionalReturns:
+this builder instance
+
+
+
+
+
+logGroupArn
+
+An Amazon Resource Name specifying the CloudWatch Logs group to deposit events
+ into.
+
+Parameters:
+logGroupArn - the value of the log_group_arn parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+logGroupArn
+
+An Amazon Resource Name specifying the CloudWatch Logs group to deposit events
+ into.
+
+Parameters:
+logGroupArn - the value of the log_group_arn parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventTargetCloudwatchLogs (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EventTargetCloudwatchLogs
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
An Amazon Resource Name specifying the CloudWatch Logs group to deposit events
+ into.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getAuth
+
+Configuration for how to authenticate into your AWS account. Exactly one of
+ role or creds should be configured.
+
+Returns:
+the value of the property as a AwsAuth
+
+
+
+
+
+getLogGroupArn
+public String getLogGroupArn ()
An Amazon Resource Name specifying the CloudWatch Logs group to deposit events
+ into.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventTargetFirehose.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
+
+
+
An Amazon Resource Name specifying the Firehose delivery stream to deposit
+ events into.
+
+
+
+
+
An Amazon Resource Name specifying the Firehose delivery stream to deposit
+ events into.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+auth
+
+Configuration for how to authenticate into your AWS account. Exactly one of
+ role or creds should be configured.
+
+Parameters:
+auth - the value of the auth parameter as a AwsAuthReturns:
+this builder instance
+
+
+
+
+
+auth
+
+Configuration for how to authenticate into your AWS account. Exactly one of
+ role or creds should be configured.
+
+Parameters:
+auth - the value of the auth parameter as a AwsAuthOptionalReturns:
+this builder instance
+
+
+
+
+
+deliveryStreamArn
+
+An Amazon Resource Name specifying the Firehose delivery stream to deposit
+ events into.
+
+Parameters:
+deliveryStreamArn - the value of the delivery_stream_arn parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+deliveryStreamArn
+
+An Amazon Resource Name specifying the Firehose delivery stream to deposit
+ events into.
+
+Parameters:
+deliveryStreamArn - the value of the delivery_stream_arn parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventTargetFirehose (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EventTargetFirehose
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
An Amazon Resource Name specifying the Firehose delivery stream to deposit
+ events into.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getAuth
+
+Configuration for how to authenticate into your AWS account. Exactly one of
+ role or creds should be configured.
+
+Returns:
+the value of the property as a AwsAuth
+
+
+
+
+
+getDeliveryStreamArn
+public String getDeliveryStreamArn ()
An Amazon Resource Name specifying the Firehose delivery stream to deposit
+ events into.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventTargetKinesis.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
+
+
+
An Amazon Resource Name specifying the Kinesis stream to deposit events into.
+
+
+
+
+
An Amazon Resource Name specifying the Kinesis stream to deposit events into.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+auth
+
+Configuration for how to authenticate into your AWS account. Exactly one of
+ role or creds should be configured.
+
+Parameters:
+auth - the value of the auth parameter as a AwsAuthReturns:
+this builder instance
+
+
+
+
+
+auth
+
+Configuration for how to authenticate into your AWS account. Exactly one of
+ role or creds should be configured.
+
+Parameters:
+auth - the value of the auth parameter as a AwsAuthOptionalReturns:
+this builder instance
+
+
+
+
+
+streamArn
+
+An Amazon Resource Name specifying the Kinesis stream to deposit events into.
+
+Parameters:
+streamArn - the value of the stream_arn parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+streamArn
+
+An Amazon Resource Name specifying the Kinesis stream to deposit events into.
+
+Parameters:
+streamArn - the value of the stream_arn parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventTargetKinesis (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EventTargetKinesis
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
An Amazon Resource Name specifying the Kinesis stream to deposit events into.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getAuth
+
+Configuration for how to authenticate into your AWS account. Exactly one of
+ role or creds should be configured.
+
+Returns:
+the value of the property as a AwsAuth
+
+
+
+
+
+getStreamArn
+
+An Amazon Resource Name specifying the Kinesis stream to deposit events into.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
IpPolicy (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class IpPolicy
+
extends Object A class encapsulating the
IpPolicy resource.
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
+
+
+
timestamp when the IP policy was created, RFC 3339 format
+
+
+
+
+
human-readable description of the source IPs of this IP policy.
+
+
+
+
+
unique identifier for this IP policy
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP policy.
+
+
+
+
+
URI of the IP Policy API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+IpPolicy
+
+
+
+Parameters:
+id - unique identifier for this IP policyuri - URI of the IP Policy API resourcecreatedAt - timestamp when the IP policy was created, RFC 3339 formatdescription - human-readable description of the source IPs of this IP policy. optional, max 255 bytes.metadata - arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.action - the IP policy action. Supported values are allow or deny
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+unique identifier for this IP policy
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getUri
+
+URI of the IP Policy API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getCreatedAt
+
+timestamp when the IP policy was created, RFC 3339 format
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getDescription
+public String getDescription ()
human-readable description of the source IPs of this IP policy. optional, max
+ 255 bytes.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+getAction
+
+the IP policy action. Supported values are allow or
+ deny
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
IpPolicyList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Pageable
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
the list of all IP policies on this account
+
+
+
+
+
URI of the next page, or null if there is no next page
+
+
+
+
+
URI of the IP policy list API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+IpPolicyList
+
+
+
+Parameters:
+ipPolicies - the list of all IP policies on this accounturi - URI of the IP policy list API resourcenextPageUri - URI of the next page, or null if there is no next page
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getIpPolicies
+
+the list of all IP policies on this account
+
+Returns:
+the value of the property as a List <IpPolicy >
+
+
+
+
+
+getUri
+
+URI of the IP policy list API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getNextPageUri
+
+URI of the next page, or null if there is no next page
+
+Specified by:
+getNextPageUri Pageable Returns:
+the value of the property as a URIOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
IpPolicyRule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class IpPolicyRule
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
an IP or IP range specified in CIDR notation.
+
+
+
+
+
timestamp when the IP policy rule was created, RFC 3339 format
+
+
+
+
+
human-readable description of the source IPs of this IP rule.
+
+
+
+
+
unique identifier for this IP policy rule
+
+
+
+
+
object describing the IP policy this IP Policy Rule belongs to
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP policy rule.
+
+
+
+
+
URI of the IP policy rule API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+IpPolicyRule
+
+
+
+Parameters:
+id - unique identifier for this IP policy ruleuri - URI of the IP policy rule API resourcecreatedAt - timestamp when the IP policy rule was created, RFC 3339 formatdescription - human-readable description of the source IPs of this IP rule. optional, max 255 bytes.metadata - arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.cidr - an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.ipPolicy - object describing the IP policy this IP Policy Rule belongs to
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+unique identifier for this IP policy rule
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getUri
+
+URI of the IP policy rule API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getCreatedAt
+
+timestamp when the IP policy rule was created, RFC 3339 format
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getDescription
+public String getDescription ()
human-readable description of the source IPs of this IP rule. optional, max 255
+ bytes.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+getCidr
+
+an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getIpPolicy
+
+object describing the IP policy this IP Policy Rule belongs to
+
+Returns:
+the value of the property as a Ref
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
IpPolicyRuleList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Pageable
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
the list of all IP policy rules on this account
+
+
+
+
+
URI of the next page, or null if there is no next page
+
+
+
+
+
URI of the IP policy rule list API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+IpPolicyRuleList
+
+
+
+Parameters:
+ipPolicyRules - the list of all IP policy rules on this accounturi - URI of the IP policy rule list API resourcenextPageUri - URI of the next page, or null if there is no next page
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getIpPolicyRules
+
+the list of all IP policy rules on this account
+
+Returns:
+the value of the property as a List <IpPolicyRule >
+
+
+
+
+
+getUri
+
+URI of the IP policy rule list API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getNextPageUri
+
+URI of the next page, or null if there is no next page
+
+Specified by:
+getNextPageUri Pageable Returns:
+the value of the property as a URIOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
IpRestriction (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class IpRestriction
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
timestamp when the IP restriction was created, RFC 3339 format
+
+
+
+
+
human-readable description of this IP restriction.
+
+
boolean
+
+
+
true if the IP restriction will be enforced.
+
+
+
+
+
unique identifier for this IP restriction
+
+
+
+
+
the set of IP policies that are used to enforce the restriction
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP restriction.
+
+
+
+
+
the type of IP restriction.
+
+
+
+
+
URI of the IP restriction API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+IpRestriction
+
+
+
+Parameters:
+id - unique identifier for this IP restrictionuri - URI of the IP restriction API resourcecreatedAt - timestamp when the IP restriction was created, RFC 3339 formatdescription - human-readable description of this IP restriction. optional, max 255 bytes.metadata - arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.enforced - true if the IP restriction will be enforced. if false, only warnings will be issuedtype - the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: dashboard, api, agent, and endpointsipPolicies - the set of IP policies that are used to enforce the restriction
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+unique identifier for this IP restriction
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getUri
+
+URI of the IP restriction API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getCreatedAt
+
+timestamp when the IP restriction was created, RFC 3339 format
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getDescription
+public String getDescription ()
human-readable description of this IP restriction. optional, max 255 bytes.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+getEnforced
+public boolean getEnforced ()
+true if the IP restriction will be enforced. if false, only warnings will be
+ issued
+
+Returns:
+the value of the property as a boolean
+
+
+
+
+
+getType
+
+the type of IP restriction. this defines what traffic will be restricted with
+ the attached policies. four values are currently supported:
+ dashboard, api, agent, and
+ endpoints
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getIpPolicies
+
+the set of IP policies that are used to enforce the restriction
+
+Returns:
+the value of the property as a List <Ref >
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
IpRestrictionList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Pageable
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
the list of all IP restrictions on this account
+
+
+
+
+
URI of the next page, or null if there is no next page
+
+
+
+
+
URI of the IP resrtrictions list API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+IpRestrictionList
+
+
+
+Parameters:
+ipRestrictions - the list of all IP restrictions on this accounturi - URI of the IP resrtrictions list API resourcenextPageUri - URI of the next page, or null if there is no next page
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getIpRestrictions
+
+the list of all IP restrictions on this account
+
+Returns:
+the value of the property as a List <IpRestriction >
+
+
+
+
+
+getUri
+
+URI of the IP resrtrictions list API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getNextPageUri
+
+URI of the next page, or null if there is no next page
+
+Specified by:
+getNextPageUri Pageable Returns:
+the value of the property as a URIOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NgrokApiError (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new API error.
+
+
+
+
Creates a new API error.
+
+
+
+
Creates a new API error.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Fetches any further details about the error.
+
+
+
+
+
Fetches the ngrok API error code, if any.
+
+
int
+
+
+
Fetches the HTTP status code.
+
+
boolean
+
+
+
Checks if this error object contains one of the provided codes.
+
+
+
+
+
Methods inherited from class java.lang.Throwable
+
addSuppressed , fillInStackTrace , getCause , getLocalizedMessage , getMessage , getStackTrace , getSuppressed , initCause , printStackTrace , printStackTrace , printStackTrace , setStackTrace , toString
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+NgrokApiError
+
+Creates a new API error.
+
+Parameters:
+message - informative messagehttpStatusCode - HTTP response statuserrorCode - ngrok API error codedetails - arbitrary error details
+
+
+
+
+NgrokApiError
+
+Creates a new API error.
+
+Parameters:
+httpStatusCode - HTTP response statusresponseBody - possible response bodycause - exception cause
+
+
+
+
+NgrokApiError
+public NgrokApiError (int httpStatusCode)
+Creates a new API error.
+
+Parameters:
+httpStatusCode - HTTP response status
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getHttpStatusCode
+public int getHttpStatusCode ()
+Fetches the HTTP status code.
+
+Returns:
+HTTP response status
+
+
+
+
+
+getErrorCode
+
+Fetches the ngrok API error code, if any.
+
+Returns:
+ngrok API error code
+
+
+
+
+
+getDetails
+
+Fetches any further details about the error.
+
+Returns:
+key-value map containing error details
+
+
+
+
+
+isErrorCode
+public boolean isErrorCode
(String ... codes) Checks if this error object contains one of the provided codes.
+
+Parameters:
+codes - error codes to checkReturns:
+whether or not one of the codes matches what is in this error object
+
+
+
+
+
+
+
+
+
+
+
+
+
Page (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+Wrapper class that holds a single page of a
Pageable response.
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Returns the current response page.
+
+
+
+
+
Fetches the next page of responses, if any.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+Page
+
+Create a new page.
+
+Parameters:
+apiClient - the API client used to fetch the pagepage - the page itself
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getPage
+
+Returns the current response page.
+
+Returns:
+a page
+
+
+
+
+
+next
+
+Fetches the next page of responses, if any.
+
+Returns:
+a future encapsulating a possible next page
+
+
+
+
+
+
+
+
+
+
+
+
+
Pageable (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+All Known Implementing Classes:
+AgentIngressList ApiKeyList CertificateAuthorityList CredentialList EndpointConfigurationList EventDestinationList EventStreamList EventSubscriptionList IpPolicyList IpPolicyRuleList IpRestrictionList ReservedAddrList ReservedDomainList SshCertificateAuthorityList SshCredentialList SshHostCertificateList SshUserCertificateList TlsCertificateList TunnelList TunnelSessionList
+public interface Pageable
+Interface indicating a resource type that can have more than one page of responses.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Abstract Methods
+
+
+
+
+
+
+
+
+
Fetches the URI of the next page.
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getNextPageUri
+
+Fetches the URI of the next page.
+
+Returns:
+a URI
+
+
+
+
+
+
+
+
+
+
+
+
+
Ref (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class Ref
+
extends Object A class encapsulating the
Ref resource.
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new instance of
Ref.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
+
+
+
a uri for locating a resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+Ref
+
+Creates a new instance of
Ref.
+Parameters:
+id - a resource identifieruri - a uri for locating a resource
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+a resource identifier
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getUri
+
+a uri for locating a resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
ReservedAddr (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class ReservedAddr
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
hostname:port of the reserved address that was assigned at creation time
+
+
+
+
+
timestamp when the reserved address was created, RFC 3339 format
+
+
+
+
+
human-readable description of what this reserved address will be used for
+
+
+
+
+
object reference to the endpoint configuration that will be applied to traffic
+ to this address
+
+
+
+
+
unique reserved address resource identifier
+
+
+
+
+
arbitrary user-defined machine-readable data of this reserved address.
+
+
+
+
+
reserve the address in this geographic ngrok datacenter.
+
+
+
+
+
URI of the reserved address API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+ReservedAddr
+
+
+
+Parameters:
+id - unique reserved address resource identifieruri - URI of the reserved address API resourcecreatedAt - timestamp when the reserved address was created, RFC 3339 formatdescription - human-readable description of what this reserved address will be used formetadata - arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.addr - hostname:port of the reserved address that was assigned at creation timeregion - reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)endpointConfiguration - object reference to the endpoint configuration that will be applied to traffic to this address
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+unique reserved address resource identifier
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getUri
+
+URI of the reserved address API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getCreatedAt
+
+timestamp when the reserved address was created, RFC 3339 format
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getDescription
+public String getDescription ()
human-readable description of what this reserved address will be used for
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+getAddr
+
+hostname:port of the reserved address that was assigned at creation time
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getRegion
+
+reserve the address in this geographic ngrok datacenter. Optional, default is
+ us. (au, eu, ap, us, jp, in, sa)
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getEndpointConfiguration
+
+object reference to the endpoint configuration that will be applied to traffic
+ to this address
+
+Returns:
+the value of the property as a RefOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
ReservedAddrList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Pageable
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
URI of the next page, or null if there is no next page
+
+
+
+
+
the list of all reserved addresses on this account
+
+
+
+
+
URI of the reserved address list API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+ReservedAddrList
+
+
+
+Parameters:
+reservedAddrs - the list of all reserved addresses on this accounturi - URI of the reserved address list API resourcenextPageUri - URI of the next page, or null if there is no next page
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getReservedAddrs
+
+the list of all reserved addresses on this account
+
+Returns:
+the value of the property as a List <ReservedAddr >
+
+
+
+
+
+getUri
+
+URI of the reserved address list API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getNextPageUri
+
+URI of the next page, or null if there is no next page
+
+Specified by:
+getNextPageUri Pageable Returns:
+the value of the property as a URIOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
ReservedDomain (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class ReservedDomain
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
ReservedDomain String id,
+ URI uri,
+ OffsetDateTime createdAt,
+ String description,
+ String metadata,
+ String domain,
+ String region,
+ Optional <String > cnameTarget,
+ Optional <Ref > httpEndpointConfiguration,
+ Optional <Ref > httpsEndpointConfiguration,
+ Optional <Ref > certificate,
+ Optional <ReservedDomainCertPolicy > certificateManagementPolicy,
+ Optional <ReservedDomainCertStatus > certificateManagementStatus,
+ Optional <String > acmeChallengeCnameTarget)
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
DNS CNAME target for the host _acme-challenge.example.com, where example.com is
+ your reserved domain name.
+
+
+
+
+
object referencing the TLS certificate used for connections to this domain.
+
+
+
+
+
configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled
+
+
+
+
+
status of the automatic certificate management for this domain, or null if
+ automatic management is disabled
+
+
+
+
+
DNS CNAME target for a custom hostname, or null if the reserved domain is a
+ subdomain of *.ngrok.io
+
+
+
+
+
timestamp when the reserved domain was created, RFC 3339 format
+
+
+
+
+
human-readable description of what this reserved domain will be used for
+
+
+
+
+
hostname of the reserved domain
+
+
+
+
+
object referencing the endpoint configuration applied to http traffic on this
+ domain
+
+
+
+
+
object referencing the endpoint configuration applied to https traffic on this
+ domain
+
+
+
+
+
unique reserved domain resource identifier
+
+
+
+
+
arbitrary user-defined machine-readable data of this reserved domain.
+
+
+
+
+
reserve the domain in this geographic ngrok datacenter.
+
+
+
+
+
URI of the reserved domain API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+ReservedDomain
+public ReservedDomain
(String id,
+ URI uri,
+ OffsetDateTime createdAt,
+ String description,
+ String metadata,
+ String domain,
+ String region,
+ Optional <String > cnameTarget,
+ Optional <Ref > httpEndpointConfiguration,
+ Optional <Ref > httpsEndpointConfiguration,
+ Optional <Ref > certificate,
+ Optional <ReservedDomainCertPolicy > certificateManagementPolicy,
+ Optional <ReservedDomainCertStatus > certificateManagementStatus,
+ Optional <String > acmeChallengeCnameTarget)
+Parameters:
+id - unique reserved domain resource identifieruri - URI of the reserved domain API resourcecreatedAt - timestamp when the reserved domain was created, RFC 3339 formatdescription - human-readable description of what this reserved domain will be used formetadata - arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.domain - hostname of the reserved domainregion - reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)cnameTarget - DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.iohttpEndpointConfiguration - object referencing the endpoint configuration applied to http traffic on this domainhttpsEndpointConfiguration - object referencing the endpoint configuration applied to https traffic on this domaincertificate - object referencing the TLS certificate used for connections to this domain. This can be either a user-uploaded certificate, the most recently issued automatic one, or null otherwise.certificateManagementPolicy - configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabledcertificateManagementStatus - status of the automatic certificate management for this domain, or null if automatic management is disabledacmeChallengeCnameTarget - DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+unique reserved domain resource identifier
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getUri
+
+URI of the reserved domain API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getCreatedAt
+
+timestamp when the reserved domain was created, RFC 3339 format
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getDescription
+public String getDescription ()
human-readable description of what this reserved domain will be used for
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+getDomain
+
+hostname of the reserved domain
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getRegion
+
+reserve the domain in this geographic ngrok datacenter. Optional, default is us.
+ (au, eu, ap, us, jp, in, sa)
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+getHttpEndpointConfiguration
+
+object referencing the endpoint configuration applied to http traffic on this
+ domain
+
+Returns:
+the value of the property as a RefOptional
+
+
+
+
+
+getHttpsEndpointConfiguration
+
+object referencing the endpoint configuration applied to https traffic on this
+ domain
+
+Returns:
+the value of the property as a RefOptional
+
+
+
+
+
+getCertificate
+
+object referencing the TLS certificate used for connections to this domain. This
+ can be either a user-uploaded certificate, the most recently issued automatic
+ one, or null otherwise.
+
+Returns:
+the value of the property as a RefOptional
+
+
+
+
+
+getCertificateManagementPolicy
+
+configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled
+
+Returns:
+the value of the property as a ReservedDomainCertPolicyOptional
+
+
+
+
+
+getCertificateManagementStatus
+
+status of the automatic certificate management for this domain, or null if
+ automatic management is disabled
+
+Returns:
+the value of the property as a ReservedDomainCertStatusOptional
+
+
+
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
ReservedDomainCertJob (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class ReservedDomainCertJob
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
if present, an error code indicating why provisioning is failing.
+
+
+
+
+
a message describing the current status or error
+
+
+
+
+
timestamp when the provisioning job will be retried
+
+
+
+
+
timestamp when the provisioning job started, RFC 3339 format
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+ReservedDomainCertJob
+
+
+
+Parameters:
+errorCode - if present, an error code indicating why provisioning is failing. It may be either a temporary condition (INTERNAL_ERROR), or a permanent one the user must correct (DNS_ERROR).msg - a message describing the current status or errorstartedAt - timestamp when the provisioning job started, RFC 3339 formatretriesAt - timestamp when the provisioning job will be retried
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getErrorCode
+
+if present, an error code indicating why provisioning is failing. It may be
+ either a temporary condition (INTERNAL_ERROR), or a permanent one the user must
+ correct (DNS_ERROR).
+
+Returns:
+the value of the property as a StringOptional
+
+
+
+
+
+getMsg
+
+a message describing the current status or error
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getStartedAt
+
+timestamp when the provisioning job started, RFC 3339 format
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getRetriesAt
+
+timestamp when the provisioning job will be retried
+
+Returns:
+the value of the property as a OffsetDateTimeOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
ReservedDomainCertPolicy.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
certificate authority to request certificates from.
+
+
+
+
+
certificate authority to request certificates from.
+
+
+
+
+
+
+
+
type of private key to use when requesting certificates.
+
+
+
+
+
type of private key to use when requesting certificates.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+authority
+
+certificate authority to request certificates from. The only supported value is
+ letsencrypt.
+
+Parameters:
+authority - the value of the authority parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+authority
+
+certificate authority to request certificates from. The only supported value is
+ letsencrypt.
+
+Parameters:
+authority - the value of the authority parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+privateKeyType
+
+type of private key to use when requesting certificates. Defaults to rsa, can be
+ either rsa or ecdsa.
+
+Parameters:
+privateKeyType - the value of the private_key_type parameter as a StringReturns:
+this builder instance
+
+
+
+
+
+privateKeyType
+
+type of private key to use when requesting certificates. Defaults to rsa, can be
+ either rsa or ecdsa.
+
+Parameters:
+privateKeyType - the value of the private_key_type parameter as a StringOptionalReturns:
+this builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
ReservedDomainCertPolicy (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class ReservedDomainCertPolicy
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
static class
+
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
certificate authority to request certificates from.
+
+
+
+
+
type of private key to use when requesting certificates.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+getAuthority
+
+certificate authority to request certificates from. The only supported value is
+ letsencrypt.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getPrivateKeyType
+public String getPrivateKeyType ()
type of private key to use when requesting certificates. Defaults to rsa, can be
+ either rsa or ecdsa.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
ReservedDomainCertStatus (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class ReservedDomainCertStatus
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
status of the certificate provisioning job, or null if the certificiate isn't
+ being provisioned or renewed
+
+
+
+
+
timestamp when the next renewal will be requested, RFC 3339 format
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+ReservedDomainCertStatus
+
+
+
+Parameters:
+renewsAt - timestamp when the next renewal will be requested, RFC 3339 formatprovisioningJob - status of the certificate provisioning job, or null if the certificiate isn't being provisioned or renewed
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getRenewsAt
+
+timestamp when the next renewal will be requested, RFC 3339 format
+
+Returns:
+the value of the property as a OffsetDateTimeOptional
+
+
+
+
+
+getProvisioningJob
+
+status of the certificate provisioning job, or null if the certificiate isn't
+ being provisioned or renewed
+
+Returns:
+the value of the property as a ReservedDomainCertJobOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
ReservedDomainList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Pageable
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
URI of the next page, or null if there is no next page
+
+
+
+
+
the list of all reserved domains on this account
+
+
+
+
+
URI of the reserved domain list API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+ReservedDomainList
+
+
+
+Parameters:
+reservedDomains - the list of all reserved domains on this accounturi - URI of the reserved domain list API resourcenextPageUri - URI of the next page, or null if there is no next page
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getReservedDomains
+
+the list of all reserved domains on this account
+
+Returns:
+the value of the property as a List <ReservedDomain >
+
+
+
+
+
+getUri
+
+URI of the reserved domain list API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getNextPageUri
+
+URI of the next page, or null if there is no next page
+
+Specified by:
+getNextPageUri Pageable Returns:
+the value of the property as a URIOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SshCertificateAuthority (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class SshCertificateAuthority
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
timestamp when the SSH Certificate Authority API resource was created, RFC 3339
+ format
+
+
+
+
+
human-readable description of this SSH Certificate Authority.
+
+
+
+
+
unique identifier for this SSH Certificate Authority
+
+
+
+
+
the type of private key for this SSH Certificate Authority
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH Certificate Authority.
+
+
+
+
+
raw public key for this SSH Certificate Authority
+
+
+
+
+
URI of the SSH Certificate Authority API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+SshCertificateAuthority
+
+
+
+Parameters:
+id - unique identifier for this SSH Certificate Authorityuri - URI of the SSH Certificate Authority API resourcecreatedAt - timestamp when the SSH Certificate Authority API resource was created, RFC 3339 formatdescription - human-readable description of this SSH Certificate Authority. optional, max 255 bytes.metadata - arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.publicKey - raw public key for this SSH Certificate AuthoritykeyType - the type of private key for this SSH Certificate Authority
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+unique identifier for this SSH Certificate Authority
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getUri
+
+URI of the SSH Certificate Authority API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getCreatedAt
+
+timestamp when the SSH Certificate Authority API resource was created, RFC 3339
+ format
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getDescription
+public String getDescription ()
human-readable description of this SSH Certificate Authority. optional, max 255
+ bytes.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+getPublicKey
+
+raw public key for this SSH Certificate Authority
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getKeyType
+
+the type of private key for this SSH Certificate Authority
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SshCertificateAuthorityList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Pageable
+public class SshCertificateAuthorityList
+
extends Object
+implements Pageable
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
URI of the next page, or null if there is no next page
+
+
+
+
+
the list of all certificate authorities on this account
+
+
+
+
+
URI of the certificates authorities list API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+SshCertificateAuthorityList
+
+
+
+Parameters:
+sshCertificateAuthorities - the list of all certificate authorities on this accounturi - URI of the certificates authorities list API resourcenextPageUri - URI of the next page, or null if there is no next page
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getSshCertificateAuthorities
+
+the list of all certificate authorities on this account
+
+Returns:
+the value of the property as a List <SshCertificateAuthority >
+
+
+
+
+
+getUri
+
+URI of the certificates authorities list API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getNextPageUri
+
+URI of the next page, or null if there is no next page
+
+Specified by:
+getNextPageUri Pageable Returns:
+the value of the property as a URIOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SshCredential (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class SshCredential
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
optional list of ACL rules.
+
+
+
+
+
timestamp when the ssh credential was created, RFC 3339 format
+
+
+
+
+
human-readable description of who or what will use the ssh credential to
+ authenticate.
+
+
+
+
+
unique ssh credential resource identifier
+
+
+
+
+
arbitrary user-defined machine-readable data of this ssh credential.
+
+
+
+
+
the PEM-encoded public key of the SSH keypair that will be used to authenticate
+
+
+
+
+
URI of the ssh credential API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+SshCredential
+
+
+
+Parameters:
+id - unique ssh credential resource identifieruri - URI of the ssh credential API resourcecreatedAt - timestamp when the ssh credential was created, RFC 3339 formatdescription - human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.metadata - arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.publicKey - the PEM-encoded public key of the SSH keypair that will be used to authenticateacl - optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the bind rule. The bind 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 bind:example.ngrok.io. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of bind:*.example.com which will allow x.example.com, y.example.com, *.example.com, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+unique ssh credential resource identifier
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getUri
+
+URI of the ssh credential API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getCreatedAt
+
+timestamp when the ssh credential was created, RFC 3339 format
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getDescription
+public String getDescription ()
human-readable description of who or what will use the ssh credential to
+ authenticate. Optional, max 255 bytes.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+getPublicKey
+
+the PEM-encoded public key of the SSH keypair that will be used to authenticate
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getAcl
+
+optional list of ACL rules. If unspecified, the credential will have no
+ restrictions. The only allowed ACL rule at this time is the bind
+ rule. The bind 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
+ bind:example.ngrok.io. Bind rules may specify a leading wildcard to
+ match multiple domains with a common suffix. For example, you may specify a rule
+ of bind:*.example.com which will allow x.example.com,
+ y.example.com, *.example.com, etc. A rule of
+ '*' is equivalent to no acl at all and will explicitly permit all
+ actions.
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SshCredentialList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Pageable
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
URI of the next page, or null if there is no next page
+
+
+
+
+
the list of all ssh credentials on this account
+
+
+
+
+
URI of the ssh credential list API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+SshCredentialList
+
+
+
+Parameters:
+sshCredentials - the list of all ssh credentials on this accounturi - URI of the ssh credential list API resourcenextPageUri - URI of the next page, or null if there is no next page
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getSshCredentials
+
+the list of all ssh credentials on this account
+
+Returns:
+the value of the property as a List <SshCredential >
+
+
+
+
+
+getUri
+
+URI of the ssh credential list API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getNextPageUri
+
+URI of the next page, or null if there is no next page
+
+Specified by:
+getNextPageUri Pageable Returns:
+the value of the property as a URIOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SshHostCertificate (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class SshHostCertificate
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
SshHostCertificate String id,
+ URI uri,
+ OffsetDateTime createdAt,
+ String description,
+ String metadata,
+ String publicKey,
+ String keyType,
+ String sshCertificateAuthorityId,
+ List <String > principals,
+ OffsetDateTime validAfter,
+ OffsetDateTime validUntil,
+ String certificate)
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
the signed SSH certificate in OpenSSH Authorized Keys format.
+
+
+
+
+
timestamp when the SSH Host Certificate API resource was created, RFC 3339
+ format
+
+
+
+
+
human-readable description of this SSH Host Certificate.
+
+
+
+
+
unique identifier for this SSH Host Certificate
+
+
+
+
+
the key type of the public_key, one of rsa,
+ ecdsa or ed25519
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH Host Certificate.
+
+
+
+
+
the list of principals included in the ssh host certificate.
+
+
+
+
+
a public key in OpenSSH Authorized Keys format that this certificate signs
+
+
+
+
+
the ssh certificate authority that is used to sign this ssh host certificate
+
+
+
+
+
URI of the SSH Host Certificate API resource
+
+
+
+
+
the time when the ssh host certificate becomes valid, in RFC 3339 format.
+
+
+
+
+
the time after which the ssh host certificate becomes invalid, in RFC 3339
+ format.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+SshHostCertificate
+public SshHostCertificate
(String id,
+ URI uri,
+ OffsetDateTime createdAt,
+ String description,
+ String metadata,
+ String publicKey,
+ String keyType,
+ String sshCertificateAuthorityId,
+ List <String > principals,
+ OffsetDateTime validAfter,
+ OffsetDateTime validUntil,
+ String certificate)
+Parameters:
+id - unique identifier for this SSH Host Certificateuri - URI of the SSH Host Certificate API resourcecreatedAt - timestamp when the SSH Host Certificate API resource was created, RFC 3339 formatdescription - human-readable description of this SSH Host Certificate. optional, max 255 bytes.metadata - arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.publicKey - a public key in OpenSSH Authorized Keys format that this certificate signskeyType - the key type of the public_key, one of rsa, ecdsa or ed25519sshCertificateAuthorityId - the ssh certificate authority that is used to sign this ssh host certificateprincipals - the list of principals included in the ssh host certificate. This is the list of hostnames and/or IP addresses that are authorized to serve SSH traffic with this certificate. Dangerously, if no principals are specified, this certificate is considered valid for all hosts.validAfter - the time when the ssh host certificate becomes valid, in RFC 3339 format.validUntil - the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.certificate - the signed SSH certificate in OpenSSH Authorized Keys format. this value should be placed in a -cert.pub certificate file on disk that should be referenced in your sshd_config configuration file with a HostCertificate directive
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+unique identifier for this SSH Host Certificate
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getUri
+
+URI of the SSH Host Certificate API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getCreatedAt
+
+timestamp when the SSH Host Certificate API resource was created, RFC 3339
+ format
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getDescription
+public String getDescription ()
human-readable description of this SSH Host Certificate. optional, max 255
+ bytes.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+getPublicKey
+
+a public key in OpenSSH Authorized Keys format that this certificate signs
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getKeyType
+
+the key type of the public_key, one of rsa,
+ ecdsa or ed25519
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getSshCertificateAuthorityId
+public String getSshCertificateAuthorityId ()
the ssh certificate authority that is used to sign this ssh host certificate
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getPrincipals
+
+the list of principals included in the ssh host certificate. This is the list of
+ hostnames and/or IP addresses that are authorized to serve SSH traffic with this
+ certificate. Dangerously, if no principals are specified, this certificate is
+ considered valid for all hosts.
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+getValidAfter
+
+the time when the ssh host certificate becomes valid, in RFC 3339 format.
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getValidUntil
+
+the time after which the ssh host certificate becomes invalid, in RFC 3339
+ format. the OpenSSH certificates RFC calls this valid_before.
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getCertificate
+public String getCertificate ()
the signed SSH certificate in OpenSSH Authorized Keys format. this value should
+ be placed in a -cert.pub certificate file on disk that should be
+ referenced in your sshd_config configuration file with a
+ HostCertificate directive
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SshHostCertificateList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Pageable
+public class SshHostCertificateList
+
extends Object
+implements Pageable
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
URI of the next page, or null if there is no next page
+
+
+
+
+
the list of all ssh host certificates on this account
+
+
+
+
+
URI of the ssh host certificates list API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+SshHostCertificateList
+
+
+
+Parameters:
+sshHostCertificates - the list of all ssh host certificates on this accounturi - URI of the ssh host certificates list API resourcenextPageUri - URI of the next page, or null if there is no next page
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getSshHostCertificates
+
+the list of all ssh host certificates on this account
+
+Returns:
+the value of the property as a List <SshHostCertificate >
+
+
+
+
+
+getUri
+
+URI of the ssh host certificates list API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getNextPageUri
+
+URI of the next page, or null if there is no next page
+
+Specified by:
+getNextPageUri Pageable Returns:
+the value of the property as a URIOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SshUserCertificate (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class SshUserCertificate
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
SshUserCertificate String id,
+ URI uri,
+ OffsetDateTime createdAt,
+ String description,
+ String metadata,
+ String publicKey,
+ String keyType,
+ String sshCertificateAuthorityId,
+ List <String > principals,
+ Map <String ,String > criticalOptions,
+ Map <String ,String > extensions,
+ OffsetDateTime validAfter,
+ OffsetDateTime validUntil,
+ String certificate)
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
the signed SSH certificate in OpenSSH Authorized Keys Format.
+
+
+
+
+
timestamp when the SSH User Certificate API resource was created, RFC 3339
+ format
+
+
+
+
+
A map of critical options included in the certificate.
+
+
+
+
+
human-readable description of this SSH User Certificate.
+
+
+
+
+
A map of extensions included in the certificate.
+
+
+
+
+
unique identifier for this SSH User Certificate
+
+
+
+
+
the key type of the public_key, one of rsa,
+ ecdsa or ed25519
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH User Certificate.
+
+
+
+
+
the list of principals included in the ssh user certificate.
+
+
+
+
+
a public key in OpenSSH Authorized Keys format that this certificate signs
+
+
+
+
+
the ssh certificate authority that is used to sign this ssh user certificate
+
+
+
+
+
URI of the SSH User Certificate API resource
+
+
+
+
+
the time when the ssh host certificate becomes valid, in RFC 3339 format.
+
+
+
+
+
the time after which the ssh host certificate becomes invalid, in RFC 3339
+ format.
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+SshUserCertificate
+public SshUserCertificate
(String id,
+ URI uri,
+ OffsetDateTime createdAt,
+ String description,
+ String metadata,
+ String publicKey,
+ String keyType,
+ String sshCertificateAuthorityId,
+ List <String > principals,
+ Map <String ,String > criticalOptions,
+ Map <String ,String > extensions,
+ OffsetDateTime validAfter,
+ OffsetDateTime validUntil,
+ String certificate)
+Parameters:
+id - unique identifier for this SSH User Certificateuri - URI of the SSH User Certificate API resourcecreatedAt - timestamp when the SSH User Certificate API resource was created, RFC 3339 formatdescription - human-readable description of this SSH User Certificate. optional, max 255 bytes.metadata - arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.publicKey - a public key in OpenSSH Authorized Keys format that this certificate signskeyType - the key type of the public_key, one of rsa, ecdsa or ed25519sshCertificateAuthorityId - the ssh certificate authority that is used to sign this ssh user certificateprincipals - the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizinig the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.criticalOptions - A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec for additional details.extensions - A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec for additional details.validAfter - the time when the ssh host certificate becomes valid, in RFC 3339 format.validUntil - the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.certificate - the signed SSH certificate in OpenSSH Authorized Keys Format. this value should be placed in a -cert.pub certificate file on disk that should be referenced in your sshd_config configuration file with a HostCertificate directive
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+unique identifier for this SSH User Certificate
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getUri
+
+URI of the SSH User Certificate API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getCreatedAt
+
+timestamp when the SSH User Certificate API resource was created, RFC 3339
+ format
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getDescription
+public String getDescription ()
human-readable description of this SSH User Certificate. optional, max 255
+ bytes.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+getPublicKey
+
+a public key in OpenSSH Authorized Keys format that this certificate signs
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getKeyType
+
+the key type of the public_key, one of rsa,
+ ecdsa or ed25519
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getSshCertificateAuthorityId
+public String getSshCertificateAuthorityId ()
the ssh certificate authority that is used to sign this ssh user certificate
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getPrincipals
+
+the list of principals included in the ssh user certificate. This is the list of
+ usernames that the certificate holder may sign in as on a machine authorizinig
+ the signing certificate authority. Dangerously, if no principals are specified,
+ this certificate may be used to log in as any user.
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+getCriticalOptions
+
+A map of critical options included in the certificate. Only two critical options
+ are currently defined by OpenSSH:
force-command and
+
source-address. See
the
+ OpenSSH certificate protocol spec for additional details.
+Returns:
+the value of the property as a Map <String ,String >
+
+
+
+
+
+getExtensions
+
+A map of extensions included in the certificate. Extensions are additional
+ metadata that can be interpreted by the SSH server for any purpose. These can be
+ used to permit or deny the ability to open a terminal, do port forwarding, x11
+ forwarding, and more. If unspecified, the certificate will include limited
+ permissions with the following extension map:
{"permit-pty": "",
+ "permit-user-rc": ""} OpenSSH understands a number of predefined
+ extensions. See
the
+ OpenSSH certificate protocol spec for additional details.
+Returns:
+the value of the property as a Map <String ,String >
+
+
+
+
+
+getValidAfter
+
+the time when the ssh host certificate becomes valid, in RFC 3339 format.
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getValidUntil
+
+the time after which the ssh host certificate becomes invalid, in RFC 3339
+ format. the OpenSSH certificates RFC calls this valid_before.
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getCertificate
+public String getCertificate ()
the signed SSH certificate in OpenSSH Authorized Keys Format. this value should
+ be placed in a -cert.pub certificate file on disk that should be
+ referenced in your sshd_config configuration file with a
+ HostCertificate directive
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SshUserCertificateList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Pageable
+public class SshUserCertificateList
+
extends Object
+implements Pageable
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
URI of the next page, or null if there is no next page
+
+
+
+
+
the list of all ssh user certificates on this account
+
+
+
+
+
URI of the ssh user certificates list API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+SshUserCertificateList
+
+
+
+Parameters:
+sshUserCertificates - the list of all ssh user certificates on this accounturi - URI of the ssh user certificates list API resourcenextPageUri - URI of the next page, or null if there is no next page
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getSshUserCertificates
+
+the list of all ssh user certificates on this account
+
+Returns:
+the value of the property as a List <SshUserCertificate >
+
+
+
+
+
+getUri
+
+URI of the ssh user certificates list API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getNextPageUri
+
+URI of the next page, or null if there is no next page
+
+Specified by:
+getNextPageUri Pageable Returns:
+the value of the property as a URIOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
TlsCertificate (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class TlsCertificate
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
TlsCertificate String id,
+ URI uri,
+ OffsetDateTime createdAt,
+ String description,
+ String metadata,
+ String certificatePem,
+ String subjectCommonName,
+ TlsCertificateSaNs subjectAlternativeNames,
+ Optional <OffsetDateTime > issuedAt,
+ OffsetDateTime notBefore,
+ OffsetDateTime notAfter,
+ List <String > keyUsages,
+ List <String > extendedKeyUsages,
+ String privateKeyType,
+ String issuerCommonName,
+ String serialNumber,
+ String subjectOrganization,
+ String subjectOrganizationalUnit,
+ String subjectLocality,
+ String subjectProvince,
+ String subjectCountry)
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
chain of PEM-encoded certificates, leaf first.
+
+
+
+
+
timestamp when the TLS certificate was created, RFC 3339 format
+
+
+
+
+
human-readable description of this TLS certificate.
+
+
+
+
+
extended set of actions the private key of this TLS certificate can be used for
+
+
+
+
+
unique identifier for this TLS certificate
+
+
+
+
+
timestamp (in RFC 3339 format) when this TLS certificate was issued
+ automatically, or null if this certificate was user-uploaded
+
+
+
+
+
issuer common name from the leaf of this TLS certificate
+
+
+
+
+
set of actions the private key of this TLS certificate can be used for
+
+
+
+
+
arbitrary user-defined machine-readable data of this TLS certificate.
+
+
+
+
+
timestamp when this TLS certificate becomes invalid, RFC 3339 format
+
+
+
+
+
timestamp when this TLS certificate becomes valid, RFC 3339 format
+
+
+
+
+
type of the private key of this TLS certificate.
+
+
+
+
+
serial number of the leaf of this TLS certificate
+
+
+
+
+
subject alternative names (SANs) from the leaf of this TLS certificate
+
+
+
+
+
subject common name from the leaf of this TLS certificate
+
+
+
+
+
subject country from the leaf of this TLS certificate
+
+
+
+
+
subject locality from the leaf of this TLS certificate
+
+
+
+
+
subject organization from the leaf of this TLS certificate
+
+
+
+
+
subject organizational unit from the leaf of this TLS certificate
+
+
+
+
+
subject province from the leaf of this TLS certificate
+
+
+
+
+
URI of the TLS certificate API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+TlsCertificate
+public TlsCertificate
(String id,
+ URI uri,
+ OffsetDateTime createdAt,
+ String description,
+ String metadata,
+ String certificatePem,
+ String subjectCommonName,
+ TlsCertificateSaNs subjectAlternativeNames,
+ Optional <OffsetDateTime > issuedAt,
+ OffsetDateTime notBefore,
+ OffsetDateTime notAfter,
+ List <String > keyUsages,
+ List <String > extendedKeyUsages,
+ String privateKeyType,
+ String issuerCommonName,
+ String serialNumber,
+ String subjectOrganization,
+ String subjectOrganizationalUnit,
+ String subjectLocality,
+ String subjectProvince,
+ String subjectCountry)
+Parameters:
+id - unique identifier for this TLS certificateuri - URI of the TLS certificate API resourcecreatedAt - timestamp when the TLS certificate was created, RFC 3339 formatdescription - human-readable description of this TLS certificate. optional, max 255 bytes.metadata - arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.certificatePem - chain of PEM-encoded certificates, leaf first. See Certificate Bundles .subjectCommonName - subject common name from the leaf of this TLS certificatesubjectAlternativeNames - subject alternative names (SANs) from the leaf of this TLS certificateissuedAt - timestamp (in RFC 3339 format) when this TLS certificate was issued automatically, or null if this certificate was user-uploadednotBefore - timestamp when this TLS certificate becomes valid, RFC 3339 formatnotAfter - timestamp when this TLS certificate becomes invalid, RFC 3339 formatkeyUsages - set of actions the private key of this TLS certificate can be used forextendedKeyUsages - extended set of actions the private key of this TLS certificate can be used forprivateKeyType - type of the private key of this TLS certificate. One of rsa, ecdsa, or ed25519.issuerCommonName - issuer common name from the leaf of this TLS certificateserialNumber - serial number of the leaf of this TLS certificatesubjectOrganization - subject organization from the leaf of this TLS certificatesubjectOrganizationalUnit - subject organizational unit from the leaf of this TLS certificatesubjectLocality - subject locality from the leaf of this TLS certificatesubjectProvince - subject province from the leaf of this TLS certificatesubjectCountry - subject country from the leaf of this TLS certificate
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+unique identifier for this TLS certificate
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getUri
+
+URI of the TLS certificate API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getCreatedAt
+
+timestamp when the TLS certificate was created, RFC 3339 format
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getDescription
+public String getDescription ()
human-readable description of this TLS certificate. optional, max 255 bytes.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+getCertificatePem
+public String getCertificatePem ()
+Returns:
+the value of the property as a String
+
+
+
+
+
+getSubjectCommonName
+public String getSubjectCommonName ()
subject common name from the leaf of this TLS certificate
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getSubjectAlternativeNames
+
+subject alternative names (SANs) from the leaf of this TLS certificate
+
+Returns:
+the value of the property as a TlsCertificateSaNs
+
+
+
+
+
+getIssuedAt
+
+timestamp (in RFC 3339 format) when this TLS certificate was issued
+ automatically, or null if this certificate was user-uploaded
+
+Returns:
+the value of the property as a OffsetDateTimeOptional
+
+
+
+
+
+getNotBefore
+
+timestamp when this TLS certificate becomes valid, RFC 3339 format
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getNotAfter
+
+timestamp when this TLS certificate becomes invalid, RFC 3339 format
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getKeyUsages
+
+set of actions the private key of this TLS certificate can be used for
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+getExtendedKeyUsages
+
+extended set of actions the private key of this TLS certificate can be used for
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+getPrivateKeyType
+public String getPrivateKeyType ()
type of the private key of this TLS certificate. One of rsa, ecdsa, or ed25519.
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getIssuerCommonName
+public String getIssuerCommonName ()
issuer common name from the leaf of this TLS certificate
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getSerialNumber
+public String getSerialNumber ()
serial number of the leaf of this TLS certificate
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getSubjectOrganization
+public String getSubjectOrganization ()
subject organization from the leaf of this TLS certificate
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getSubjectOrganizationalUnit
+public String getSubjectOrganizationalUnit ()
subject organizational unit from the leaf of this TLS certificate
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getSubjectLocality
+public String getSubjectLocality ()
subject locality from the leaf of this TLS certificate
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getSubjectProvince
+public String getSubjectProvince ()
subject province from the leaf of this TLS certificate
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getSubjectCountry
+public String getSubjectCountry ()
subject country from the leaf of this TLS certificate
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
TlsCertificateList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Pageable
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
URI of the next page, or null if there is no next page
+
+
+
+
+
the list of all TLS certificates on this account
+
+
+
+
+
URI of the TLS certificates list API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+TlsCertificateList
+
+
+
+Parameters:
+tlsCertificates - the list of all TLS certificates on this accounturi - URI of the TLS certificates list API resourcenextPageUri - URI of the next page, or null if there is no next page
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getTlsCertificates
+
+the list of all TLS certificates on this account
+
+Returns:
+the value of the property as a List <TlsCertificate >
+
+
+
+
+
+getUri
+
+URI of the TLS certificates list API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getNextPageUri
+
+URI of the next page, or null if there is no next page
+
+Specified by:
+getNextPageUri Pageable Returns:
+the value of the property as a URIOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
TlsCertificateSaNs (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class TlsCertificateSaNs
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
set of additional domains (including wildcards) this TLS certificate is valid
+ for
+
+
+
+
+
set of IP addresses this TLS certificate is also valid for
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+TlsCertificateSaNs
+
+
+
+Parameters:
+dnsNames - set of additional domains (including wildcards) this TLS certificate is valid forips - set of IP addresses this TLS certificate is also valid for
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getDnsNames
+
+set of additional domains (including wildcards) this TLS certificate is valid
+ for
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+getIps
+
+set of IP addresses this TLS certificate is also valid for
+
+Returns:
+the value of the property as a List <String >
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Tunnel (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class Tunnel
+
extends Object A class encapsulating the
Tunnel resource.
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new instance of
Tunnel.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
unique tunnel resource identifier
+
+
+
+
+
user-supplied metadata for the tunnel defined in the ngrok configuration file.
+
+
+
+
+
+
+
+
URL of the tunnel's public endpoint
+
+
+
+
+
identifier of tune region where the tunnel is running
+
+
+
+
+
timestamp when the tunnel was initiated in RFC 3339 format
+
+
+
+
+
reference object pointing to the tunnel session on which this tunnel was started
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+Tunnel
+
+Creates a new instance of
Tunnel.
+Parameters:
+id - unique tunnel resource identifierpublicUrl - URL of the tunnel's public endpointstartedAt - timestamp when the tunnel was initiated in RFC 3339 formatmetadata - user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel metadata configuration option In API version 0, this value was instead pulled from the top-level metadata configuration option .proto - tunnel protocol. one of http, https, tcp or tlsregion - identifier of tune region where the tunnel is runningtunnelSession - reference object pointing to the tunnel session on which this tunnel was started
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+unique tunnel resource identifier
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getPublicUrl
+public URI getPublicUrl ()
URL of the tunnel's public endpoint
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getStartedAt
+
+timestamp when the tunnel was initiated in RFC 3339 format
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+
+
+
+getProto
+
+tunnel protocol. one of http, https, tcp
+ or tls
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getRegion
+
+identifier of tune region where the tunnel is running
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getTunnelSession
+public Ref getTunnelSession ()
reference object pointing to the tunnel session on which this tunnel was started
+
+Returns:
+the value of the property as a Ref
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
TunnelList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Pageable
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
URI of the next page, or null if there is no next page
+
+
+
+
+
the list of all online tunnels on this account
+
+
+
+
+
URI of the tunnels list API resource
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+TunnelList
+
+
+
+Parameters:
+tunnels - the list of all online tunnels on this accounturi - URI of the tunnels list API resourcenextPageUri - URI of the next page, or null if there is no next page
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getTunnels
+
+the list of all online tunnels on this account
+
+Returns:
+the value of the property as a List <Tunnel >
+
+
+
+
+
+getUri
+
+URI of the tunnels list API resource
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getNextPageUri
+
+URI of the next page, or null if there is no next page
+
+Specified by:
+getNextPageUri Pageable Returns:
+the value of the property as a URIOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
TunnelSession (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class TunnelSession
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
version of the ngrok agent that started this ngrok tunnel session
+
+
+
+
+
reference to the tunnel credential or ssh credential used by the ngrok agent to
+ start this tunnel session
+
+
+
+
+
unique tunnel session resource identifier
+
+
+
+
+
source ip address of the tunnel session
+
+
+
+
+
arbitrary user-defined data specified in the metadata property in the ngrok
+ configuration file.
+
+
+
+
+
operating system of the host the ngrok agent is running on
+
+
+
+
+
the ngrok region identifier in which this tunnel session was started
+
+
+
+
+
time when the tunnel session first connected to the ngrok servers
+
+
+
+
+
the transport protocol used to start the tunnel session.
+
+
+
+
+
URI to the API resource of the tunnel session
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+TunnelSession
+
+
+
+Parameters:
+agentVersion - version of the ngrok agent that started this ngrok tunnel sessioncredential - reference to the tunnel credential or ssh credential used by the ngrok agent to start this tunnel sessionid - unique tunnel session resource identifierip - source ip address of the tunnel sessionmetadata - arbitrary user-defined data specified in the metadata property in the ngrok configuration file. See the metadata configuration optionos - operating system of the host the ngrok agent is running onregion - the ngrok region identifier in which this tunnel session was startedstartedAt - time when the tunnel session first connected to the ngrok serverstransport - the transport protocol used to start the tunnel session. Either ngrok/v2 or sshuri - URI to the API resource of the tunnel session
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getAgentVersion
+public String getAgentVersion ()
version of the ngrok agent that started this ngrok tunnel session
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getCredential
+public Ref getCredential ()
reference to the tunnel credential or ssh credential used by the ngrok agent to
+ start this tunnel session
+
+Returns:
+the value of the property as a Ref
+
+
+
+
+
+getId
+
+unique tunnel session resource identifier
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getIp
+
+source ip address of the tunnel session
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+
+
+
+getOs
+
+operating system of the host the ngrok agent is running on
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getRegion
+
+the ngrok region identifier in which this tunnel session was started
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getStartedAt
+
+time when the tunnel session first connected to the ngrok servers
+
+Returns:
+the value of the property as a OffsetDateTime
+
+
+
+
+
+getTransport
+
+the transport protocol used to start the tunnel session. Either
+ ngrok/v2 or ssh
+
+Returns:
+the value of the property as a String
+
+
+
+
+
+getUri
+
+URI to the API resource of the tunnel session
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
TunnelSessionList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Pageable
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
boolean
+
+
+
+
+
+
URI of the next page, or null if there is no next page
+
+
+
+
+
list of all tunnel sessions on this account
+
+
+
+
+
URI to the API resource of the tunnel session list
+
+
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+TunnelSessionList
+
+
+
+Parameters:
+tunnelSessions - list of all tunnel sessions on this accounturi - URI to the API resource of the tunnel session listnextPageUri - URI of the next page, or null if there is no next page
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getTunnelSessions
+
+list of all tunnel sessions on this account
+
+Returns:
+the value of the property as a List <TunnelSession >
+
+
+
+
+
+getUri
+
+URI to the API resource of the tunnel session list
+
+Returns:
+the value of the property as a URI
+
+
+
+
+
+getNextPageUri
+
+URI of the next page, or null if there is no next page
+
+Specified by:
+getNextPageUri Pageable Returns:
+the value of the property as a URIOptional
+
+
+
+
+
+
+
+
+hashCode
+public int hashCode ()
+
+Overrides:
+hashCode Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.AbuseReport (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
AbuseReports.CreateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
AbuseReports.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.AbuseReportHostname (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
an array of hostname statuses related to the report
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.AgentIngress (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
the list of Agent Ingresses owned by this account
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
AgentIngresses.CreateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
AgentIngresses.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
AgentIngresses.UpdateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.AgentIngressList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
AgentIngresses.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.ApiKey (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
the list of API keys for this account
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
ApiKeys.CreateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
ApiKeys.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
ApiKeys.UpdateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.ApiKeyList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
ApiKeys.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.AwsAuth.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Credentials to your AWS account if you prefer ngrok to sign in with long-term
+ access keys.
+
+
+
+
+
Credentials to your AWS account if you prefer ngrok to sign in with long-term
+ access keys.
+
+
+
+
+
Creates a new builder for the
AwsAuth type.
+
+
+
+
+
A role for ngrok to assume on your behalf to deposit events into your AWS
+ account.
+
+
+
+
+
A role for ngrok to assume on your behalf to deposit events into your AWS
+ account.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.AwsAuth (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventTargetCloudwatchLogs. getAuth
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.AwsCredentials.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/definitions/class-use/AwsCredentials.html b/docs/com/ngrok/definitions/class-use/AwsCredentials.html
new file mode 100644
index 0000000..d18120a
--- /dev/null
+++ b/docs/com/ngrok/definitions/class-use/AwsCredentials.html
@@ -0,0 +1,128 @@
+
+
+
+
+
+Uses of Class com.ngrok.definitions.AwsCredentials (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
AwsCredentials.Builder. build
+
+
+
+
+
+
+
+
+
Credentials to your AWS account if you prefer ngrok to sign in with long-term
+ access keys.
+
+
+
+
+
+
+
+
+
Credentials to your AWS account if you prefer ngrok to sign in with long-term
+ access keys.
+
+
+
+
+
+
+
+
+
Credentials to your AWS account if you prefer ngrok to sign in with long-term
+ access keys.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.AwsRole.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a new builder for the
AwsRole type.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.AwsRole (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A role for ngrok to assume on your behalf to deposit events into your AWS
+ account.
+
+
+
+
+
+
+
+
+
A role for ngrok to assume on your behalf to deposit events into your AWS
+ account.
+
+
+
+
+
+
+
+
+
A role for ngrok to assume on your behalf to deposit events into your AWS
+ account.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.CertificateAuthority (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
the list of all certificate authorities on this account
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
CertificateAuthorities.CreateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
CertificateAuthorities.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
CertificateAuthorities.UpdateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.CertificateAuthorityList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
CertificateAuthorities.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.Credential (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
the list of all tunnel credentials on this account
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
Credentials.CreateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
Credentials.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
Credentials.UpdateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.CredentialList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
Credentials.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointCircuitBreaker.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointCircuitBreaker.Builder. enabled
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
Error threshold percentage should be between 0 - 1.0, not 0-100.0
+
+
+
+
+
Error threshold percentage should be between 0 - 1.0, not 0-100.0
+
+
+
+
+
+
EndpointCircuitBreaker.Builder. numBuckets
+
+
Integer number of buckets into which metrics are retained.
+
+
+
+
+
Integer number of buckets into which metrics are retained.
+
+
+
EndpointCircuitBreaker.Builder. rollingWindow
+
+
Integer number of seconds in the statistical rolling window that metrics are
+ retained for.
+
+
+
+
+
Integer number of seconds in the statistical rolling window that metrics are
+ retained for.
+
+
+
+
+
Integer number of seconds after which the circuit is tripped to wait before
+ re-evaluating upstream health
+
+
+
+
+
Integer number of seconds after which the circuit is tripped to wait before
+ re-evaluating upstream health
+
+
+
+
+
Integer number of requests in a rolling window that will trip the circuit.
+
+
+
+
+
Integer number of requests in a rolling window that will trip the circuit.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointCircuitBreaker (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointCircuitBreaker.Builder. build
+
+
+
+
+
+
+
+
+
circuit breaker module configuration or null
+
+
+
+
+
+
+
EndpointConfiguration String id,
+ String type,
+ String description,
+ String metadata,
+ OffsetDateTime createdAt,
+ URI uri,
+ Optional <EndpointCircuitBreaker > circuitBreaker,
+ Optional <EndpointCompression > compression,
+ Optional <EndpointRequestHeaders > requestHeaders,
+ Optional <EndpointResponseHeaders > responseHeaders,
+ Optional <EndpointIpPolicy > ipPolicy,
+ Optional <EndpointMutualTls > mutualTls,
+ Optional <EndpointTlsTermination > tlsTermination,
+ Optional <EndpointWebhookValidation > webhookValidation,
+ Optional <EndpointOAuth > oauth,
+ Optional <EndpointLogging > logging,
+ Optional <EndpointSaml > saml,
+ Optional <EndpointOidc > oidc)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
EndpointCircuitBreakerModule.ReplaceCallBuilder. blockingCall
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
EndpointCircuitBreakerModule.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EndpointCircuitBreakerModule.ReplaceCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
circuit breaker module configuration or null
+
+
+
+
+
circuit breaker module configuration or null
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
+
+
+
+
circuit breaker module configuration or null
+
+
+
+
+
circuit breaker module configuration or null
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointCompression.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointCompression.Builder. enabled
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointCompression (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointCompression.Builder. build
+
+
+
+
+
+
+
+
+
compression module configuration or null
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
EndpointCompressionModule.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EndpointCompressionModule.ReplaceCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
compression module configuration or null
+
+
+
+
+
compression module configuration or null
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
+
+
+
+
compression module configuration or null
+
+
+
+
+
compression module configuration or null
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointConfiguration (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
the list of all endpoint configurations on this account
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
EndpointConfigurations.CreateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EndpointConfigurations.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EndpointConfigurations.UpdateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointConfigurationList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
EndpointConfigurations.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointIpPolicy (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
ip policy module configuration or null
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
EndpointIpPolicyModule.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EndpointIpPolicyModule.ReplaceCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointIpPolicyMutate.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointIpPolicyMutate.Builder. enabled
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
list of all IP policies that will be used to check if a source IP is allowed
+ access to the endpoint
+
+
+
+
+
list of all IP policies that will be used to check if a source IP is allowed
+ access to the endpoint
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointIpPolicyMutate (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointIpPolicyMutate.Builder. build
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
ip policy module configuration or null
+
+
+
+
+
ip policy module configuration or null
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
+
+
+
+
ip policy module configuration or null
+
+
+
+
+
ip policy module configuration or null
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointLogging (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
logging module configuration or null
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
EndpointLoggingModule.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EndpointLoggingModule.ReplaceCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointLoggingMutate.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointLoggingMutate.Builder. enabled
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
list of all EventStreams that will be used to configure and export this
+ endpoint's logs
+
+
+
+
+
list of all EventStreams that will be used to configure and export this
+ endpoint's logs
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointLoggingMutate (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointLoggingMutate.Builder. build
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
logging module configuration or null
+
+
+
+
+
logging module configuration or null
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
+
+
+
+
logging module configuration or null
+
+
+
+
+
logging module configuration or null
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointMutualTls (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
mutual TLS module configuration or null
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
EndpointMutualTlsModule.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EndpointMutualTlsModule.ReplaceCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointMutualTlsMutate.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
list of certificate authorities that will be used to validate the TLS client
+ certificate presnted by the initiatiator of the TLS connection
+
+
+
+
+
list of certificate authorities that will be used to validate the TLS client
+ certificate presnted by the initiatiator of the TLS connection
+
+
+
EndpointMutualTlsMutate.Builder. enabled
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointMutualTlsMutate (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointMutualTlsMutate.Builder. build
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
mutual TLS module configuration or null
+
+
+
+
+
mutual TLS module configuration or null
+
+
+
+
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
mutual TLS module configuration or null
+
+
+
+
+
mutual TLS module configuration or null
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointOAuth.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Integer number of seconds after which ngrok guarantees it will refresh user
+ state from the identity provider and recheck whether the user is still
+ authorized to access the endpoint.
+
+
+
+
+
Integer number of seconds after which ngrok guarantees it will refresh user
+ state from the identity provider and recheck whether the user is still
+ authorized to access the endpoint.
+
+
+
+
+
the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+
+
+
+
the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+
+
EndpointOAuth.Builder. enabled
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
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.
+
+
+
+
+
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.
+
+
+
+
+
Integer number of seconds of the maximum duration of an authenticated session.
+
+
+
+
+
Integer number of seconds of the maximum duration of an authenticated session.
+
+
+
+
+
+
+
+
Do not enforce authentication on HTTP OPTIONS requests.
+
+
+
+
+
Do not enforce authentication on HTTP OPTIONS requests.
+
+
+
+
+
an object which defines the identity provider to use for authentication and
+ configuration for who may access the endpoint
+
+
+
+
+
an object which defines the identity provider to use for authentication and
+ configuration for who may access the endpoint
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointOAuth (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuth.Builder. build
+
+
+
+
+
+
+
+
+
oauth module configuration or null
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
EndpointOAuthModule.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EndpointOAuthModule.ReplaceCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
oauth module configuration or null
+
+
+
+
+
oauth module configuration or null
+
+
+
+
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
oauth module configuration or null
+
+
+
+
+
oauth module configuration or null
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointOAuthFacebook.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
the OAuth app client ID.
+
+
+
+
+
the OAuth app client ID.
+
+
+
+
+
the OAuth app client secret.
+
+
+
+
+
the OAuth app client secret.
+
+
+
+
+
a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
+
+
+
a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+
+
+
+
a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointOAuthFacebook (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuthFacebook.Builder. build
+
+
+
+
+
+
+
+
+
configuration for using facebook as the identity provider
+
+
+
+
+
+
+
+
+
configuration for using facebook as the identity provider
+
+
+
+
+
+
+
+
+
configuration for using facebook as the identity provider
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointOAuthGitHub.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
the OAuth app client ID.
+
+
+
+
+
the OAuth app client ID.
+
+
+
+
+
the OAuth app client secret.
+
+
+
+
+
the OAuth app client secret.
+
+
+
+
+
a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
+
+
+
a list of github org identifiers.
+
+
+
+
+
a list of github org identifiers.
+
+
+
+
+
a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+
+
+
+
a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+
+
+
+
a list of github teams identifiers.
+
+
+
+
+
a list of github teams identifiers.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointOAuthGitHub (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuthGitHub.Builder. build
+
+
+
+
+
+
+
+
+
configuration for using github as the identity provider
+
+
+
+
+
+
+
+
+
configuration for using github as the identity provider
+
+
+
+
+
+
+
+
+
configuration for using github as the identity provider
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointOAuthGoogle.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
the OAuth app client ID.
+
+
+
+
+
the OAuth app client ID.
+
+
+
+
+
the OAuth app client secret.
+
+
+
+
+
the OAuth app client secret.
+
+
+
+
+
a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
+
+
+
a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+
+
+
+
a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointOAuthGoogle (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuthGoogle.Builder. build
+
+
+
+
+
+
+
+
+
configuration for using google as the identity provider
+
+
+
+
+
+
+
+
+
configuration for using google as the identity provider
+
+
+
+
+
+
+
+
+
configuration for using google as the identity provider
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointOAuthMicrosoft.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
the OAuth app client ID.
+
+
+
+
+
the OAuth app client ID.
+
+
+
+
+
the OAuth app client secret.
+
+
+
+
+
the OAuth app client secret.
+
+
+
+
+
a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+
+
+
+
+
+
+
a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+
+
+
+
a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointOAuthMicrosoft (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuthMicrosoft.Builder. build
+
+
+
+
+
+
+
+
+
configuration for using microsoft as the identity provider
+
+
+
+
+
+
+
+
+
configuration for using microsoft as the identity provider
+
+
+
+
+
+
+
+
+
configuration for using microsoft as the identity provider
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointOAuthProvider.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
configuration for using facebook as the identity provider
+
+
+
+
+
configuration for using facebook as the identity provider
+
+
+
+
+
configuration for using github as the identity provider
+
+
+
+
+
configuration for using github as the identity provider
+
+
+
+
+
configuration for using google as the identity provider
+
+
+
+
+
configuration for using google as the identity provider
+
+
+
+
+
configuration for using microsoft as the identity provider
+
+
+
+
+
configuration for using microsoft as the identity provider
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointOAuthProvider (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuthProvider.Builder. build
+
+
+
+
+
an object which defines the identity provider to use for authentication and
+ configuration for who may access the endpoint
+
+
+
+
+
+
+
+
+
an object which defines the identity provider to use for authentication and
+ configuration for who may access the endpoint
+
+
+
+
+
+
+
+
+
an object which defines the identity provider to use for authentication and
+ configuration for who may access the endpoint
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointOidc.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The OIDC app's client ID and OIDC audience.
+
+
+
+
+
The OIDC app's client ID and OIDC audience.
+
+
+
+
+
The OIDC app's client secret.
+
+
+
+
+
The OIDC app's client secret.
+
+
+
+
+
the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+
+
+
+
the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+
+
EndpointOidc.Builder. enabled
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
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.
+
+
+
+
+
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.
+
+
+
+
+
URL of the OIDC "OpenID provider".
+
+
+
+
+
URL of the OIDC "OpenID provider".
+
+
+
+
+
Integer number of seconds of the maximum duration of an authenticated session.
+
+
+
+
+
Integer number of seconds of the maximum duration of an authenticated session.
+
+
+
+
+
+
+
+
Do not enforce authentication on HTTP OPTIONS requests.
+
+
+
+
+
Do not enforce authentication on HTTP OPTIONS requests.
+
+
+
+
+
The set of scopes to request from the OIDC identity provider.
+
+
+
+
+
The set of scopes to request from the OIDC identity provider.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointOidc (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOidc.Builder. build
+
+
+
+
+
+
+
+
+
oidc module configuration or null
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
EndpointOidcModule.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EndpointOidcModule.ReplaceCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
oidc module configuration or null
+
+
+
+
+
oidc module configuration or null
+
+
+
+
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
oidc module configuration or null
+
+
+
+
+
oidc module configuration or null
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointRequestHeaders.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
a map of header key to header value that will be injected into the HTTP Request
+ before being sent to the upstream application server
+
+
+
+
+
a map of header key to header value that will be injected into the HTTP Request
+ before being sent to the upstream application server
+
+
+
EndpointRequestHeaders.Builder. enabled
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
+
+
+
a list of header names that will be removed from the HTTP Request before being
+ sent to the upstream application server
+
+
+
+
+
a list of header names that will be removed from the HTTP Request before being
+ sent to the upstream application server
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointRequestHeaders (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointRequestHeaders.Builder. build
+
+
+
+
+
+
+
+
+
request headers module configuration or null
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
EndpointRequestHeadersModule.ReplaceCallBuilder. blockingCall
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
EndpointRequestHeadersModule.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EndpointRequestHeadersModule.ReplaceCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
request headers module configuration or null
+
+
+
+
+
request headers module configuration or null
+
+
+
+
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
request headers module configuration or null
+
+
+
+
+
request headers module configuration or null
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointResponseHeaders.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
a map of header key to header value that will be injected into the HTTP Response
+ returned to the HTTP client
+
+
+
+
+
a map of header key to header value that will be injected into the HTTP Response
+ returned to the HTTP client
+
+
+
EndpointResponseHeaders.Builder. enabled
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
+
+
+
a list of header names that will be removed from the HTTP Response returned to
+ the HTTP client
+
+
+
+
+
a list of header names that will be removed from the HTTP Response returned to
+ the HTTP client
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointResponseHeaders (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointResponseHeaders.Builder. build
+
+
+
+
+
+
+
+
+
response headers module configuration or null
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
EndpointResponseHeadersModule.ReplaceCallBuilder. blockingCall
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
EndpointResponseHeadersModule.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EndpointResponseHeadersModule.ReplaceCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
response headers module configuration or null
+
+
+
+
+
response headers module configuration or null
+
+
+
+
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
response headers module configuration or null
+
+
+
+
+
response headers module configuration or null
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointSaml (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
saml module configuration or null
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
EndpointSamlModule.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EndpointSamlModule.ReplaceCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointSamlMutate.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
If true, the IdP may initiate a login directly (e.g.
+
+
+
+
+
If true, the IdP may initiate a login directly (e.g.
+
+
+
+
+
If present, only users who are a member of one of the listed groups may access
+ the target endpoint.
+
+
+
+
+
If present, only users who are a member of one of the listed groups may access
+ the target endpoint.
+
+
+
+
+
the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+
+
+
+
the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+
+
EndpointSamlMutate.Builder. enabled
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
EndpointSamlMutate.Builder. forceAuthn
+
+
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.
+
+
+
+
+
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.
+
+
+
+
+
The full XML IdP EntityDescriptor.
+
+
+
+
+
The full XML IdP EntityDescriptor.
+
+
+
+
+
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.
+
+
+
+
+
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.
+
+
+
+
+
Integer number of seconds of the maximum duration of an authenticated session.
+
+
+
+
+
Integer number of seconds of the maximum duration of an authenticated session.
+
+
+
+
+
Defines the name identifier format the SP expects the IdP to use in its
+ assertions to identify subjects.
+
+
+
+
+
Defines the name identifier format the SP expects the IdP to use in its
+ assertions to identify subjects.
+
+
+
+
+
+
+
+
Do not enforce authentication on HTTP OPTIONS requests.
+
+
+
+
+
Do not enforce authentication on HTTP OPTIONS requests.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointSamlMutate (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointSamlMutate.Builder. build
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
saml module configuration or null
+
+
+
+
+
saml module configuration or null
+
+
+
+
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
saml module configuration or null
+
+
+
+
+
saml module configuration or null
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointTlsTermination.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointTlsTermination.Builder. enabled
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
The minimum TLS version used for termination and advertised to the client during
+ the TLS handshake.
+
+
+
+
+
The minimum TLS version used for termination and advertised to the client during
+ the TLS handshake.
+
+
+
+
+
+
+
+
edge if the ngrok edge should terminate TLS traffic,
+ upstream if TLS traffic should be passed through to the upstream
+ ngrok agent / application server for termination.
+
+
+
+
+
edge if the ngrok edge should terminate TLS traffic,
+ upstream if TLS traffic should be passed through to the upstream
+ ngrok agent / application server for termination.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointTlsTermination (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointTlsTermination.Builder. build
+
+
+
+
+
+
+
+
+
TLS termination module configuration or null
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
EndpointTlsTerminationModule.ReplaceCallBuilder. blockingCall
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
EndpointTlsTerminationModule.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EndpointTlsTerminationModule.ReplaceCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
TLS termination module configuration or null
+
+
+
+
+
TLS termination module configuration or null
+
+
+
+
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
TLS termination module configuration or null
+
+
+
+
+
TLS termination module configuration or null
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointWebhookValidation.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointWebhookValidation.Builder. enabled
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
true if the module will be applied to traffic, false
+ to disable.
+
+
+
+
+
+
+
+
a string indicating which webhook provider will be sending webhooks to this
+ endpoint.
+
+
+
+
+
a string indicating which webhook provider will be sending webhooks to this
+ endpoint.
+
+
+
+
+
a string secret used to validate requests from the given provider.
+
+
+
+
+
a string secret used to validate requests from the given provider.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EndpointWebhookValidation (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointWebhookValidation.Builder. build
+
+
+
+
+
+
+
+
+
webhook validation module configuration or null
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointWebhookValidationModule.GetCallBuilder. blockingCall
+
+
Initiates the API call and blocks until it returns.
+
+
+
EndpointWebhookValidationModule.ReplaceCallBuilder. blockingCall
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
EndpointWebhookValidationModule.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EndpointWebhookValidationModule.ReplaceCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
webhook validation module configuration or null
+
+
+
+
+
webhook validation module configuration or null
+
+
+
+
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
webhook validation module configuration or null
+
+
+
+
+
webhook validation module configuration or null
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EventDestination (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The list of all Event Destinations on this account.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
EventDestinations.CreateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EventDestinations.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EventDestinations.UpdateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EventDestinationList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
EventDestinations.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EventSource (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The list of all Event Sources for an Event Subscription
+
+
+
+
+
Sources containing the types for which this event subscription will trigger
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
EventSources.CreateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EventSources.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EventSources.UpdateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EventSourceList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
EventSources.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EventSourceReplace.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Type of event for which an event subscription will trigger
+
+
+
+
+
Type of event for which an event subscription will trigger
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EventSourceReplace (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventSourceReplace.Builder. build
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sources containing the types for which this event subscription will trigger
+
+
+
+
+
Sources containing the types for which this event subscription will trigger
+
+
+
+
+
Sources containing the types for which this event subscription will trigger
+
+
+
+
+
Sources containing the types for which this event subscription will trigger
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EventStream (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The list of all Event Streams on this account.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
EventStreams.CreateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EventStreams.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EventStreams.UpdateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EventStreamList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
EventStreams.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EventSubscription (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The list of all Event Subscriptions on this account.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
EventSubscriptions.CreateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EventSubscriptions.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EventSubscriptions.UpdateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EventSubscriptionList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
EventSubscriptions.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EventTarget.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Configuration used to send events to Amazon CloudWatch Logs.
+
+
+
+
+
Configuration used to send events to Amazon CloudWatch Logs.
+
+
+
+
+
Configuration used to send events to Amazon Kinesis Data Firehose.
+
+
+
+
+
Configuration used to send events to Amazon Kinesis Data Firehose.
+
+
+
+
+
Configuration used to send events to Amazon Kinesis.
+
+
+
+
+
Configuration used to send events to Amazon Kinesis.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EventTarget (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventTarget.Builder. build
+
+
+
+
+
An object that encapsulates where and how to send your events.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
An object that encapsulates where and how to send your events.
+
+
+
+
+
An object that encapsulates where and how to send your events.
+
+
+
+
+
+
+
+
+
An object that encapsulates where and how to send your events.
+
+
+
+
+
An object that encapsulates where and how to send your events.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EventTargetCloudwatchLogs.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
An Amazon Resource Name specifying the CloudWatch Logs group to deposit events
+ into.
+
+
+
+
+
An Amazon Resource Name specifying the CloudWatch Logs group to deposit events
+ into.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EventTargetCloudwatchLogs (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventTargetCloudwatchLogs.Builder. build
+
+
+
+
+
+
+
+
+
Configuration used to send events to Amazon CloudWatch Logs.
+
+
+
+
+
+
+
+
+
Configuration used to send events to Amazon CloudWatch Logs.
+
+
+
+
+
+
+
+
+
Configuration used to send events to Amazon CloudWatch Logs.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EventTargetFirehose.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
An Amazon Resource Name specifying the Firehose delivery stream to deposit
+ events into.
+
+
+
+
+
An Amazon Resource Name specifying the Firehose delivery stream to deposit
+ events into.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EventTargetFirehose (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventTargetFirehose.Builder. build
+
+
+
+
+
+
+
+
+
Configuration used to send events to Amazon Kinesis Data Firehose.
+
+
+
+
+
+
+
+
+
Configuration used to send events to Amazon Kinesis Data Firehose.
+
+
+
+
+
+
+
+
+
Configuration used to send events to Amazon Kinesis Data Firehose.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EventTargetKinesis.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
Configuration for how to authenticate into your AWS account.
+
+
+
+
+
+
+
+
An Amazon Resource Name specifying the Kinesis stream to deposit events into.
+
+
+
+
+
An Amazon Resource Name specifying the Kinesis stream to deposit events into.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.EventTargetKinesis (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventTargetKinesis.Builder. build
+
+
+
+
+
+
+
+
+
Configuration used to send events to Amazon Kinesis.
+
+
+
+
+
+
+
+
+
Configuration used to send events to Amazon Kinesis.
+
+
+
+
+
+
+
+
+
Configuration used to send events to Amazon Kinesis.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.IpPolicy (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
the list of all IP policies on this account
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
IpPolicies.CreateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
IpPolicies.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
IpPolicies.UpdateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.IpPolicyList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
IpPolicies.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.IpPolicyRule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
the list of all IP policy rules on this account
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
IpPolicyRules.CreateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
IpPolicyRules.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
IpPolicyRules.UpdateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.IpPolicyRuleList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
IpPolicyRules.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.IpRestriction (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
the list of all IP restrictions on this account
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
IpRestrictions.CreateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
IpRestrictions.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
IpRestrictions.UpdateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.IpRestrictionList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
IpRestrictions.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.NgrokApiError (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+No usage of com.ngrok.definitions.NgrokApiError
+
+
+
Uses of Class com.ngrok.definitions.Page (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Fetches the next page of responses, if any.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
AgentIngresses.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
ApiKeys.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
CertificateAuthorities.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
Credentials.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EndpointConfigurations.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EventDestinations.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EventStreams.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
EventSubscriptions.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
IpPolicies.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
IpPolicyRules.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
IpRestrictions.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
ReservedAddrs.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
ReservedDomains.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
SshCertificateAuthorities.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
SshCredentials.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
SshHostCertificates.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
SshUserCertificates.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
TlsCertificates.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
Tunnels.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
TunnelSessions.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Interface com.ngrok.definitions.Pageable (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
class
+
+
+
Wrapper class that holds a single page of a
Pageable response.
+
+
+
+
+
+
class
+
+
+
class
+
+
+
class
+
+
+
class
+
+
+
class
+
+
+
class
+
+
+
class
+
+
+
class
+
+
+
class
+
+
+
class
+
+
+
class
+
+
+
class
+
+
+
class
+
+
+
class
+
+
+
class
+
+
+
class
+
+
+
class
+
+
+
class
+
+
+
class
+
+
+
class
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.Ref (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
reference to the tunnel credential or ssh credential used by the ngrok agent to
+ start this tunnel session
+
+
+
+
+
object describing the IP policy this IP Policy Rule belongs to
+
+
+
+
+
reference object pointing to the tunnel session on which this tunnel was started
+
+
+
+
+
+
+
+
+
object referencing the TLS certificate used for connections to this domain.
+
+
+
+
+
PEM-encoded CA certificates that will be used to validate.
+
+
+
+
+
Destinations to which these events will be sent
+
+
+
+
+
object reference to the endpoint configuration that will be applied to traffic
+ to this address
+
+
+
+
+
list of all EventStreams that will be used to configure and export this
+ endpoint's logs
+
+
+
+
+
object referencing the endpoint configuration applied to http traffic on this
+ domain
+
+
+
+
+
object referencing the endpoint configuration applied to https traffic on this
+ domain
+
+
+
+
+
Fetches the value of the ipPolicies property.
+
+
+
+
+
the set of IP policies that are used to enforce the restriction
+
+
+
+
+
+
+
+
+
+
+
+
Creates a new instance of
Tunnel.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.ReservedAddr (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
the list of all reserved addresses on this account
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
ReservedAddrs.CreateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
ReservedAddrs.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
ReservedAddrs.UpdateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.ReservedAddrList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
ReservedAddrs.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.ReservedDomain (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
the list of all reserved domains on this account
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
ReservedDomains.CreateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
ReservedDomains.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
ReservedDomains.UpdateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.ReservedDomainCertJob (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
status of the certificate provisioning job, or null if the certificiate isn't
+ being provisioned or renewed
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.ReservedDomainCertPolicy.Builder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
certificate authority to request certificates from.
+
+
+
+
+
certificate authority to request certificates from.
+
+
+
+
+
+
+
+
type of private key to use when requesting certificates.
+
+
+
+
+
type of private key to use when requesting certificates.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.ReservedDomainCertPolicy (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
ReservedDomainCertPolicy.Builder. build
+
+
+
+
+
+
+
+
+
configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled.
+
+
+
+
+
configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled.
+
+
+
+
+
+
+
+
+
configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled.
+
+
+
+
+
configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.ReservedDomainCertStatus (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
status of the automatic certificate management for this domain, or null if
+ automatic management is disabled
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.ReservedDomainList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
ReservedDomains.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.SshCertificateAuthority (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
the list of all certificate authorities on this account
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
SshCertificateAuthorities.CreateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
SshCertificateAuthorities.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
SshCertificateAuthorities.UpdateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.SshCertificateAuthorityList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
SshCertificateAuthorities.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.SshCredential (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
the list of all ssh credentials on this account
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
SshCredentials.CreateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
SshCredentials.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
SshCredentials.UpdateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.SshCredentialList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
SshCredentials.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.SshHostCertificate (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
the list of all ssh host certificates on this account
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
SshHostCertificates.CreateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
SshHostCertificates.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
SshHostCertificates.UpdateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.SshHostCertificateList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
SshHostCertificates.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.SshUserCertificate (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
the list of all ssh user certificates on this account
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
SshUserCertificates.CreateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
SshUserCertificates.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
SshUserCertificates.UpdateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.SshUserCertificateList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
SshUserCertificates.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.TlsCertificate (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
the list of all TLS certificates on this account
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
TlsCertificates.CreateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
TlsCertificates.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
TlsCertificates.UpdateCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.TlsCertificateList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
TlsCertificates.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.TlsCertificateSaNs (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
subject alternative names (SANs) from the leaf of this TLS certificate
+
+
+
+
+
+
+
TlsCertificate String id,
+ URI uri,
+ OffsetDateTime createdAt,
+ String description,
+ String metadata,
+ String certificatePem,
+ String subjectCommonName,
+ TlsCertificateSaNs subjectAlternativeNames,
+ Optional <OffsetDateTime > issuedAt,
+ OffsetDateTime notBefore,
+ OffsetDateTime notAfter,
+ List <String > keyUsages,
+ List <String > extendedKeyUsages,
+ String privateKeyType,
+ String issuerCommonName,
+ String serialNumber,
+ String subjectOrganization,
+ String subjectOrganizationalUnit,
+ String subjectLocality,
+ String subjectProvince,
+ String subjectCountry)
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.Tunnel (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
the list of all online tunnels on this account
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.TunnelList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
Tunnels.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.TunnelSession (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
list of all tunnel sessions on this account
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
+
+
TunnelSessions.GetCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.definitions.TunnelSessionList (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
TunnelSessions.ListCallBuilder. call
+
+
Initiates the API call asynchronously.
+
+
+
+
+
+
+
+
+
com.ngrok.definitions (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+package com.ngrok.definitions
+
+
+
+Interface Summary
+
+
+
+
+
+
Interface indicating a resource type that can have more than one page of responses.
+
+
+
+Class Summary
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A class encapsulating the
ApiKey resource.
+
+
+
+
+
+
A class encapsulating the
AwsAuth resource.
+
+
+
+
+
+
+
+
+
+
A class encapsulating the
AwsRole resource.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A class encapsulating the
IpPolicy resource.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Wrapper class that holds a single page of a
Pageable response.
+
+
+
+
A class encapsulating the
Ref resource.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A class encapsulating the
Tunnel resource.
+
+
+
+
+
+
+
+
+
+Exception Summary
+
+
+
+
+
+
Representation of an API error from ngrok.
+
+
+
+
+
+
+
+
com.ngrok.definitions Class Hierarchy (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/definitions/package-use.html b/docs/com/ngrok/definitions/package-use.html
new file mode 100644
index 0000000..80452ab
--- /dev/null
+++ b/docs/com/ngrok/definitions/package-use.html
@@ -0,0 +1,680 @@
+
+
+
+
+
+Uses of Package com.ngrok.definitions (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A class encapsulating the
ApiKey resource.
+
+
+
+
A class encapsulating the
AwsAuth resource.
+
+
+
+
+
+
+
+
+
+
A class encapsulating the
AwsRole resource.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A class encapsulating the
IpPolicy resource.
+
+
+
+
+
+
+
+
Wrapper class that holds a single page of a
Pageable response.
+
+
+
+
Interface indicating a resource type that can have more than one page of responses.
+
+
+
+
A class encapsulating the
Ref resource.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A class encapsulating the
Tunnel resource.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A class encapsulating the
ApiKey resource.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A class encapsulating the
IpPolicy resource.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Wrapper class that holds a single page of a
Pageable response.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
com.ngrok (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+package com.ngrok
+
+
+
+Interface Summary
+
+
+
+Class Summary
+
+
+
+
+
+
Default implementation of
NgrokApiClient based on the Armeria HTTP client.
+
+
+
+
Builder class for the default API client.
+
+
+
+
Main entry point for the ngrok API.
+
+
+
+
Client version information
+
+
+
+Enum Summary
+
+
+
+
+
+
+
+
com.ngrok Class Hierarchy (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/package-use.html b/docs/com/ngrok/package-use.html
new file mode 100644
index 0000000..cabedc4
--- /dev/null
+++ b/docs/com/ngrok/package-use.html
@@ -0,0 +1,139 @@
+
+
+
+
+
+Uses of Package com.ngrok (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Default implementation of
NgrokApiClient based on the Armeria HTTP client.
+
+
+
+
Builder class for the default API client.
+
+
+
+
Main entry point for the ngrok API.
+
+
+
+
A namespace object for PointcfgModule.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
AbuseReports.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+AbuseReports
+public class AbuseReports.CreateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Create API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
arbitrary user-defined data about this abuse report.
+
+
+
+
+
arbitrary user-defined data about this abuse report.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+AbuseReportThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
AbuseReports.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+AbuseReports
+public class AbuseReports.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+AbuseReportThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
AbuseReports (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class AbuseReports
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for AbuseReports.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Creates a new abuse report which will be reviewed by our system and abuse
+ response team.
+
+
+
+
+
Get the detailed status of abuse report by ID.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+AbuseReports
+
+Creates a new sub-client for AbuseReports.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+create
+
+
+
+Parameters:
+urls - a list of URLs containing suspected abusive contentReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
AgentIngresses.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+AgentIngresses
+public class AgentIngresses.CreateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Create API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of the use of this Agent Ingress.
+
+
+
+
+
human-readable description of the use of this Agent Ingress.
+
+
+
+
+
arbitrary user-defined machine-readable data of this Agent Ingress.
+
+
+
+
+
arbitrary user-defined machine-readable data of this Agent Ingress.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of the use of this Agent Ingress. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of the use of this Agent Ingress. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+AgentIngressThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
AgentIngresses.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+AgentIngresses
+public class AgentIngresses.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
AgentIngresses.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+AgentIngresses
+public class AgentIngresses.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+AgentIngressThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
AgentIngresses.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+AgentIngresses
+public class AgentIngresses.ListCallBuilder
+
extends Object A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+beforeId
+
+Sets the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+beforeId
+
+Sets (or unsets) the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets (or unsets) the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
AgentIngresses.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+AgentIngresses
+public class AgentIngresses.UpdateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of the use of this Agent Ingress.
+
+
+
+
+
human-readable description of the use of this Agent Ingress.
+
+
+
+
+
arbitrary user-defined machine-readable data of this Agent Ingress.
+
+
+
+
+
arbitrary user-defined machine-readable data of this Agent Ingress.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of the use of this Agent Ingress. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of the use of this Agent Ingress. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+AgentIngressThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
AgentIngresses (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class AgentIngresses
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for AgentIngresses.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Create a new Agent Ingress.
+
+
+
+
+
+
+
+
Get the details of an Agent Ingress by ID.
+
+
+
+
+
+
+
+
Update attributes of an Agent Ingress by ID.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+AgentIngresses
+
+Creates a new sub-client for AgentIngresses.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+create
+
+
+
+Parameters:
+domain - the domain that you own to be used as the base domain name to generate regional agent ingress domains.Returns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+list
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+update
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
ApiKeys.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+ApiKeys
+public class ApiKeys.CreateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Create API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of what uses the API key to authenticate.
+
+
+
+
+
human-readable description of what uses the API key to authenticate.
+
+
+
+
+
arbitrary user-defined data of this API key.
+
+
+
+
+
arbitrary user-defined data of this API key.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of what uses the API key to authenticate. optional,
+ max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of what uses the API key to authenticate. optional,
+ max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+ApiKeyThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
ApiKeys.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+ApiKeys
+public class ApiKeys.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
ApiKeys.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+ApiKeys
+public class ApiKeys.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+ApiKeyThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
ApiKeys.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+ApiKeys
+public class ApiKeys.ListCallBuilder
+
extends Object A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+beforeId
+
+Sets the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+beforeId
+
+Sets (or unsets) the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets (or unsets) the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+a PageApiKeyList
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
ApiKeys.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+ApiKeys
+public class ApiKeys.UpdateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of what uses the API key to authenticate.
+
+
+
+
+
human-readable description of what uses the API key to authenticate.
+
+
+
+
+
arbitrary user-defined data of this API key.
+
+
+
+
+
arbitrary user-defined data of this API key.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of what uses the API key to authenticate. optional,
+ max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of what uses the API key to authenticate. optional,
+ max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+ApiKeyThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
ApiKeys (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class ApiKeys
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for ApiKeys.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Get the details of an API key by ID.
+
+
+
+
+
+
+
+
Update attributes of an API key by ID.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+ApiKeys
+
+Creates a new sub-client for ApiKeys.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+create
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+list
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+update
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
CertificateAuthorities.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+CertificateAuthorities
+public class CertificateAuthorities.CreateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Create API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of this Certificate Authority.
+
+
+
+
+
human-readable description of this Certificate Authority.
+
+
+
+
+
arbitrary user-defined machine-readable data of this Certificate Authority.
+
+
+
+
+
arbitrary user-defined machine-readable data of this Certificate Authority.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of this Certificate Authority. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of this Certificate Authority. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
CertificateAuthorities.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+CertificateAuthorities
+public class CertificateAuthorities.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
CertificateAuthorities.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+CertificateAuthorities
+public class CertificateAuthorities.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+
CertificateAuthorities.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+CertificateAuthorities
+public class CertificateAuthorities.ListCallBuilder
+
extends Object A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+beforeId
+
+Sets the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+beforeId
+
+Sets (or unsets) the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets (or unsets) the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
CertificateAuthorities.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+CertificateAuthorities
+public class CertificateAuthorities.UpdateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of this Certificate Authority.
+
+
+
+
+
human-readable description of this Certificate Authority.
+
+
+
+
+
arbitrary user-defined machine-readable data of this Certificate Authority.
+
+
+
+
+
arbitrary user-defined machine-readable data of this Certificate Authority.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of this Certificate Authority. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of this Certificate Authority. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
CertificateAuthorities (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class CertificateAuthorities
+
extends Object Certificate Authorities are x509 certificates that are used to sign other
+ x509 certificates. Attach a Certificate Authority to the Mutual TLS module
+ to verify that the TLS certificate presented by a client has been signed by
+ this CA. Certificate Authorities are used only for mTLS validation only and
+ thus a private key is not included in the resource.
+
+ See also
https://ngrok.com/docs/api#api-certificate-authorities .
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for CertificateAuthorities.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+CertificateAuthorities
+
+Creates a new sub-client for CertificateAuthorities.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+create
+
+
+
+Parameters:
+caPem - raw PEM of the Certificate AuthorityReturns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+list
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+update
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
Credentials.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+Credentials
+public class Credentials.CreateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Create API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
optional list of ACL rules.
+
+
+
+
+
optional list of ACL rules.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of who or what will use the credential to
+ authenticate.
+
+
+
+
+
human-readable description of who or what will use the credential to
+ authenticate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this credential.
+
+
+
+
+
arbitrary user-defined machine-readable data of this credential.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of who or what will use the credential to
+ authenticate. Optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of who or what will use the credential to
+ authenticate. Optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+acl
+
+optional list of ACL rules. If unspecified, the credential will have no
+ restrictions. The only allowed ACL rule at this time is the bind
+ rule. The bind 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
+ bind:example.ngrok.io. Bind rules may specify a leading wildcard to
+ match multiple domains with a common suffix. For example, you may specify a rule
+ of bind:*.example.com which will allow x.example.com,
+ y.example.com, *.example.com, etc. A rule of
+ '*' is equivalent to no acl at all and will explicitly permit all
+ actions.
+
+Parameters:
+acl - the value of the acl parameter as a List <String >Returns:
+the call builder instance
+
+
+
+
+
+acl
+
+optional list of ACL rules. If unspecified, the credential will have no
+ restrictions. The only allowed ACL rule at this time is the bind
+ rule. The bind 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
+ bind:example.ngrok.io. Bind rules may specify a leading wildcard to
+ match multiple domains with a common suffix. For example, you may specify a rule
+ of bind:*.example.com which will allow x.example.com,
+ y.example.com, *.example.com, etc. A rule of
+ '*' is equivalent to no acl at all and will explicitly permit all
+ actions.
+
+Parameters:
+acl - the value of the acl parameter as an OptionalList <String >Returns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+CredentialThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
Credentials.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+Credentials
+public class Credentials.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
Credentials.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+Credentials
+public class Credentials.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+CredentialThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
Credentials.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+Credentials
+public class Credentials.ListCallBuilder
+
extends Object A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+beforeId
+
+Sets the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+beforeId
+
+Sets (or unsets) the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets (or unsets) the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Credentials.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+Credentials
+public class Credentials.UpdateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
optional list of ACL rules.
+
+
+
+
+
optional list of ACL rules.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of who or what will use the credential to
+ authenticate.
+
+
+
+
+
human-readable description of who or what will use the credential to
+ authenticate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this credential.
+
+
+
+
+
arbitrary user-defined machine-readable data of this credential.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of who or what will use the credential to
+ authenticate. Optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of who or what will use the credential to
+ authenticate. Optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+acl
+
+optional list of ACL rules. If unspecified, the credential will have no
+ restrictions. The only allowed ACL rule at this time is the bind
+ rule. The bind 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
+ bind:example.ngrok.io. Bind rules may specify a leading wildcard to
+ match multiple domains with a common suffix. For example, you may specify a rule
+ of bind:*.example.com which will allow x.example.com,
+ y.example.com, *.example.com, etc. A rule of
+ '*' is equivalent to no acl at all and will explicitly permit all
+ actions.
+
+Parameters:
+acl - the value of the acl parameter as a List <String >Returns:
+the call builder instance
+
+
+
+
+
+acl
+
+optional list of ACL rules. If unspecified, the credential will have no
+ restrictions. The only allowed ACL rule at this time is the bind
+ rule. The bind 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
+ bind:example.ngrok.io. Bind rules may specify a leading wildcard to
+ match multiple domains with a common suffix. For example, you may specify a rule
+ of bind:*.example.com which will allow x.example.com,
+ y.example.com, *.example.com, etc. A rule of
+ '*' is equivalent to no acl at all and will explicitly permit all
+ actions.
+
+Parameters:
+acl - the value of the acl parameter as an OptionalList <String >Returns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+CredentialThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
Credentials (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class Credentials
+
extends Object Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
+ agent to connect the ngrok service as your account. They are installed with
+ the
ngrok authtoken command or by specifying it in the
+
ngrok.yml
+ configuration file with the
authtoken property.
+
+ See also
https://ngrok.com/docs/api#api-credentials .
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for Credentials.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Create a new tunnel authtoken credential.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+Credentials
+
+Creates a new sub-client for Credentials.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+create
+
+Create a new tunnel authtoken credential. This authtoken credential can be used
+ to start a new tunnel session. The response to this API call is the only time
+ the generated token is available. If you need it for future use, you must save
+ it securely yourself.
+
+ See also
https://ngrok.com/docs/api#api-credentials-create .
+Returns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+list
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+update
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointCircuitBreakerModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.EndpointCircuitBreakerModule.DeleteCallBuilder
+
+
+Enclosing class:
+EndpointCircuitBreakerModule
+public class EndpointCircuitBreakerModule.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointCircuitBreakerModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.EndpointCircuitBreakerModule.GetCallBuilder
+
+
+Enclosing class:
+EndpointCircuitBreakerModule
+public class EndpointCircuitBreakerModule.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+
EndpointCircuitBreakerModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.EndpointCircuitBreakerModule.ReplaceCallBuilder
+
+
+Enclosing class:
+EndpointCircuitBreakerModule
+public class EndpointCircuitBreakerModule.ReplaceCallBuilder
+
extends Object A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+module
+
+Sets the module parameter.
+
+Parameters:
+module - the value of the module parameter as a EndpointCircuitBreakerReturns:
+the call builder instance
+
+
+
+
+
+module
+
+Sets (or unsets) the module parameter.
+
+Parameters:
+module - the value of the module parameter as an OptionalEndpointCircuitBreakerReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointCircuitBreakerModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointCircuitBreakerModule
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for EndpointCircuitBreakerModule.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EndpointCircuitBreakerModule
+
+Creates a new sub-client for EndpointCircuitBreakerModule.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+replace
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointCompressionModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.EndpointCompressionModule.DeleteCallBuilder
+
+
+Enclosing class:
+EndpointCompressionModule
+public class EndpointCompressionModule.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointCompressionModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointCompressionModule
+public class EndpointCompressionModule.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+
EndpointCompressionModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.EndpointCompressionModule.ReplaceCallBuilder
+
+
+Enclosing class:
+EndpointCompressionModule
+public class EndpointCompressionModule.ReplaceCallBuilder
+
extends Object A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+module
+
+Sets the module parameter.
+
+Parameters:
+module - the value of the module parameter as a EndpointCompressionReturns:
+the call builder instance
+
+
+
+
+
+module
+
+Sets (or unsets) the module parameter.
+
+Parameters:
+module - the value of the module parameter as an OptionalEndpointCompressionReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointCompressionModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointCompressionModule
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for EndpointCompressionModule.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EndpointCompressionModule
+
+Creates a new sub-client for EndpointCompressionModule.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+replace
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointConfigurations.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointConfigurations
+public class EndpointConfigurations.CreateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Create API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
circuit breaker module configuration or null
+
+
+
+
+
circuit breaker module configuration or null
+
+
+
+
+
compression module configuration or null
+
+
+
+
+
compression module configuration or null
+
+
+
+
+
human-readable description of what this endpoint configuration will be do when
+ applied or what traffic it will be applied to.
+
+
+
+
+
human-readable description of what this endpoint configuration will be do when
+ applied or what traffic it will be applied to.
+
+
+
+
+
ip policy module configuration or null
+
+
+
+
+
ip policy module configuration or null
+
+
+
+
+
logging module configuration or null
+
+
+
+
+
logging module configuration or null
+
+
+
+
+
arbitrary user-defined machine-readable data of this endpoint configuration.
+
+
+
+
+
arbitrary user-defined machine-readable data of this endpoint configuration.
+
+
+
+
+
mutual TLS module configuration or null
+
+
+
+
+
mutual TLS module configuration or null
+
+
+
+
+
oauth module configuration or null
+
+
+
+
+
oauth module configuration or null
+
+
+
+
+
oidc module configuration or null
+
+
+
+
+
oidc module configuration or null
+
+
+
+
+
request headers module configuration or null
+
+
+
+
+
request headers module configuration or null
+
+
+
+
+
response headers module configuration or null
+
+
+
+
+
response headers module configuration or null
+
+
+
+
+
saml module configuration or null
+
+
+
+
+
saml module configuration or null
+
+
+
+
+
TLS termination module configuration or null
+
+
+
+
+
TLS termination module configuration or null
+
+
+
+
+
they type of traffic this endpoint configuration can be applied to.
+
+
+
+
+
they type of traffic this endpoint configuration can be applied to.
+
+
+
+
+
webhook validation module configuration or null
+
+
+
+
+
webhook validation module configuration or null
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+type
+
+they type of traffic this endpoint configuration can be applied to. one of:
+ http, https, tcp
+
+Parameters:
+type - the value of the type parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+type
+
+they type of traffic this endpoint configuration can be applied to. one of:
+ http, https, tcp
+
+Parameters:
+type - the value of the type parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of what this endpoint configuration will be do when
+ applied or what traffic it will be applied to. Optional, max 255 bytes
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of what this endpoint configuration will be do when
+ applied or what traffic it will be applied to. Optional, max 255 bytes
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+circuitBreaker
+
+circuit breaker module configuration or null
+
+Parameters:
+circuitBreaker - the value of the circuit_breaker parameter as a EndpointCircuitBreakerReturns:
+the call builder instance
+
+
+
+
+
+circuitBreaker
+
+circuit breaker module configuration or null
+
+Parameters:
+circuitBreaker - the value of the circuit_breaker parameter as an OptionalEndpointCircuitBreakerReturns:
+the call builder instance
+
+
+
+
+
+compression
+
+compression module configuration or null
+
+Parameters:
+compression - the value of the compression parameter as a EndpointCompressionReturns:
+the call builder instance
+
+
+
+
+
+compression
+
+compression module configuration or null
+
+Parameters:
+compression - the value of the compression parameter as an OptionalEndpointCompressionReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ipPolicy
+
+ip policy module configuration or null
+
+Parameters:
+ipPolicy - the value of the ip_policy parameter as a EndpointIpPolicyMutateReturns:
+the call builder instance
+
+
+
+
+
+ipPolicy
+
+ip policy module configuration or null
+
+Parameters:
+ipPolicy - the value of the ip_policy parameter as an OptionalEndpointIpPolicyMutateReturns:
+the call builder instance
+
+
+
+
+
+mutualTls
+
+mutual TLS module configuration or null
+
+Parameters:
+mutualTls - the value of the mutual_tls parameter as a EndpointMutualTlsMutateReturns:
+the call builder instance
+
+
+
+
+
+mutualTls
+
+mutual TLS module configuration or null
+
+Parameters:
+mutualTls - the value of the mutual_tls parameter as an OptionalEndpointMutualTlsMutateReturns:
+the call builder instance
+
+
+
+
+
+tlsTermination
+
+TLS termination module configuration or null
+
+Parameters:
+tlsTermination - the value of the tls_termination parameter as a EndpointTlsTerminationReturns:
+the call builder instance
+
+
+
+
+
+tlsTermination
+
+TLS termination module configuration or null
+
+Parameters:
+tlsTermination - the value of the tls_termination parameter as an OptionalEndpointTlsTerminationReturns:
+the call builder instance
+
+
+
+
+
+webhookValidation
+
+webhook validation module configuration or null
+
+Parameters:
+webhookValidation - the value of the webhook_validation parameter as a EndpointWebhookValidationReturns:
+the call builder instance
+
+
+
+
+
+webhookValidation
+
+webhook validation module configuration or null
+
+Parameters:
+webhookValidation - the value of the webhook_validation parameter as an OptionalEndpointWebhookValidationReturns:
+the call builder instance
+
+
+
+
+
+oauth
+
+oauth module configuration or null
+
+Parameters:
+oauth - the value of the oauth parameter as a EndpointOAuthReturns:
+the call builder instance
+
+
+
+
+
+oauth
+
+oauth module configuration or null
+
+Parameters:
+oauth - the value of the oauth parameter as an OptionalEndpointOAuthReturns:
+the call builder instance
+
+
+
+
+
+logging
+
+logging module configuration or null
+
+Parameters:
+logging - the value of the logging parameter as a EndpointLoggingMutateReturns:
+the call builder instance
+
+
+
+
+
+logging
+
+logging module configuration or null
+
+Parameters:
+logging - the value of the logging parameter as an OptionalEndpointLoggingMutateReturns:
+the call builder instance
+
+
+
+
+
+saml
+
+saml module configuration or null
+
+Parameters:
+saml - the value of the saml parameter as a EndpointSamlMutateReturns:
+the call builder instance
+
+
+
+
+
+saml
+
+saml module configuration or null
+
+Parameters:
+saml - the value of the saml parameter as an OptionalEndpointSamlMutateReturns:
+the call builder instance
+
+
+
+
+
+oidc
+
+oidc module configuration or null
+
+Parameters:
+oidc - the value of the oidc parameter as a EndpointOidcReturns:
+the call builder instance
+
+
+
+
+
+oidc
+
+oidc module configuration or null
+
+Parameters:
+oidc - the value of the oidc parameter as an OptionalEndpointOidcReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointConfigurations.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointConfigurations
+public class EndpointConfigurations.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointConfigurations.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointConfigurations
+public class EndpointConfigurations.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+
EndpointConfigurations.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointConfigurations
+public class EndpointConfigurations.ListCallBuilder
+
extends Object A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+beforeId
+
+Sets the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+beforeId
+
+Sets (or unsets) the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets (or unsets) the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointConfigurations.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointConfigurations
+public class EndpointConfigurations.UpdateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
circuit breaker module configuration or null
+
+
+
+
+
circuit breaker module configuration or null
+
+
+
+
+
compression module configuration or null
+
+
+
+
+
compression module configuration or null
+
+
+
+
+
human-readable description of what this endpoint configuration will be do when
+ applied or what traffic it will be applied to.
+
+
+
+
+
human-readable description of what this endpoint configuration will be do when
+ applied or what traffic it will be applied to.
+
+
+
+
+
ip policy module configuration or null
+
+
+
+
+
ip policy module configuration or null
+
+
+
+
+
logging module configuration or null
+
+
+
+
+
logging module configuration or null
+
+
+
+
+
arbitrary user-defined machine-readable data of this endpoint configuration.
+
+
+
+
+
arbitrary user-defined machine-readable data of this endpoint configuration.
+
+
+
+
+
mutual TLS module configuration or null
+
+
+
+
+
mutual TLS module configuration or null
+
+
+
+
+
oauth module configuration or null
+
+
+
+
+
oauth module configuration or null
+
+
+
+
+
oidc module configuration or null
+
+
+
+
+
oidc module configuration or null
+
+
+
+
+
request headers module configuration or null
+
+
+
+
+
request headers module configuration or null
+
+
+
+
+
response headers module configuration or null
+
+
+
+
+
response headers module configuration or null
+
+
+
+
+
saml module configuration or null
+
+
+
+
+
saml module configuration or null
+
+
+
+
+
TLS termination module configuration or null
+
+
+
+
+
TLS termination module configuration or null
+
+
+
+
+
webhook validation module configuration or null
+
+
+
+
+
webhook validation module configuration or null
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of what this endpoint configuration will be do when
+ applied or what traffic it will be applied to. Optional, max 255 bytes
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of what this endpoint configuration will be do when
+ applied or what traffic it will be applied to. Optional, max 255 bytes
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+circuitBreaker
+
+circuit breaker module configuration or null
+
+Parameters:
+circuitBreaker - the value of the circuit_breaker parameter as a EndpointCircuitBreakerReturns:
+the call builder instance
+
+
+
+
+
+circuitBreaker
+
+circuit breaker module configuration or null
+
+Parameters:
+circuitBreaker - the value of the circuit_breaker parameter as an OptionalEndpointCircuitBreakerReturns:
+the call builder instance
+
+
+
+
+
+compression
+
+compression module configuration or null
+
+Parameters:
+compression - the value of the compression parameter as a EndpointCompressionReturns:
+the call builder instance
+
+
+
+
+
+compression
+
+compression module configuration or null
+
+Parameters:
+compression - the value of the compression parameter as an OptionalEndpointCompressionReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ipPolicy
+
+ip policy module configuration or null
+
+Parameters:
+ipPolicy - the value of the ip_policy parameter as a EndpointIpPolicyMutateReturns:
+the call builder instance
+
+
+
+
+
+ipPolicy
+
+ip policy module configuration or null
+
+Parameters:
+ipPolicy - the value of the ip_policy parameter as an OptionalEndpointIpPolicyMutateReturns:
+the call builder instance
+
+
+
+
+
+mutualTls
+
+mutual TLS module configuration or null
+
+Parameters:
+mutualTls - the value of the mutual_tls parameter as a EndpointMutualTlsMutateReturns:
+the call builder instance
+
+
+
+
+
+mutualTls
+
+mutual TLS module configuration or null
+
+Parameters:
+mutualTls - the value of the mutual_tls parameter as an OptionalEndpointMutualTlsMutateReturns:
+the call builder instance
+
+
+
+
+
+tlsTermination
+
+TLS termination module configuration or null
+
+Parameters:
+tlsTermination - the value of the tls_termination parameter as a EndpointTlsTerminationReturns:
+the call builder instance
+
+
+
+
+
+tlsTermination
+
+TLS termination module configuration or null
+
+Parameters:
+tlsTermination - the value of the tls_termination parameter as an OptionalEndpointTlsTerminationReturns:
+the call builder instance
+
+
+
+
+
+webhookValidation
+
+webhook validation module configuration or null
+
+Parameters:
+webhookValidation - the value of the webhook_validation parameter as a EndpointWebhookValidationReturns:
+the call builder instance
+
+
+
+
+
+webhookValidation
+
+webhook validation module configuration or null
+
+Parameters:
+webhookValidation - the value of the webhook_validation parameter as an OptionalEndpointWebhookValidationReturns:
+the call builder instance
+
+
+
+
+
+oauth
+
+oauth module configuration or null
+
+Parameters:
+oauth - the value of the oauth parameter as a EndpointOAuthReturns:
+the call builder instance
+
+
+
+
+
+oauth
+
+oauth module configuration or null
+
+Parameters:
+oauth - the value of the oauth parameter as an OptionalEndpointOAuthReturns:
+the call builder instance
+
+
+
+
+
+logging
+
+logging module configuration or null
+
+Parameters:
+logging - the value of the logging parameter as a EndpointLoggingMutateReturns:
+the call builder instance
+
+
+
+
+
+logging
+
+logging module configuration or null
+
+Parameters:
+logging - the value of the logging parameter as an OptionalEndpointLoggingMutateReturns:
+the call builder instance
+
+
+
+
+
+saml
+
+saml module configuration or null
+
+Parameters:
+saml - the value of the saml parameter as a EndpointSamlMutateReturns:
+the call builder instance
+
+
+
+
+
+saml
+
+saml module configuration or null
+
+Parameters:
+saml - the value of the saml parameter as an OptionalEndpointSamlMutateReturns:
+the call builder instance
+
+
+
+
+
+oidc
+
+oidc module configuration or null
+
+Parameters:
+oidc - the value of the oidc parameter as a EndpointOidcReturns:
+the call builder instance
+
+
+
+
+
+oidc
+
+oidc module configuration or null
+
+Parameters:
+oidc - the value of the oidc parameter as an OptionalEndpointOidcReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointConfigurations (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointConfigurations
+
extends Object Endpoint Configurations are a reusable group of modules that encapsulate how
+ traffic to a domain or address is handled. Endpoint configurations are only
+ applied to Domains and TCP Addresses they have been attached to.
+
+ See also
https://ngrok.com/docs/api#api-endpoint-configurations .
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for EndpointConfigurations.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
Delete an endpoint configuration.
+
+
+
+
+
+
+
+
+
+
+
Updates an endpoint configuration.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EndpointConfigurations
+
+Creates a new sub-client for EndpointConfigurations.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+create
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+list
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+update
+
+Updates an endpoint configuration. If a module is not specified in the update,
+ it will not be modified. However, each module configuration that is specified
+ will completely replace the existing value. There is no way to delete an
+ existing module via this API, instead use the delete module API.
+
+ See also
https://ngrok.com/docs/api#api-endpoint-configurations-update .
+Parameters:
+id - unique identifier of this endpoint configurationReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointIpPolicyModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointIpPolicyModule
+public class EndpointIpPolicyModule.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointIpPolicyModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointIpPolicyModule
+public class EndpointIpPolicyModule.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+EndpointIpPolicyThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointIpPolicyModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.EndpointIpPolicyModule.ReplaceCallBuilder
+
+
+Enclosing class:
+EndpointIpPolicyModule
+public class EndpointIpPolicyModule.ReplaceCallBuilder
+
extends Object A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+module
+
+Sets the module parameter.
+
+Parameters:
+module - the value of the module parameter as a EndpointIpPolicyMutateReturns:
+the call builder instance
+
+
+
+
+
+module
+
+Sets (or unsets) the module parameter.
+
+Parameters:
+module - the value of the module parameter as an OptionalEndpointIpPolicyMutateReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+EndpointIpPolicyThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointIpPolicyModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointIpPolicyModule
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for EndpointIpPolicyModule.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EndpointIpPolicyModule
+
+Creates a new sub-client for EndpointIpPolicyModule.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+replace
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointLoggingModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointLoggingModule
+public class EndpointLoggingModule.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointLoggingModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointLoggingModule
+public class EndpointLoggingModule.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+EndpointLoggingThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointLoggingModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointLoggingModule
+public class EndpointLoggingModule.ReplaceCallBuilder
+
extends Object A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+module
+
+Sets the module parameter.
+
+Parameters:
+module - the value of the module parameter as a EndpointLoggingMutateReturns:
+the call builder instance
+
+
+
+
+
+module
+
+Sets (or unsets) the module parameter.
+
+Parameters:
+module - the value of the module parameter as an OptionalEndpointLoggingMutateReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+EndpointLoggingThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointLoggingModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointLoggingModule
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for EndpointLoggingModule.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EndpointLoggingModule
+
+Creates a new sub-client for EndpointLoggingModule.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+replace
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointMutualTlsModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.EndpointMutualTlsModule.DeleteCallBuilder
+
+
+Enclosing class:
+EndpointMutualTlsModule
+public class EndpointMutualTlsModule.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointMutualTlsModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointMutualTlsModule
+public class EndpointMutualTlsModule.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+
EndpointMutualTlsModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.EndpointMutualTlsModule.ReplaceCallBuilder
+
+
+Enclosing class:
+EndpointMutualTlsModule
+public class EndpointMutualTlsModule.ReplaceCallBuilder
+
extends Object A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+module
+
+Sets the module parameter.
+
+Parameters:
+module - the value of the module parameter as a EndpointMutualTlsMutateReturns:
+the call builder instance
+
+
+
+
+
+module
+
+Sets (or unsets) the module parameter.
+
+Parameters:
+module - the value of the module parameter as an OptionalEndpointMutualTlsMutateReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointMutualTlsModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointMutualTlsModule
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for EndpointMutualTlsModule.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EndpointMutualTlsModule
+
+Creates a new sub-client for EndpointMutualTlsModule.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+replace
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuthModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointOAuthModule
+public class EndpointOAuthModule.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuthModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointOAuthModule
+public class EndpointOAuthModule.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+EndpointOAuthThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuthModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointOAuthModule
+public class EndpointOAuthModule.ReplaceCallBuilder
+
extends Object A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+module
+
+Sets the module parameter.
+
+Parameters:
+module - the value of the module parameter as a EndpointOAuthReturns:
+the call builder instance
+
+
+
+
+
+module
+
+Sets (or unsets) the module parameter.
+
+Parameters:
+module - the value of the module parameter as an OptionalEndpointOAuthReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+EndpointOAuthThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOAuthModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointOAuthModule
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for EndpointOAuthModule.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EndpointOAuthModule
+
+Creates a new sub-client for EndpointOAuthModule.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+replace
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOidcModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointOidcModule
+public class EndpointOidcModule.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOidcModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointOidcModule
+public class EndpointOidcModule.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+EndpointOidcThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOidcModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointOidcModule
+public class EndpointOidcModule.ReplaceCallBuilder
+
extends Object A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+module
+
+Sets the module parameter.
+
+Parameters:
+module - the value of the module parameter as a EndpointOidcReturns:
+the call builder instance
+
+
+
+
+
+module
+
+Sets (or unsets) the module parameter.
+
+Parameters:
+module - the value of the module parameter as an OptionalEndpointOidcReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+EndpointOidcThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointOidcModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointOidcModule
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for EndpointOidcModule.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EndpointOidcModule
+
+Creates a new sub-client for EndpointOidcModule.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+replace
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointRequestHeadersModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.EndpointRequestHeadersModule.DeleteCallBuilder
+
+
+Enclosing class:
+EndpointRequestHeadersModule
+public class EndpointRequestHeadersModule.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointRequestHeadersModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.EndpointRequestHeadersModule.GetCallBuilder
+
+
+Enclosing class:
+EndpointRequestHeadersModule
+public class EndpointRequestHeadersModule.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+
EndpointRequestHeadersModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.EndpointRequestHeadersModule.ReplaceCallBuilder
+
+
+Enclosing class:
+EndpointRequestHeadersModule
+public class EndpointRequestHeadersModule.ReplaceCallBuilder
+
extends Object A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+module
+
+Sets (or unsets) the module parameter.
+
+Parameters:
+module - the value of the module parameter as an OptionalEndpointRequestHeadersReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointRequestHeadersModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointRequestHeadersModule
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for EndpointRequestHeadersModule.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EndpointRequestHeadersModule
+
+Creates a new sub-client for EndpointRequestHeadersModule.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+replace
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointResponseHeadersModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.EndpointResponseHeadersModule.DeleteCallBuilder
+
+
+Enclosing class:
+EndpointResponseHeadersModule
+public class EndpointResponseHeadersModule.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointResponseHeadersModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.EndpointResponseHeadersModule.GetCallBuilder
+
+
+Enclosing class:
+EndpointResponseHeadersModule
+public class EndpointResponseHeadersModule.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+
EndpointResponseHeadersModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.EndpointResponseHeadersModule.ReplaceCallBuilder
+
+
+Enclosing class:
+EndpointResponseHeadersModule
+public class EndpointResponseHeadersModule.ReplaceCallBuilder
+
extends Object A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+module
+
+Sets (or unsets) the module parameter.
+
+Parameters:
+module - the value of the module parameter as an OptionalEndpointResponseHeadersReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointResponseHeadersModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointResponseHeadersModule
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for EndpointResponseHeadersModule.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EndpointResponseHeadersModule
+
+Creates a new sub-client for EndpointResponseHeadersModule.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+replace
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointSamlModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointSamlModule
+public class EndpointSamlModule.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointSamlModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointSamlModule
+public class EndpointSamlModule.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+EndpointSamlThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointSamlModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EndpointSamlModule
+public class EndpointSamlModule.ReplaceCallBuilder
+
extends Object A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+module
+
+Sets the module parameter.
+
+Parameters:
+module - the value of the module parameter as a EndpointSamlMutateReturns:
+the call builder instance
+
+
+
+
+
+module
+
+Sets (or unsets) the module parameter.
+
+Parameters:
+module - the value of the module parameter as an OptionalEndpointSamlMutateReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+EndpointSamlThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointSamlModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointSamlModule
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for EndpointSamlModule.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EndpointSamlModule
+
+Creates a new sub-client for EndpointSamlModule.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+replace
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointTlsTerminationModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.EndpointTlsTerminationModule.DeleteCallBuilder
+
+
+Enclosing class:
+EndpointTlsTerminationModule
+public class EndpointTlsTerminationModule.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointTlsTerminationModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.EndpointTlsTerminationModule.GetCallBuilder
+
+
+Enclosing class:
+EndpointTlsTerminationModule
+public class EndpointTlsTerminationModule.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+
EndpointTlsTerminationModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.EndpointTlsTerminationModule.ReplaceCallBuilder
+
+
+Enclosing class:
+EndpointTlsTerminationModule
+public class EndpointTlsTerminationModule.ReplaceCallBuilder
+
extends Object A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+module
+
+Sets the module parameter.
+
+Parameters:
+module - the value of the module parameter as a EndpointTlsTerminationReturns:
+the call builder instance
+
+
+
+
+
+module
+
+Sets (or unsets) the module parameter.
+
+Parameters:
+module - the value of the module parameter as an OptionalEndpointTlsTerminationReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointTlsTerminationModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointTlsTerminationModule
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for EndpointTlsTerminationModule.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EndpointTlsTerminationModule
+
+Creates a new sub-client for EndpointTlsTerminationModule.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+replace
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointWebhookValidationModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.EndpointWebhookValidationModule.DeleteCallBuilder
+
+
+Enclosing class:
+EndpointWebhookValidationModule
+public class EndpointWebhookValidationModule.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EndpointWebhookValidationModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.EndpointWebhookValidationModule.GetCallBuilder
+
+
+Enclosing class:
+EndpointWebhookValidationModule
+public class EndpointWebhookValidationModule.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+
EndpointWebhookValidationModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.EndpointWebhookValidationModule.ReplaceCallBuilder
+
+
+Enclosing class:
+EndpointWebhookValidationModule
+public class EndpointWebhookValidationModule.ReplaceCallBuilder
+
extends Object A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+module
+
+Sets the module parameter.
+
+Parameters:
+module - the value of the module parameter as a EndpointWebhookValidationReturns:
+the call builder instance
+
+
+
+
+
+module
+
+Sets (or unsets) the module parameter.
+
+Parameters:
+module - the value of the module parameter as an OptionalEndpointWebhookValidationReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointWebhookValidationModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EndpointWebhookValidationModule
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for EndpointWebhookValidationModule.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EndpointWebhookValidationModule
+
+Creates a new sub-client for EndpointWebhookValidationModule.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+replace
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
EventDestinations.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EventDestinations
+public class EventDestinations.CreateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Create API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Human-readable description of the Event Destination.
+
+
+
+
+
Human-readable description of the Event Destination.
+
+
+
+
+
The output format you would like to serialize events into when sending to their
+ target.
+
+
+
+
+
The output format you would like to serialize events into when sending to their
+ target.
+
+
+
+
+
Arbitrary user-defined machine-readable data of this Event Destination.
+
+
+
+
+
Arbitrary user-defined machine-readable data of this Event Destination.
+
+
+
+
+
An object that encapsulates where and how to send your events.
+
+
+
+
+
An object that encapsulates where and how to send your events.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+
+
+
+description
+
+Human-readable description of the Event Destination. Optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+Human-readable description of the Event Destination. Optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+target
+
+An object that encapsulates where and how to send your events. An event
+ destination must contain exactly one of the following objects, leaving the rest
+ null: kinesis, firehose, cloudwatch_logs,
+ or s3.
+
+Parameters:
+target - the value of the target parameter as a EventTargetReturns:
+the call builder instance
+
+
+
+
+
+target
+
+An object that encapsulates where and how to send your events. An event
+ destination must contain exactly one of the following objects, leaving the rest
+ null: kinesis, firehose, cloudwatch_logs,
+ or s3.
+
+Parameters:
+target - the value of the target parameter as an OptionalEventTargetReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+EventDestinationThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EventDestinations.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EventDestinations
+public class EventDestinations.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EventDestinations.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EventDestinations
+public class EventDestinations.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+EventDestinationThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EventDestinations.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EventDestinations
+public class EventDestinations.ListCallBuilder
+
extends Object A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+beforeId
+
+Sets the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+beforeId
+
+Sets (or unsets) the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets (or unsets) the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventDestinations.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EventDestinations
+public class EventDestinations.UpdateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Human-readable description of the Event Destination.
+
+
+
+
+
Human-readable description of the Event Destination.
+
+
+
+
+
The output format you would like to serialize events into when sending to their
+ target.
+
+
+
+
+
The output format you would like to serialize events into when sending to their
+ target.
+
+
+
+
+
Arbitrary user-defined machine-readable data of this Event Destination.
+
+
+
+
+
Arbitrary user-defined machine-readable data of this Event Destination.
+
+
+
+
+
An object that encapsulates where and how to send your events.
+
+
+
+
+
An object that encapsulates where and how to send your events.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+
+
+
+description
+
+Human-readable description of the Event Destination. Optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+Human-readable description of the Event Destination. Optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+target
+
+An object that encapsulates where and how to send your events. An event
+ destination must contain exactly one of the following objects, leaving the rest
+ null: kinesis, firehose, cloudwatch_logs,
+ or s3.
+
+Parameters:
+target - the value of the target parameter as a EventTargetReturns:
+the call builder instance
+
+
+
+
+
+target
+
+An object that encapsulates where and how to send your events. An event
+ destination must contain exactly one of the following objects, leaving the rest
+ null: kinesis, firehose, cloudwatch_logs,
+ or s3.
+
+Parameters:
+target - the value of the target parameter as an OptionalEventTargetReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+EventDestinationThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EventDestinations (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EventDestinations
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for EventDestinations.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Create a new Event Destination.
+
+
+
+
+
Delete an Event Destination.
+
+
+
+
+
Get detailed information about an Event Destination by ID.
+
+
+
+
+
List all Event Destinations on this account.
+
+
+
+
+
Update attributes of an Event Destination.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EventDestinations
+
+Creates a new sub-client for EventDestinations.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+create
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+list
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+update
+
+
+
+Parameters:
+id - Unique identifier for this Event Destination.Returns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
EventSources.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EventSources
+public class EventSources.CreateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Create API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Type of event for which an event subscription will trigger
+
+
+
+
+
Type of event for which an event subscription will trigger
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+type
+
+Type of event for which an event subscription will trigger
+
+Parameters:
+type - the value of the type parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+type
+
+Type of event for which an event subscription will trigger
+
+Parameters:
+type - the value of the type parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+EventSourceThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EventSources.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EventSources
+public class EventSources.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EventSources.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EventSources
+public class EventSources.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+EventSourceThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EventSources.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EventSources
+public class EventSources.ListCallBuilder
+
extends Object A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+EventSourceListThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EventSources.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EventSources
+public class EventSources.UpdateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+EventSourceThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EventSources (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EventSources
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for EventSources.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EventSources
+
+Creates a new sub-client for EventSources.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+create
+
+
+
+Parameters:
+subscriptionId - The unique identifier for the Event Subscription that this Event Source is attached to.Returns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+subscriptionId - The unique identifier for the Event Subscription that this Event Source is attached to.type - Type of event for which an event subscription will triggerReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+subscriptionId - The unique identifier for the Event Subscription that this Event Source is attached to.type - Type of event for which an event subscription will triggerReturns:
+a call builder for this API call
+
+
+
+
+
+list
+
+
+
+Parameters:
+subscriptionId - The unique identifier for the Event Subscription that this Event Source is attached to.Returns:
+a call builder for this API call
+
+
+
+
+
+update
+
+
+
+Parameters:
+subscriptionId - The unique identifier for the Event Subscription that this Event Source is attached to.type - Type of event for which an event subscription will triggerReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
EventStreams.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EventStreams
+public class EventStreams.CreateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Create API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Human-readable description of the Event Stream.
+
+
+
+
+
Human-readable description of the Event Stream.
+
+
+
+
+
A list of Event Destination IDs which should be used for this Event Stream.
+
+
+
+
+
A list of Event Destination IDs which should be used for this Event Stream.
+
+
+
+
+
The protocol that determines which events will be collected.
+
+
+
+
+
The protocol that determines which events will be collected.
+
+
+
+
+
A list of protocol-specific fields you want to collect on each event.
+
+
+
+
+
A list of protocol-specific fields you want to collect on each event.
+
+
+
+
+
Arbitrary user-defined machine-readable data of this Event Stream.
+
+
+
+
+
Arbitrary user-defined machine-readable data of this Event Stream.
+
+
+
+
+
The percentage of all events you would like to capture.
+
+
+
+
+
The percentage of all events you would like to capture.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+
+
+
+description
+
+Human-readable description of the Event Stream. Optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+Human-readable description of the Event Stream. Optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+fields
+
+A list of protocol-specific fields you want to collect on each event.
+
+Parameters:
+fields - the value of the fields parameter as a List <String >Returns:
+the call builder instance
+
+
+
+
+
+fields
+
+A list of protocol-specific fields you want to collect on each event.
+
+Parameters:
+fields - the value of the fields parameter as an OptionalList <String >Returns:
+the call builder instance
+
+
+
+
+
+eventType
+
+The protocol that determines which events will be collected. Supported values
+ are tcp_connection_closed and http_request_complete.
+
+Parameters:
+eventType - the value of the event_type parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+eventType
+
+The protocol that determines which events will be collected. Supported values
+ are tcp_connection_closed and http_request_complete.
+
+Parameters:
+eventType - the value of the event_type parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+destinationIds
+
+A list of Event Destination IDs which should be used for this Event Stream.
+ Event Streams are required to have at least one Event Destination.
+
+Parameters:
+destinationIds - the value of the destination_ids parameter as a List <String >Returns:
+the call builder instance
+
+
+
+
+
+destinationIds
+
+A list of Event Destination IDs which should be used for this Event Stream.
+ Event Streams are required to have at least one Event Destination.
+
+Parameters:
+destinationIds - the value of the destination_ids parameter as an OptionalList <String >Returns:
+the call builder instance
+
+
+
+
+
+samplingRate
+
+The percentage of all events you would like to capture. Valid values range from
+ 0.01, representing 1% of all events to 1.00, representing 100% of all events.
+
+Parameters:
+samplingRate - the value of the sampling_rate parameter as a doubleReturns:
+the call builder instance
+
+
+
+
+
+samplingRate
+
+The percentage of all events you would like to capture. Valid values range from
+ 0.01, representing 1% of all events to 1.00, representing 100% of all events.
+
+Parameters:
+samplingRate - the value of the sampling_rate parameter as an OptionaldoubleReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+EventStreamThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EventStreams.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EventStreams
+public class EventStreams.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EventStreams.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EventStreams
+public class EventStreams.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+EventStreamThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EventStreams.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EventStreams
+public class EventStreams.ListCallBuilder
+
extends Object A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+beforeId
+
+Sets the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+beforeId
+
+Sets (or unsets) the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets (or unsets) the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventStreams.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EventStreams
+public class EventStreams.UpdateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Human-readable description of the Event Stream.
+
+
+
+
+
Human-readable description of the Event Stream.
+
+
+
+
+
A list of Event Destination IDs which should be used for this Event Stream.
+
+
+
+
+
A list of Event Destination IDs which should be used for this Event Stream.
+
+
+
+
+
A list of protocol-specific fields you want to collect on each event.
+
+
+
+
+
A list of protocol-specific fields you want to collect on each event.
+
+
+
+
+
Arbitrary user-defined machine-readable data of this Event Stream.
+
+
+
+
+
Arbitrary user-defined machine-readable data of this Event Stream.
+
+
+
+
+
The percentage of all events you would like to capture.
+
+
+
+
+
The percentage of all events you would like to capture.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+
+
+
+description
+
+Human-readable description of the Event Stream. Optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+Human-readable description of the Event Stream. Optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+fields
+
+A list of protocol-specific fields you want to collect on each event.
+
+Parameters:
+fields - the value of the fields parameter as a List <String >Returns:
+the call builder instance
+
+
+
+
+
+fields
+
+A list of protocol-specific fields you want to collect on each event.
+
+Parameters:
+fields - the value of the fields parameter as an OptionalList <String >Returns:
+the call builder instance
+
+
+
+
+
+destinationIds
+
+A list of Event Destination IDs which should be used for this Event Stream.
+ Event Streams are required to have at least one Event Destination.
+
+Parameters:
+destinationIds - the value of the destination_ids parameter as a List <String >Returns:
+the call builder instance
+
+
+
+
+
+destinationIds
+
+A list of Event Destination IDs which should be used for this Event Stream.
+ Event Streams are required to have at least one Event Destination.
+
+Parameters:
+destinationIds - the value of the destination_ids parameter as an OptionalList <String >Returns:
+the call builder instance
+
+
+
+
+
+samplingRate
+
+The percentage of all events you would like to capture. Valid values range from
+ 0.01, representing 1% of all events to 1.00, representing 100% of all events.
+
+Parameters:
+samplingRate - the value of the sampling_rate parameter as a doubleReturns:
+the call builder instance
+
+
+
+
+
+samplingRate
+
+The percentage of all events you would like to capture. Valid values range from
+ 0.01, representing 1% of all events to 1.00, representing 100% of all events.
+
+Parameters:
+samplingRate - the value of the sampling_rate parameter as an OptionaldoubleReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+EventStreamThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EventStreams (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EventStreams
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for EventStreams.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Create a new Event Stream.
+
+
+
+
+
Delete an Event Stream.
+
+
+
+
+
Get detailed information about an Event Stream by ID.
+
+
+
+
+
List all Event Streams available on this account.
+
+
+
+
+
Update attributes of an Event Stream by ID.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EventStreams
+
+Creates a new sub-client for EventStreams.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+create
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+list
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+update
+
+
+
+Parameters:
+id - Unique identifier for this Event Stream.Returns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
EventSubscriptions.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EventSubscriptions
+public class EventSubscriptions.CreateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Create API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Arbitrary customer supplied information intended to be human readable.
+
+
+
+
+
Arbitrary customer supplied information intended to be human readable.
+
+
+
+
+
A list of Event Destination IDs which should be used for this Event Stream.
+
+
+
+
+
A list of Event Destination IDs which should be used for this Event Stream.
+
+
+
+
+
Arbitrary customer supplied information intended to be machine readable.
+
+
+
+
+
Arbitrary customer supplied information intended to be machine readable.
+
+
+
+
+
Sources containing the types for which this event subscription will trigger
+
+
+
+
+
Sources containing the types for which this event subscription will trigger
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+
+
+
+description
+
+Arbitrary customer supplied information intended to be human readable. Optional,
+ max 255 chars.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+Arbitrary customer supplied information intended to be human readable. Optional,
+ max 255 chars.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+sources
+
+Sources containing the types for which this event subscription will trigger
+
+Parameters:
+sources - the value of the sources parameter as a List <EventSourceReplace >Returns:
+the call builder instance
+
+
+
+
+
+sources
+
+Sources containing the types for which this event subscription will trigger
+
+Parameters:
+sources - the value of the sources parameter as an OptionalList <EventSourceReplace >Returns:
+the call builder instance
+
+
+
+
+
+destinationIds
+
+A list of Event Destination IDs which should be used for this Event Stream.
+ Event Streams are required to have at least one Event Destination.
+
+Parameters:
+destinationIds - the value of the destination_ids parameter as a List <String >Returns:
+the call builder instance
+
+
+
+
+
+destinationIds
+
+A list of Event Destination IDs which should be used for this Event Stream.
+ Event Streams are required to have at least one Event Destination.
+
+Parameters:
+destinationIds - the value of the destination_ids parameter as an OptionalList <String >Returns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventSubscriptions.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EventSubscriptions
+public class EventSubscriptions.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
EventSubscriptions.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EventSubscriptions
+public class EventSubscriptions.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+
EventSubscriptions.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EventSubscriptions
+public class EventSubscriptions.ListCallBuilder
+
extends Object A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+beforeId
+
+Sets the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+beforeId
+
+Sets (or unsets) the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets (or unsets) the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventSubscriptions.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+EventSubscriptions
+public class EventSubscriptions.UpdateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Arbitrary customer supplied information intended to be human readable.
+
+
+
+
+
Arbitrary customer supplied information intended to be human readable.
+
+
+
+
+
A list of Event Destination IDs which should be used for this Event Stream.
+
+
+
+
+
A list of Event Destination IDs which should be used for this Event Stream.
+
+
+
+
+
Arbitrary customer supplied information intended to be machine readable.
+
+
+
+
+
Arbitrary customer supplied information intended to be machine readable.
+
+
+
+
+
Sources containing the types for which this event subscription will trigger
+
+
+
+
+
Sources containing the types for which this event subscription will trigger
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+
+
+
+description
+
+Arbitrary customer supplied information intended to be human readable. Optional,
+ max 255 chars.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+Arbitrary customer supplied information intended to be human readable. Optional,
+ max 255 chars.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+sources
+
+Sources containing the types for which this event subscription will trigger
+
+Parameters:
+sources - the value of the sources parameter as a List <EventSourceReplace >Returns:
+the call builder instance
+
+
+
+
+
+sources
+
+Sources containing the types for which this event subscription will trigger
+
+Parameters:
+sources - the value of the sources parameter as an OptionalList <EventSourceReplace >Returns:
+the call builder instance
+
+
+
+
+
+destinationIds
+
+A list of Event Destination IDs which should be used for this Event Stream.
+ Event Streams are required to have at least one Event Destination.
+
+Parameters:
+destinationIds - the value of the destination_ids parameter as a List <String >Returns:
+the call builder instance
+
+
+
+
+
+destinationIds
+
+A list of Event Destination IDs which should be used for this Event Stream.
+ Event Streams are required to have at least one Event Destination.
+
+Parameters:
+destinationIds - the value of the destination_ids parameter as an OptionalList <String >Returns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EventSubscriptions (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class EventSubscriptions
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for EventSubscriptions.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Create an Event Subscription.
+
+
+
+
+
Delete an Event Subscription.
+
+
+
+
+
Get an Event Subscription by ID.
+
+
+
+
+
List this Account's Event Subscriptions.
+
+
+
+
+
Update an Event Subscription.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+EventSubscriptions
+
+Creates a new sub-client for EventSubscriptions.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+create
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+list
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+update
+
+
+
+Parameters:
+id - Unique identifier for this Event Subscription.Returns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
IpPolicies.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+IpPolicies
+public class IpPolicies.CreateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Create API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of the source IPs of this IP policy.
+
+
+
+
+
human-readable description of the source IPs of this IP policy.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP policy.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP policy.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of the source IPs of this IP policy. optional, max
+ 255 bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of the source IPs of this IP policy. optional, max
+ 255 bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+IpPolicyThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
IpPolicies.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+IpPolicies
+public class IpPolicies.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
IpPolicies.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+IpPolicies
+public class IpPolicies.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+IpPolicyThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
IpPolicies.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+IpPolicies
+public class IpPolicies.ListCallBuilder
+
extends Object A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+beforeId
+
+Sets the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+beforeId
+
+Sets (or unsets) the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets (or unsets) the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+a PageIpPolicyList
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
IpPolicies.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+IpPolicies
+public class IpPolicies.UpdateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of the source IPs of this IP policy.
+
+
+
+
+
human-readable description of the source IPs of this IP policy.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP policy.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP policy.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of the source IPs of this IP policy. optional, max
+ 255 bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of the source IPs of this IP policy. optional, max
+ 255 bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+IpPolicyThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
IpPolicies (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class IpPolicies
+
extends Object IP Policies are reusable groups of CIDR ranges with an
allow or
+
deny
+ action. They can be attached to endpoints via the Endpoint Configuration IP
+ Policy module. They can also be used with IP Restrictions to control source
+ IP ranges that can start tunnel sessions and connect to the API and dashboard.
+
+ See also
https://ngrok.com/docs/api#api-ip-policies .
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for IpPolicies.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Create a new IP policy.
+
+
+
+
+
+
+
+
Get detailed information about an IP policy by ID.
+
+
+
+
+
+
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+IpPolicies
+
+Creates a new sub-client for IpPolicies.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+create
+
+
+
+Parameters:
+action - the IP policy action. Supported values are allow or denyReturns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+list
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+update
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
IpPolicyRules.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+IpPolicyRules
+public class IpPolicyRules.CreateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Create API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of the source IPs of this IP rule.
+
+
+
+
+
human-readable description of the source IPs of this IP rule.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP policy rule.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP policy rule.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of the source IPs of this IP rule. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of the source IPs of this IP rule. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+IpPolicyRuleThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
IpPolicyRules.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+IpPolicyRules
+public class IpPolicyRules.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
IpPolicyRules.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+IpPolicyRules
+public class IpPolicyRules.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+IpPolicyRuleThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
IpPolicyRules.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+IpPolicyRules
+public class IpPolicyRules.ListCallBuilder
+
extends Object A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+beforeId
+
+Sets the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+beforeId
+
+Sets (or unsets) the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets (or unsets) the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
IpPolicyRules.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+IpPolicyRules
+public class IpPolicyRules.UpdateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
an IP or IP range specified in CIDR notation.
+
+
+
+
+
an IP or IP range specified in CIDR notation.
+
+
+
+
+
human-readable description of the source IPs of this IP rule.
+
+
+
+
+
human-readable description of the source IPs of this IP rule.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP policy rule.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP policy rule.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of the source IPs of this IP rule. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of the source IPs of this IP rule. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+cidr
+
+an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
+
+Parameters:
+cidr - the value of the cidr parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+cidr
+
+an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
+
+Parameters:
+cidr - the value of the cidr parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+IpPolicyRuleThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
IpPolicyRules (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class IpPolicyRules
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for IpPolicyRules.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Create a new IP policy rule attached to an IP Policy.
+
+
+
+
+
Delete an IP policy rule.
+
+
+
+
+
Get detailed information about an IP policy rule by ID.
+
+
+
+
+
+
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+IpPolicyRules
+
+Creates a new sub-client for IpPolicyRules.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+create
+
+
+
+Parameters:
+cidr - an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.ipPolicyId - ID of the IP policy this IP policy rule will be attached toReturns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+list
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+update
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
IpRestrictions.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+IpRestrictions
+public class IpRestrictions.CreateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Create API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of this IP restriction.
+
+
+
+
+
human-readable description of this IP restriction.
+
+
+
+
+
true if the IP restriction will be enforced.
+
+
+
+
+
true if the IP restriction will be enforced.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP restriction.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP restriction.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of this IP restriction. optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of this IP restriction. optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+enforced
+
+true if the IP restriction will be enforced. if false, only warnings will be
+ issued
+
+Parameters:
+enforced - the value of the enforced parameter as a booleanReturns:
+the call builder instance
+
+
+
+
+
+enforced
+
+true if the IP restriction will be enforced. if false, only warnings will be
+ issued
+
+Parameters:
+enforced - the value of the enforced parameter as an OptionalbooleanReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+IpRestrictionThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
IpRestrictions.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+IpRestrictions
+public class IpRestrictions.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
IpRestrictions.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+IpRestrictions
+public class IpRestrictions.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+IpRestrictionThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
IpRestrictions.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+IpRestrictions
+public class IpRestrictions.ListCallBuilder
+
extends Object A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+beforeId
+
+Sets the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+beforeId
+
+Sets (or unsets) the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets (or unsets) the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
IpRestrictions.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+IpRestrictions
+public class IpRestrictions.UpdateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of this IP restriction.
+
+
+
+
+
human-readable description of this IP restriction.
+
+
+
+
+
true if the IP restriction will be enforced.
+
+
+
+
+
true if the IP restriction will be enforced.
+
+
+
+
+
the set of IP policy identifiers that are used to enforce the restriction
+
+
+
+
+
the set of IP policy identifiers that are used to enforce the restriction
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP restriction.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP restriction.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of this IP restriction. optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of this IP restriction. optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+enforced
+
+true if the IP restriction will be enforced. if false, only warnings will be
+ issued
+
+Parameters:
+enforced - the value of the enforced parameter as a booleanReturns:
+the call builder instance
+
+
+
+
+
+enforced
+
+true if the IP restriction will be enforced. if false, only warnings will be
+ issued
+
+Parameters:
+enforced - the value of the enforced parameter as an OptionalbooleanReturns:
+the call builder instance
+
+
+
+
+
+ipPolicyIds
+
+the set of IP policy identifiers that are used to enforce the restriction
+
+Parameters:
+ipPolicyIds - the value of the ip_policy_ids parameter as a List <String >Returns:
+the call builder instance
+
+
+
+
+
+ipPolicyIds
+
+the set of IP policy identifiers that are used to enforce the restriction
+
+Parameters:
+ipPolicyIds - the value of the ip_policy_ids parameter as an OptionalList <String >Returns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+IpRestrictionThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
IpRestrictions (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class IpRestrictions
+
extends Object An IP restriction is a restriction placed on the CIDRs that are allowed to
+ initate traffic to a specific aspect of your ngrok account. An IP
+ restriction has a type which defines the ingress it applies to. IP
+ restrictions can be used to enforce the source IPs that can make API
+ requests, log in to the dashboard, start ngrok agents, and connect to your
+ public-facing endpoints.
+
+ See also
https://ngrok.com/docs/api#api-ip-restrictions .
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for IpRestrictions.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+IpRestrictions
+
+Creates a new sub-client for IpRestrictions.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+create
+
+
+
+Parameters:
+type - the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: dashboard, api, agent, and endpointsipPolicyIds - the set of IP policy identifiers that are used to enforce the restrictionReturns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+list
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+update
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
ReservedAddrs.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+ReservedAddrs
+public class ReservedAddrs.CreateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Create API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of what this reserved address will be used for
+
+
+
+
+
human-readable description of what this reserved address will be used for
+
+
+
+
+
ID of an endpoint configuration of type tcp that will be used to handle inbound
+ traffic to this address
+
+
+
+
+
ID of an endpoint configuration of type tcp that will be used to handle inbound
+ traffic to this address
+
+
+
+
+
arbitrary user-defined machine-readable data of this reserved address.
+
+
+
+
+
arbitrary user-defined machine-readable data of this reserved address.
+
+
+
+
+
reserve the address in this geographic ngrok datacenter.
+
+
+
+
+
reserve the address in this geographic ngrok datacenter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of what this reserved address will be used for
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of what this reserved address will be used for
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+region
+
+reserve the address in this geographic ngrok datacenter. Optional, default is
+ us. (au, eu, ap, us, jp, in, sa)
+
+Parameters:
+region - the value of the region parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+region
+
+reserve the address in this geographic ngrok datacenter. Optional, default is
+ us. (au, eu, ap, us, jp, in, sa)
+
+Parameters:
+region - the value of the region parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+endpointConfigurationId
+
+ID of an endpoint configuration of type tcp that will be used to handle inbound
+ traffic to this address
+
+Parameters:
+endpointConfigurationId - the value of the endpoint_configuration_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+endpointConfigurationId
+
+ID of an endpoint configuration of type tcp that will be used to handle inbound
+ traffic to this address
+
+Parameters:
+endpointConfigurationId - the value of the endpoint_configuration_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+ReservedAddrThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
ReservedAddrs.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+ReservedAddrs
+public class ReservedAddrs.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
ReservedAddrs.DeleteEndpointConfigCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.ReservedAddrs.DeleteEndpointConfigCallBuilder
+
+
+Enclosing class:
+ReservedAddrs
+public class ReservedAddrs.DeleteEndpointConfigCallBuilder
+
extends Object A builder object encapsulating state for an unsent DeleteEndpointConfig API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
ReservedAddrs.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+ReservedAddrs
+public class ReservedAddrs.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+ReservedAddrThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
ReservedAddrs.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+ReservedAddrs
+public class ReservedAddrs.ListCallBuilder
+
extends Object A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+beforeId
+
+Sets the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+beforeId
+
+Sets (or unsets) the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets (or unsets) the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
ReservedAddrs.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+ReservedAddrs
+public class ReservedAddrs.UpdateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of what this reserved address will be used for
+
+
+
+
+
human-readable description of what this reserved address will be used for
+
+
+
+
+
ID of an endpoint configuration of type tcp that will be used to handle inbound
+ traffic to this address
+
+
+
+
+
ID of an endpoint configuration of type tcp that will be used to handle inbound
+ traffic to this address
+
+
+
+
+
arbitrary user-defined machine-readable data of this reserved address.
+
+
+
+
+
arbitrary user-defined machine-readable data of this reserved address.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of what this reserved address will be used for
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of what this reserved address will be used for
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+endpointConfigurationId
+
+ID of an endpoint configuration of type tcp that will be used to handle inbound
+ traffic to this address
+
+Parameters:
+endpointConfigurationId - the value of the endpoint_configuration_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+endpointConfigurationId
+
+ID of an endpoint configuration of type tcp that will be used to handle inbound
+ traffic to this address
+
+Parameters:
+endpointConfigurationId - the value of the endpoint_configuration_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+ReservedAddrThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
ReservedAddrs (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class ReservedAddrs
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent DeleteEndpointConfig API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for ReservedAddrs.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Create a new reserved address.
+
+
+
+
+
Delete a reserved address.
+
+
+
+
+
Detach the endpoint configuration attached to a reserved address.
+
+
+
+
+
Get the details of a reserved address.
+
+
+
+
+
List all reserved addresses on this account.
+
+
+
+
+
Update the attributes of a reserved address.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+ReservedAddrs
+
+Creates a new sub-client for ReservedAddrs.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+create
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+list
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+update
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+deleteEndpointConfig
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
ReservedDomains.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+ReservedDomains
+public class ReservedDomains.CreateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Create API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
ID of a user-uploaded TLS certificate to use for connections to targeting this
+ domain.
+
+
+
+
+
ID of a user-uploaded TLS certificate to use for connections to targeting this
+ domain.
+
+
+
+
+
configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled.
+
+
+
+
+
configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled.
+
+
+
+
+
human-readable description of what this reserved domain will be used for
+
+
+
+
+
human-readable description of what this reserved domain will be used for
+
+
+
+
+
ID of an endpoint configuration of type http that will be used to handle inbound
+ http traffic to this domain
+
+
+
+
+
ID of an endpoint configuration of type http that will be used to handle inbound
+ http traffic to this domain
+
+
+
+
+
ID of an endpoint configuration of type https that will be used to handle
+ inbound https traffic to this domain
+
+
+
+
+
ID of an endpoint configuration of type https that will be used to handle
+ inbound https traffic to this domain
+
+
+
+
+
arbitrary user-defined machine-readable data of this reserved domain.
+
+
+
+
+
arbitrary user-defined machine-readable data of this reserved domain.
+
+
+
+
+
reserve the domain in this geographic ngrok datacenter.
+
+
+
+
+
reserve the domain in this geographic ngrok datacenter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+region
+
+reserve the domain in this geographic ngrok datacenter. Optional, default is us.
+ (au, eu, ap, us, jp, in, sa)
+
+Parameters:
+region - the value of the region parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+region
+
+reserve the domain in this geographic ngrok datacenter. Optional, default is us.
+ (au, eu, ap, us, jp, in, sa)
+
+Parameters:
+region - the value of the region parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of what this reserved domain will be used for
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of what this reserved domain will be used for
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+httpEndpointConfigurationId
+
+ID of an endpoint configuration of type http that will be used to handle inbound
+ http traffic to this domain
+
+Parameters:
+httpEndpointConfigurationId - the value of the http_endpoint_configuration_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+httpEndpointConfigurationId
+
+ID of an endpoint configuration of type http that will be used to handle inbound
+ http traffic to this domain
+
+Parameters:
+httpEndpointConfigurationId - the value of the http_endpoint_configuration_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+httpsEndpointConfigurationId
+
+ID of an endpoint configuration of type https that will be used to handle
+ inbound https traffic to this domain
+
+Parameters:
+httpsEndpointConfigurationId - the value of the https_endpoint_configuration_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+httpsEndpointConfigurationId
+
+ID of an endpoint configuration of type https that will be used to handle
+ inbound https traffic to this domain
+
+Parameters:
+httpsEndpointConfigurationId - the value of the https_endpoint_configuration_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+certificateId
+
+ID of a user-uploaded TLS certificate to use for connections to targeting this
+ domain. Optional, mutually exclusive with
+ certificate_management_policy.
+
+Parameters:
+certificateId - the value of the certificate_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+certificateId
+
+ID of a user-uploaded TLS certificate to use for connections to targeting this
+ domain. Optional, mutually exclusive with
+ certificate_management_policy.
+
+Parameters:
+certificateId - the value of the certificate_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+certificateManagementPolicy
+
+configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled. Optional, mutually exclusive with
+ certificate_id.
+
+Parameters:
+certificateManagementPolicy - the value of the certificate_management_policy parameter as a ReservedDomainCertPolicyReturns:
+the call builder instance
+
+
+
+
+
+certificateManagementPolicy
+
+configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled. Optional, mutually exclusive with
+ certificate_id.
+
+Parameters:
+certificateManagementPolicy - the value of the certificate_management_policy parameter as an OptionalReservedDomainCertPolicyReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+ReservedDomainThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
ReservedDomains.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+ReservedDomains
+public class ReservedDomains.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
ReservedDomains.DeleteCertificateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.ReservedDomains.DeleteCertificateCallBuilder
+
+
+Enclosing class:
+ReservedDomains
+public class ReservedDomains.DeleteCertificateCallBuilder
+
extends Object A builder object encapsulating state for an unsent DeleteCertificate API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
ReservedDomains.DeleteCertificateManagementPolicyCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.ReservedDomains.DeleteCertificateManagementPolicyCallBuilder
+
+
+Enclosing class:
+ReservedDomains
+public class ReservedDomains.DeleteCertificateManagementPolicyCallBuilder
+
extends Object A builder object encapsulating state for an unsent DeleteCertificateManagementPolicy API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
ReservedDomains.DeleteHttpEndpointConfigCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.ReservedDomains.DeleteHttpEndpointConfigCallBuilder
+
+
+Enclosing class:
+ReservedDomains
+public class ReservedDomains.DeleteHttpEndpointConfigCallBuilder
+
extends Object A builder object encapsulating state for an unsent DeleteHttpEndpointConfig API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
ReservedDomains.DeleteHttpsEndpointConfigCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.ReservedDomains.DeleteHttpsEndpointConfigCallBuilder
+
+
+Enclosing class:
+ReservedDomains
+public class ReservedDomains.DeleteHttpsEndpointConfigCallBuilder
+
extends Object A builder object encapsulating state for an unsent DeleteHttpsEndpointConfig API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
ReservedDomains.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+ReservedDomains
+public class ReservedDomains.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+ReservedDomainThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
ReservedDomains.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+ReservedDomains
+public class ReservedDomains.ListCallBuilder
+
extends Object A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+beforeId
+
+Sets the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+beforeId
+
+Sets (or unsets) the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets (or unsets) the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
ReservedDomains.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+ReservedDomains
+public class ReservedDomains.UpdateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
ID of a user-uploaded TLS certificate to use for connections to targeting this
+ domain.
+
+
+
+
+
ID of a user-uploaded TLS certificate to use for connections to targeting this
+ domain.
+
+
+
+
+
configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled.
+
+
+
+
+
configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled.
+
+
+
+
+
human-readable description of what this reserved domain will be used for
+
+
+
+
+
human-readable description of what this reserved domain will be used for
+
+
+
+
+
ID of an endpoint configuration of type http that will be used to handle inbound
+ http traffic to this domain
+
+
+
+
+
ID of an endpoint configuration of type http that will be used to handle inbound
+ http traffic to this domain
+
+
+
+
+
ID of an endpoint configuration of type https that will be used to handle
+ inbound https traffic to this domain
+
+
+
+
+
ID of an endpoint configuration of type https that will be used to handle
+ inbound https traffic to this domain
+
+
+
+
+
arbitrary user-defined machine-readable data of this reserved domain.
+
+
+
+
+
arbitrary user-defined machine-readable data of this reserved domain.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of what this reserved domain will be used for
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of what this reserved domain will be used for
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+httpEndpointConfigurationId
+
+ID of an endpoint configuration of type http that will be used to handle inbound
+ http traffic to this domain
+
+Parameters:
+httpEndpointConfigurationId - the value of the http_endpoint_configuration_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+httpEndpointConfigurationId
+
+ID of an endpoint configuration of type http that will be used to handle inbound
+ http traffic to this domain
+
+Parameters:
+httpEndpointConfigurationId - the value of the http_endpoint_configuration_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+httpsEndpointConfigurationId
+
+ID of an endpoint configuration of type https that will be used to handle
+ inbound https traffic to this domain
+
+Parameters:
+httpsEndpointConfigurationId - the value of the https_endpoint_configuration_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+httpsEndpointConfigurationId
+
+ID of an endpoint configuration of type https that will be used to handle
+ inbound https traffic to this domain
+
+Parameters:
+httpsEndpointConfigurationId - the value of the https_endpoint_configuration_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+certificateId
+
+ID of a user-uploaded TLS certificate to use for connections to targeting this
+ domain. Optional, mutually exclusive with
+ certificate_management_policy.
+
+Parameters:
+certificateId - the value of the certificate_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+certificateId
+
+ID of a user-uploaded TLS certificate to use for connections to targeting this
+ domain. Optional, mutually exclusive with
+ certificate_management_policy.
+
+Parameters:
+certificateId - the value of the certificate_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+certificateManagementPolicy
+
+configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled. Optional, mutually exclusive with
+ certificate_id.
+
+Parameters:
+certificateManagementPolicy - the value of the certificate_management_policy parameter as a ReservedDomainCertPolicyReturns:
+the call builder instance
+
+
+
+
+
+certificateManagementPolicy
+
+configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled. Optional, mutually exclusive with
+ certificate_id.
+
+Parameters:
+certificateManagementPolicy - the value of the certificate_management_policy parameter as an OptionalReservedDomainCertPolicyReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+ReservedDomainThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
ReservedDomains (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class ReservedDomains
+
extends Object 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.
+
+ See also
https://ngrok.com/docs/api#api-reserved-domains .
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent DeleteCertificate API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent DeleteCertificateManagementPolicy API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent DeleteHttpEndpointConfig API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent DeleteHttpsEndpointConfig API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for ReservedDomains.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Create a new reserved domain.
+
+
+
+
+
Delete a reserved domain.
+
+
+
+
+
Detach the certificate attached to a reserved domain.
+
+
+
+
+
Detach the certificate management policy attached to a reserved domain.
+
+
+
+
+
Detach the http endpoint configuration attached to a reserved domain.
+
+
+
+
+
Detach the https endpoint configuration attached to a reserved domain.
+
+
+
+
+
Get the details of a reserved domain.
+
+
+
+
+
List all reserved domains on this account.
+
+
+
+
+
Update the attributes of a reserved domain.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+ReservedDomains
+
+Creates a new sub-client for ReservedDomains.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+create
+
+
+
+Parameters:
+name - the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.Returns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+list
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+update
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+deleteCertificateManagementPolicy
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+deleteCertificate
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+deleteHttpEndpointConfig
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+deleteHttpsEndpointConfig
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
SshCertificateAuthorities.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.SshCertificateAuthorities.CreateCallBuilder
+
+
+Enclosing class:
+SshCertificateAuthorities
+public class SshCertificateAuthorities.CreateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Create API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of this SSH Certificate Authority.
+
+
+
+
+
human-readable description of this SSH Certificate Authority.
+
+
+
+
+
the type of elliptic curve to use when creating an ECDSA key
+
+
+
+
+
the type of elliptic curve to use when creating an ECDSA key
+
+
+
+
+
the key size to use when creating an RSA key.
+
+
+
+
+
the key size to use when creating an RSA key.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH Certificate Authority.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH Certificate Authority.
+
+
+
+
+
the type of private key to generate.
+
+
+
+
+
the type of private key to generate.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of this SSH Certificate Authority. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of this SSH Certificate Authority. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+privateKeyType
+
+the type of private key to generate. one of rsa,
+ ecdsa, ed25519
+
+Parameters:
+privateKeyType - the value of the private_key_type parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+privateKeyType
+
+the type of private key to generate. one of rsa,
+ ecdsa, ed25519
+
+Parameters:
+privateKeyType - the value of the private_key_type parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+ellipticCurve
+
+the type of elliptic curve to use when creating an ECDSA key
+
+Parameters:
+ellipticCurve - the value of the elliptic_curve parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+ellipticCurve
+
+the type of elliptic curve to use when creating an ECDSA key
+
+Parameters:
+ellipticCurve - the value of the elliptic_curve parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+keySize
+
+the key size to use when creating an RSA key. one of 2048 or
+ 4096
+
+Parameters:
+keySize - the value of the key_size parameter as a longReturns:
+the call builder instance
+
+
+
+
+
+keySize
+
+the key size to use when creating an RSA key. one of 2048 or
+ 4096
+
+Parameters:
+keySize - the value of the key_size parameter as an OptionallongReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SshCertificateAuthorities.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.SshCertificateAuthorities.DeleteCallBuilder
+
+
+Enclosing class:
+SshCertificateAuthorities
+public class SshCertificateAuthorities.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
SshCertificateAuthorities.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+SshCertificateAuthorities
+public class SshCertificateAuthorities.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+
SshCertificateAuthorities.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.SshCertificateAuthorities.ListCallBuilder
+
+
+Enclosing class:
+SshCertificateAuthorities
+public class SshCertificateAuthorities.ListCallBuilder
+
extends Object A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+beforeId
+
+Sets the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+beforeId
+
+Sets (or unsets) the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets (or unsets) the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SshCertificateAuthorities.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.ngrok.services.SshCertificateAuthorities.UpdateCallBuilder
+
+
+Enclosing class:
+SshCertificateAuthorities
+public class SshCertificateAuthorities.UpdateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of this SSH Certificate Authority.
+
+
+
+
+
human-readable description of this SSH Certificate Authority.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH Certificate Authority.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH Certificate Authority.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of this SSH Certificate Authority. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of this SSH Certificate Authority. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SshCertificateAuthorities (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class SshCertificateAuthorities
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for SshCertificateAuthorities.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+SshCertificateAuthorities
+
+Creates a new sub-client for SshCertificateAuthorities.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+create
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+list
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+update
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
SshCredentials.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+SshCredentials
+public class SshCredentials.CreateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Create API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
optional list of ACL rules.
+
+
+
+
+
optional list of ACL rules.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of who or what will use the ssh credential to
+ authenticate.
+
+
+
+
+
human-readable description of who or what will use the ssh credential to
+ authenticate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this ssh credential.
+
+
+
+
+
arbitrary user-defined machine-readable data of this ssh credential.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of who or what will use the ssh credential to
+ authenticate. Optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of who or what will use the ssh credential to
+ authenticate. Optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+acl
+
+optional list of ACL rules. If unspecified, the credential will have no
+ restrictions. The only allowed ACL rule at this time is the bind
+ rule. The bind 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
+ bind:example.ngrok.io. Bind rules may specify a leading wildcard to
+ match multiple domains with a common suffix. For example, you may specify a rule
+ of bind:*.example.com which will allow x.example.com,
+ y.example.com, *.example.com, etc. A rule of
+ '*' is equivalent to no acl at all and will explicitly permit all
+ actions.
+
+Parameters:
+acl - the value of the acl parameter as a List <String >Returns:
+the call builder instance
+
+
+
+
+
+acl
+
+optional list of ACL rules. If unspecified, the credential will have no
+ restrictions. The only allowed ACL rule at this time is the bind
+ rule. The bind 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
+ bind:example.ngrok.io. Bind rules may specify a leading wildcard to
+ match multiple domains with a common suffix. For example, you may specify a rule
+ of bind:*.example.com which will allow x.example.com,
+ y.example.com, *.example.com, etc. A rule of
+ '*' is equivalent to no acl at all and will explicitly permit all
+ actions.
+
+Parameters:
+acl - the value of the acl parameter as an OptionalList <String >Returns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+SshCredentialThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
SshCredentials.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+SshCredentials
+public class SshCredentials.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
SshCredentials.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+SshCredentials
+public class SshCredentials.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+SshCredentialThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
SshCredentials.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+SshCredentials
+public class SshCredentials.ListCallBuilder
+
extends Object A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+beforeId
+
+Sets the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+beforeId
+
+Sets (or unsets) the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets (or unsets) the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SshCredentials.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+SshCredentials
+public class SshCredentials.UpdateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
optional list of ACL rules.
+
+
+
+
+
optional list of ACL rules.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of who or what will use the ssh credential to
+ authenticate.
+
+
+
+
+
human-readable description of who or what will use the ssh credential to
+ authenticate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this ssh credential.
+
+
+
+
+
arbitrary user-defined machine-readable data of this ssh credential.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of who or what will use the ssh credential to
+ authenticate. Optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of who or what will use the ssh credential to
+ authenticate. Optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+acl
+
+optional list of ACL rules. If unspecified, the credential will have no
+ restrictions. The only allowed ACL rule at this time is the bind
+ rule. The bind 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
+ bind:example.ngrok.io. Bind rules may specify a leading wildcard to
+ match multiple domains with a common suffix. For example, you may specify a rule
+ of bind:*.example.com which will allow x.example.com,
+ y.example.com, *.example.com, etc. A rule of
+ '*' is equivalent to no acl at all and will explicitly permit all
+ actions.
+
+Parameters:
+acl - the value of the acl parameter as a List <String >Returns:
+the call builder instance
+
+
+
+
+
+acl
+
+optional list of ACL rules. If unspecified, the credential will have no
+ restrictions. The only allowed ACL rule at this time is the bind
+ rule. The bind 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
+ bind:example.ngrok.io. Bind rules may specify a leading wildcard to
+ match multiple domains with a common suffix. For example, you may specify a rule
+ of bind:*.example.com which will allow x.example.com,
+ y.example.com, *.example.com, etc. A rule of
+ '*' is equivalent to no acl at all and will explicitly permit all
+ actions.
+
+Parameters:
+acl - the value of the acl parameter as an OptionalList <String >Returns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+SshCredentialThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
SshCredentials (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class SshCredentials
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for SshCredentials.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Create a new ssh_credential from an uploaded public SSH key.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+SshCredentials
+
+Creates a new sub-client for SshCredentials.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+create
+
+
+
+Parameters:
+publicKey - the PEM-encoded public key of the SSH keypair that will be used to authenticateReturns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+list
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+update
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
SshHostCertificates.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+SshHostCertificates
+public class SshHostCertificates.CreateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Create API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of this SSH Host Certificate.
+
+
+
+
+
human-readable description of this SSH Host Certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH Host Certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH Host Certificate.
+
+
+
+
+
the list of principals included in the ssh host certificate.
+
+
+
+
+
the list of principals included in the ssh host certificate.
+
+
+
+
+
The time when the host certificate becomes valid, in RFC 3339 format.
+
+
+
+
+
The time when the host certificate becomes valid, in RFC 3339 format.
+
+
+
+
+
The time when this host certificate becomes invalid, in RFC 3339 format.
+
+
+
+
+
The time when this host certificate becomes invalid, in RFC 3339 format.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+principals
+
+the list of principals included in the ssh host certificate. This is the list of
+ hostnames and/or IP addresses that are authorized to serve SSH traffic with this
+ certificate. Dangerously, if no principals are specified, this certificate is
+ considered valid for all hosts.
+
+Parameters:
+principals - the value of the principals parameter as a List <String >Returns:
+the call builder instance
+
+
+
+
+
+principals
+
+the list of principals included in the ssh host certificate. This is the list of
+ hostnames and/or IP addresses that are authorized to serve SSH traffic with this
+ certificate. Dangerously, if no principals are specified, this certificate is
+ considered valid for all hosts.
+
+Parameters:
+principals - the value of the principals parameter as an OptionalList <String >Returns:
+the call builder instance
+
+
+
+
+
+validAfter
+
+The time when the host certificate becomes valid, in RFC 3339 format. Defaults
+ to the current time if unspecified.
+
+Parameters:
+validAfter - the value of the valid_after parameter as a OffsetDateTimeReturns:
+the call builder instance
+
+
+
+
+
+validAfter
+
+The time when the host certificate becomes valid, in RFC 3339 format. Defaults
+ to the current time if unspecified.
+
+Parameters:
+validAfter - the value of the valid_after parameter as an OptionalOffsetDateTimeReturns:
+the call builder instance
+
+
+
+
+
+validUntil
+
+The time when this host certificate becomes invalid, in RFC 3339 format. If
+ unspecified, a default value of one year in the future will be used. The OpenSSH
+ certificates RFC calls this valid_before.
+
+Parameters:
+validUntil - the value of the valid_until parameter as a OffsetDateTimeReturns:
+the call builder instance
+
+
+
+
+
+validUntil
+
+The time when this host certificate becomes invalid, in RFC 3339 format. If
+ unspecified, a default value of one year in the future will be used. The OpenSSH
+ certificates RFC calls this valid_before.
+
+Parameters:
+validUntil - the value of the valid_until parameter as an OptionalOffsetDateTimeReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of this SSH Host Certificate. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of this SSH Host Certificate. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SshHostCertificates.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+SshHostCertificates
+public class SshHostCertificates.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
SshHostCertificates.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+SshHostCertificates
+public class SshHostCertificates.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+
SshHostCertificates.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+SshHostCertificates
+public class SshHostCertificates.ListCallBuilder
+
extends Object A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+beforeId
+
+Sets the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+beforeId
+
+Sets (or unsets) the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets (or unsets) the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SshHostCertificates.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+SshHostCertificates
+public class SshHostCertificates.UpdateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of this SSH Host Certificate.
+
+
+
+
+
human-readable description of this SSH Host Certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH Host Certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH Host Certificate.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of this SSH Host Certificate. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of this SSH Host Certificate. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SshHostCertificates (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class SshHostCertificates
+
extends Object SSH Host Certificates along with the corresponding private key allows an SSH
+ server to assert its authenticity to connecting SSH clients who trust the
+ SSH Certificate Authority that was used to sign the certificate.
+
+ See also
https://ngrok.com/docs/api#api-ssh-host-certificates .
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for SshHostCertificates.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+SshHostCertificates
+
+Creates a new sub-client for SshHostCertificates.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+create
+
+
+
+Parameters:
+sshCertificateAuthorityId - the ssh certificate authority that is used to sign this ssh host certificatepublicKey - a public key in OpenSSH Authorized Keys format that this certificate signsReturns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+list
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+update
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
SshUserCertificates.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+SshUserCertificates
+public class SshUserCertificates.CreateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Create API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
A map of critical options included in the certificate.
+
+
+
+
+
A map of critical options included in the certificate.
+
+
+
+
+
human-readable description of this SSH User Certificate.
+
+
+
+
+
human-readable description of this SSH User Certificate.
+
+
+
+
+
A map of extensions included in the certificate.
+
+
+
+
+
A map of extensions included in the certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH User Certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH User Certificate.
+
+
+
+
+
the list of principals included in the ssh user certificate.
+
+
+
+
+
the list of principals included in the ssh user certificate.
+
+
+
+
+
The time when the user certificate becomes valid, in RFC 3339 format.
+
+
+
+
+
The time when the user certificate becomes valid, in RFC 3339 format.
+
+
+
+
+
The time when this host certificate becomes invalid, in RFC 3339 format.
+
+
+
+
+
The time when this host certificate becomes invalid, in RFC 3339 format.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+principals
+
+the list of principals included in the ssh user certificate. This is the list of
+ usernames that the certificate holder may sign in as on a machine authorizinig
+ the signing certificate authority. Dangerously, if no principals are specified,
+ this certificate may be used to log in as any user.
+
+Parameters:
+principals - the value of the principals parameter as a List <String >Returns:
+the call builder instance
+
+
+
+
+
+principals
+
+the list of principals included in the ssh user certificate. This is the list of
+ usernames that the certificate holder may sign in as on a machine authorizinig
+ the signing certificate authority. Dangerously, if no principals are specified,
+ this certificate may be used to log in as any user.
+
+Parameters:
+principals - the value of the principals parameter as an OptionalList <String >Returns:
+the call builder instance
+
+
+
+
+
+criticalOptions
+
+A map of critical options included in the certificate. Only two critical options
+ are currently defined by OpenSSH:
force-command and
+
source-address. See
the
+ OpenSSH certificate protocol spec for additional details.
+Parameters:
+criticalOptions - the value of the critical_options parameter as a Map <String ,String >Returns:
+the call builder instance
+
+
+
+
+
+criticalOptions
+
+A map of critical options included in the certificate. Only two critical options
+ are currently defined by OpenSSH:
force-command and
+
source-address. See
the
+ OpenSSH certificate protocol spec for additional details.
+Parameters:
+criticalOptions - the value of the critical_options parameter as an OptionalMap <String ,String >Returns:
+the call builder instance
+
+
+
+
+
+extensions
+
+A map of extensions included in the certificate. Extensions are additional
+ metadata that can be interpreted by the SSH server for any purpose. These can be
+ used to permit or deny the ability to open a terminal, do port forwarding, x11
+ forwarding, and more. If unspecified, the certificate will include limited
+ permissions with the following extension map:
{"permit-pty": "",
+ "permit-user-rc": ""} OpenSSH understands a number of predefined
+ extensions. See
the
+ OpenSSH certificate protocol spec for additional details.
+Parameters:
+extensions - the value of the extensions parameter as a Map <String ,String >Returns:
+the call builder instance
+
+
+
+
+
+extensions
+
+A map of extensions included in the certificate. Extensions are additional
+ metadata that can be interpreted by the SSH server for any purpose. These can be
+ used to permit or deny the ability to open a terminal, do port forwarding, x11
+ forwarding, and more. If unspecified, the certificate will include limited
+ permissions with the following extension map:
{"permit-pty": "",
+ "permit-user-rc": ""} OpenSSH understands a number of predefined
+ extensions. See
the
+ OpenSSH certificate protocol spec for additional details.
+Parameters:
+extensions - the value of the extensions parameter as an OptionalMap <String ,String >Returns:
+the call builder instance
+
+
+
+
+
+validAfter
+
+The time when the user certificate becomes valid, in RFC 3339 format. Defaults
+ to the current time if unspecified.
+
+Parameters:
+validAfter - the value of the valid_after parameter as a OffsetDateTimeReturns:
+the call builder instance
+
+
+
+
+
+validAfter
+
+The time when the user certificate becomes valid, in RFC 3339 format. Defaults
+ to the current time if unspecified.
+
+Parameters:
+validAfter - the value of the valid_after parameter as an OptionalOffsetDateTimeReturns:
+the call builder instance
+
+
+
+
+
+validUntil
+
+The time when this host certificate becomes invalid, in RFC 3339 format. If
+ unspecified, a default value of 24 hours will be used. The OpenSSH certificates
+ RFC calls this valid_before.
+
+Parameters:
+validUntil - the value of the valid_until parameter as a OffsetDateTimeReturns:
+the call builder instance
+
+
+
+
+
+validUntil
+
+The time when this host certificate becomes invalid, in RFC 3339 format. If
+ unspecified, a default value of 24 hours will be used. The OpenSSH certificates
+ RFC calls this valid_before.
+
+Parameters:
+validUntil - the value of the valid_until parameter as an OptionalOffsetDateTimeReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of this SSH User Certificate. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of this SSH User Certificate. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SshUserCertificates.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+SshUserCertificates
+public class SshUserCertificates.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
SshUserCertificates.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+SshUserCertificates
+public class SshUserCertificates.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+
SshUserCertificates.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+SshUserCertificates
+public class SshUserCertificates.ListCallBuilder
+
extends Object A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+beforeId
+
+Sets the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+beforeId
+
+Sets (or unsets) the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets (or unsets) the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SshUserCertificates.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+SshUserCertificates
+public class SshUserCertificates.UpdateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of this SSH User Certificate.
+
+
+
+
+
human-readable description of this SSH User Certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH User Certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH User Certificate.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of this SSH User Certificate. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of this SSH User Certificate. optional, max 255
+ bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SshUserCertificates (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class SshUserCertificates
+
extends Object SSH User Certificates are presented by SSH clients when connecting to an SSH
+ server to authenticate their connection. The SSH server must trust the SSH
+ Certificate Authority used to sign the certificate.
+
+ See also
https://ngrok.com/docs/api#api-ssh-user-certificates .
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for SshUserCertificates.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+SshUserCertificates
+
+Creates a new sub-client for SshUserCertificates.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+create
+
+
+
+Parameters:
+sshCertificateAuthorityId - the ssh certificate authority that is used to sign this ssh user certificatepublicKey - a public key in OpenSSH Authorized Keys format that this certificate signsReturns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+list
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+update
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
TlsCertificates.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+TlsCertificates
+public class TlsCertificates.CreateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Create API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of this TLS certificate.
+
+
+
+
+
human-readable description of this TLS certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this TLS certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this TLS certificate.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of this TLS certificate. optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of this TLS certificate. optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+TlsCertificateThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
TlsCertificates.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+TlsCertificates
+public class TlsCertificates.DeleteCallBuilder
+
extends Object A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
TlsCertificates.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+TlsCertificates
+public class TlsCertificates.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+TlsCertificateThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
TlsCertificates.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+TlsCertificates
+public class TlsCertificates.ListCallBuilder
+
extends Object A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+beforeId
+
+Sets the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+beforeId
+
+Sets (or unsets) the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets (or unsets) the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
TlsCertificates.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+TlsCertificates
+public class TlsCertificates.UpdateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
human-readable description of this TLS certificate.
+
+
+
+
+
human-readable description of this TLS certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this TLS certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this TLS certificate.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+description
+
+human-readable description of this TLS certificate. optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+description
+
+human-readable description of this TLS certificate. optional, max 255 bytes.
+
+Parameters:
+description - the value of the description parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+TlsCertificateThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
TlsCertificates (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class TlsCertificates
+
extends Object TLS Certificates are pairs of x509 certificates and their matching private
+ key that can be used to terminate TLS traffic. TLS certificates are unused
+ until they are attached to a Domain. TLS Certificates may also be
+ provisioned by ngrok automatically for domains on which you have enabled
+ automated certificate provisioning.
+
+ See also
https://ngrok.com/docs/api#api-tls-certificates .
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for TlsCertificates.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+TlsCertificates
+
+Creates a new sub-client for TlsCertificates.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+create
+
+
+
+Parameters:
+certificatePem - chain of PEM-encoded certificates, leaf first. See Certificate Bundles .privateKeyPem - private key for the TLS certificate, PEM-encoded. See Private Keys .Returns:
+a call builder for this API call
+
+
+
+
+
+delete
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+list
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+update
+
+
+
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
TunnelSessions.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+TunnelSessions
+public class TunnelSessions.GetCallBuilder
+
extends Object A builder object encapsulating state for an unsent Get API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+TunnelSessionThrows:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
TunnelSessions.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+TunnelSessions
+public class TunnelSessions.ListCallBuilder
+
extends Object A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+beforeId
+
+Sets the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+beforeId
+
+Sets (or unsets) the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets (or unsets) the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
TunnelSessions.RestartCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+TunnelSessions
+public class TunnelSessions.RestartCallBuilder
+
extends Object A builder object encapsulating state for an unsent Restart API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
TunnelSessions.StopCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+TunnelSessions
+public class TunnelSessions.StopCallBuilder
+
extends Object A builder object encapsulating state for an unsent Stop API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
TunnelSessions.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+TunnelSessions
+public class TunnelSessions.UpdateCallBuilder
+
extends Object A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
TunnelSessions (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class TunnelSessions
+
extends Object Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
+ sessions that are running and connected to the ngrok service. Each tunnel
+ session can include one or more Tunnels.
+
+ See also
https://ngrok.com/docs/api#api-tunnel-sessions .
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Restart API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Stop API call.
+
+
class
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for TunnelSessions.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
+
+
+
List all online tunnel sessions running on this account.
+
+
+
+
+
Issues a command instructing the ngrok agent to restart.
+
+
+
+
+
Issues a command instructing the ngrok agent that started this tunnel session to
+ exit.
+
+
+
+
+
Issues a command instructing the ngrok agent to update itself to the latest
+ version.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+TunnelSessions
+
+Creates a new sub-client for TunnelSessions.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+list
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+get
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+restart
+
+Issues a command instructing the ngrok agent to restart. The agent restarts
+ itself by calling exec() on platforms that support it. This operation is notably
+ not supported on Windows. When an agent restarts, it reconnects with a new
+ tunnel session ID.
+
+ See also
https://ngrok.com/docs/api#api-tunnel-sessions-restart .
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+stop
+
+
+
+Parameters:
+id - a resource identifierReturns:
+a call builder for this API call
+
+
+
+
+
+update
+
+Issues a command instructing the ngrok agent to update itself to the latest
+ version. After this call completes successfully, the ngrok agent will be in the
+ update process. A caller should wait some amount of time to allow the update to
+ complete (at least 10 seconds) before making a call to the Restart endpoint to
+ request that the agent restart itself to start using the new code. This call
+ will never update an ngrok agent to a new major version which could cause
+ breaking compatibility issues. If you wish to update to a new major version,
+ that must be done manually. Still, please be aware that updating your ngrok
+ agent could break your integration. This call will fail in any of the following
+ circumstances: there is no update available the ngrok agent's configuration
+ disabled update checks the agent is currently in process of updating the agent
+ has already successfully updated but has not yet been restarted
+
+ See also
https://ngrok.com/docs/api#api-tunnel-sessions-update .
+Parameters:
+id - the value of the id parameter as a StringReturns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
Tunnels.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Enclosing class:
+Tunnels
+public class Tunnels.ListCallBuilder
+
extends Object A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Initiates the API call and blocks until it returns.
+
+
+
+
+
Initiates the API call asynchronously.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+beforeId
+
+Sets the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+beforeId
+
+Sets (or unsets) the before_id parameter.
+
+Parameters:
+beforeId - the value of the before_id parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as a StringReturns:
+the call builder instance
+
+
+
+
+
+limit
+
+Sets (or unsets) the limit parameter.
+
+Parameters:
+limit - the value of the limit parameter as an OptionalStringReturns:
+the call builder instance
+
+
+
+
+
+
+
+
+blockingCall
+
+Initiates the API call and blocks until it returns.
+
+Returns:
+a PageTunnelList
+Throws:
+InterruptedException
+
+
+
+
+
+
+
+
+
+
+
+
Tunnels (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class Tunnels
+
extends Object
+
+
+
+
+
+Nested Class Summary
+Nested Classes
+
+
+
+
+
class
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Creates a new sub-client for Tunnels.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
List all online tunnels currently running on the account.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+Tunnels
+
+Creates a new sub-client for Tunnels.
+
+Parameters:
+apiClient - an instance of NgrokApiClient
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+list
+
+
+
+Returns:
+a call builder for this API call
+
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.AbuseReports.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a new abuse report which will be reviewed by our system and abuse
+ response team.
+
+
+
+
+
arbitrary user-defined data about this abuse report.
+
+
+
+
+
arbitrary user-defined data about this abuse report.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.AbuseReports.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Get the detailed status of abuse report by ID.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.AbuseReports (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Abuse Reports allow you to submit take-down requests for URLs hosted by
+ ngrok that violate ngrok's terms of service.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.AgentIngresses.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Create a new Agent Ingress.
+
+
+
+
+
human-readable description of the use of this Agent Ingress.
+
+
+
+
+
human-readable description of the use of this Agent Ingress.
+
+
+
+
+
arbitrary user-defined machine-readable data of this Agent Ingress.
+
+
+
+
+
arbitrary user-defined machine-readable data of this Agent Ingress.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.AgentIngresses.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/AgentIngresses.GetCallBuilder.html b/docs/com/ngrok/services/class-use/AgentIngresses.GetCallBuilder.html
new file mode 100644
index 0000000..2d54cb6
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/AgentIngresses.GetCallBuilder.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.AgentIngresses.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Get the details of an Agent Ingress by ID.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.AgentIngresses.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.AgentIngresses.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
human-readable description of the use of this Agent Ingress.
+
+
+
+
+
human-readable description of the use of this Agent Ingress.
+
+
+
+
+
arbitrary user-defined machine-readable data of this Agent Ingress.
+
+
+
+
+
arbitrary user-defined machine-readable data of this Agent Ingress.
+
+
+
+
+
Update attributes of an Agent Ingress by ID.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.AgentIngresses (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a service client for AgentIngresses.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ApiKeys.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
human-readable description of what uses the API key to authenticate.
+
+
+
+
+
human-readable description of what uses the API key to authenticate.
+
+
+
+
+
arbitrary user-defined data of this API key.
+
+
+
+
+
arbitrary user-defined data of this API key.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ApiKeys.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/ApiKeys.GetCallBuilder.html b/docs/com/ngrok/services/class-use/ApiKeys.GetCallBuilder.html
new file mode 100644
index 0000000..31b17d8
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/ApiKeys.GetCallBuilder.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.ApiKeys.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Get the details of an API key by ID.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ApiKeys.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ApiKeys.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
human-readable description of what uses the API key to authenticate.
+
+
+
+
+
human-readable description of what uses the API key to authenticate.
+
+
+
+
+
arbitrary user-defined data of this API key.
+
+
+
+
+
arbitrary user-defined data of this API key.
+
+
+
+
+
Update attributes of an API key by ID.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ApiKeys (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/CertificateAuthorities.CreateCallBuilder.html b/docs/com/ngrok/services/class-use/CertificateAuthorities.CreateCallBuilder.html
new file mode 100644
index 0000000..023d763
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/CertificateAuthorities.CreateCallBuilder.html
@@ -0,0 +1,114 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.CertificateAuthorities.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
human-readable description of this Certificate Authority.
+
+
+
+
+
human-readable description of this Certificate Authority.
+
+
+
+
+
arbitrary user-defined machine-readable data of this Certificate Authority.
+
+
+
+
+
arbitrary user-defined machine-readable data of this Certificate Authority.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.CertificateAuthorities.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/CertificateAuthorities.GetCallBuilder.html b/docs/com/ngrok/services/class-use/CertificateAuthorities.GetCallBuilder.html
new file mode 100644
index 0000000..d25a159
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/CertificateAuthorities.GetCallBuilder.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.CertificateAuthorities.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/CertificateAuthorities.ListCallBuilder.html b/docs/com/ngrok/services/class-use/CertificateAuthorities.ListCallBuilder.html
new file mode 100644
index 0000000..a60a27c
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/CertificateAuthorities.ListCallBuilder.html
@@ -0,0 +1,114 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.CertificateAuthorities.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
CertificateAuthorities.ListCallBuilder. limit String limit)
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
CertificateAuthorities. list
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.CertificateAuthorities.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
human-readable description of this Certificate Authority.
+
+
+
+
+
human-readable description of this Certificate Authority.
+
+
+
+
+
arbitrary user-defined machine-readable data of this Certificate Authority.
+
+
+
+
+
arbitrary user-defined machine-readable data of this Certificate Authority.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.CertificateAuthorities (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Certificate Authorities are x509 certificates that are used to sign other
+ x509 certificates.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.Credentials.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
optional list of ACL rules.
+
+
+
+
+
optional list of ACL rules.
+
+
+
+
+
Create a new tunnel authtoken credential.
+
+
+
+
+
human-readable description of who or what will use the credential to
+ authenticate.
+
+
+
+
+
human-readable description of who or what will use the credential to
+ authenticate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this credential.
+
+
+
+
+
arbitrary user-defined machine-readable data of this credential.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.Credentials.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/Credentials.GetCallBuilder.html b/docs/com/ngrok/services/class-use/Credentials.GetCallBuilder.html
new file mode 100644
index 0000000..90f3b68
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/Credentials.GetCallBuilder.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.Credentials.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/Credentials.ListCallBuilder.html b/docs/com/ngrok/services/class-use/Credentials.ListCallBuilder.html
new file mode 100644
index 0000000..88a0925
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/Credentials.ListCallBuilder.html
@@ -0,0 +1,114 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.Credentials.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.Credentials.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
optional list of ACL rules.
+
+
+
+
+
optional list of ACL rules.
+
+
+
+
+
human-readable description of who or what will use the credential to
+ authenticate.
+
+
+
+
+
human-readable description of who or what will use the credential to
+ authenticate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this credential.
+
+
+
+
+
arbitrary user-defined machine-readable data of this credential.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.Credentials (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Tunnel Credentials are ngrok agent authtokens.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointCircuitBreakerModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointCircuitBreakerModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointCircuitBreakerModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointCircuitBreakerModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/EndpointCompressionModule.DeleteCallBuilder.html b/docs/com/ngrok/services/class-use/EndpointCompressionModule.DeleteCallBuilder.html
new file mode 100644
index 0000000..176f25d
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/EndpointCompressionModule.DeleteCallBuilder.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.EndpointCompressionModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointCompressionModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointCompressionModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointCompressionModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/EndpointConfigurations.CreateCallBuilder.html b/docs/com/ngrok/services/class-use/EndpointConfigurations.CreateCallBuilder.html
new file mode 100644
index 0000000..0166c6b
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/EndpointConfigurations.CreateCallBuilder.html
@@ -0,0 +1,246 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.EndpointConfigurations.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
circuit breaker module configuration or null
+
+
+
+
+
circuit breaker module configuration or null
+
+
+
+
+
compression module configuration or null
+
+
+
+
+
compression module configuration or null
+
+
+
EndpointConfigurations. create
+
+
+
+
+
human-readable description of what this endpoint configuration will be do when
+ applied or what traffic it will be applied to.
+
+
+
+
+
human-readable description of what this endpoint configuration will be do when
+ applied or what traffic it will be applied to.
+
+
+
+
+
ip policy module configuration or null
+
+
+
+
+
ip policy module configuration or null
+
+
+
+
+
logging module configuration or null
+
+
+
+
+
logging module configuration or null
+
+
+
+
+
arbitrary user-defined machine-readable data of this endpoint configuration.
+
+
+
+
+
arbitrary user-defined machine-readable data of this endpoint configuration.
+
+
+
+
+
mutual TLS module configuration or null
+
+
+
+
+
mutual TLS module configuration or null
+
+
+
+
+
oauth module configuration or null
+
+
+
+
+
oauth module configuration or null
+
+
+
+
+
oidc module configuration or null
+
+
+
+
+
oidc module configuration or null
+
+
+
+
+
request headers module configuration or null
+
+
+
+
+
request headers module configuration or null
+
+
+
+
+
response headers module configuration or null
+
+
+
+
+
response headers module configuration or null
+
+
+
+
+
saml module configuration or null
+
+
+
+
+
saml module configuration or null
+
+
+
+
+
TLS termination module configuration or null
+
+
+
+
+
TLS termination module configuration or null
+
+
+
EndpointConfigurations.CreateCallBuilder. type String type)
+
+
they type of traffic this endpoint configuration can be applied to.
+
+
+
+
+
they type of traffic this endpoint configuration can be applied to.
+
+
+
+
+
webhook validation module configuration or null
+
+
+
+
+
webhook validation module configuration or null
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointConfigurations.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Delete an endpoint configuration.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointConfigurations.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/EndpointConfigurations.ListCallBuilder.html b/docs/com/ngrok/services/class-use/EndpointConfigurations.ListCallBuilder.html
new file mode 100644
index 0000000..4398239
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/EndpointConfigurations.ListCallBuilder.html
@@ -0,0 +1,114 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.EndpointConfigurations.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
EndpointConfigurations.ListCallBuilder. limit String limit)
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
EndpointConfigurations. list
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
circuit breaker module configuration or null
+
+
+
+
+
circuit breaker module configuration or null
+
+
+
+
+
compression module configuration or null
+
+
+
+
+
compression module configuration or null
+
+
+
+
+
human-readable description of what this endpoint configuration will be do when
+ applied or what traffic it will be applied to.
+
+
+
+
+
human-readable description of what this endpoint configuration will be do when
+ applied or what traffic it will be applied to.
+
+
+
+
+
ip policy module configuration or null
+
+
+
+
+
ip policy module configuration or null
+
+
+
+
+
logging module configuration or null
+
+
+
+
+
logging module configuration or null
+
+
+
+
+
arbitrary user-defined machine-readable data of this endpoint configuration.
+
+
+
+
+
arbitrary user-defined machine-readable data of this endpoint configuration.
+
+
+
+
+
mutual TLS module configuration or null
+
+
+
+
+
mutual TLS module configuration or null
+
+
+
+
+
oauth module configuration or null
+
+
+
+
+
oauth module configuration or null
+
+
+
+
+
oidc module configuration or null
+
+
+
+
+
oidc module configuration or null
+
+
+
+
+
request headers module configuration or null
+
+
+
+
+
request headers module configuration or null
+
+
+
+
+
response headers module configuration or null
+
+
+
+
+
response headers module configuration or null
+
+
+
+
+
saml module configuration or null
+
+
+
+
+
saml module configuration or null
+
+
+
+
+
TLS termination module configuration or null
+
+
+
+
+
TLS termination module configuration or null
+
+
+
+
+
Updates an endpoint configuration.
+
+
+
+
+
webhook validation module configuration or null
+
+
+
+
+
webhook validation module configuration or null
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointConfigurations (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Endpoint Configurations are a reusable group of modules that encapsulate how
+ traffic to a domain or address is handled.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointIpPolicyModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointIpPolicyModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointIpPolicyModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointIpPolicyModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Ngrok.PointcfgModuleNamespace. ipPolicy
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointLoggingModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointLoggingModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointLoggingModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointLoggingModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Ngrok.PointcfgModuleNamespace. logging
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointMutualTlsModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointMutualTlsModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointMutualTlsModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointMutualTlsModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/EndpointOAuthModule.DeleteCallBuilder.html b/docs/com/ngrok/services/class-use/EndpointOAuthModule.DeleteCallBuilder.html
new file mode 100644
index 0000000..3eb8d0b
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/EndpointOAuthModule.DeleteCallBuilder.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.EndpointOAuthModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointOAuthModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointOAuthModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointOAuthModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Ngrok.PointcfgModuleNamespace. oauth
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointOidcModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointOidcModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointOidcModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointOidcModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Ngrok.PointcfgModuleNamespace. oidc
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointRequestHeadersModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointRequestHeadersModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointRequestHeadersModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointRequestHeadersModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/EndpointResponseHeadersModule.DeleteCallBuilder.html b/docs/com/ngrok/services/class-use/EndpointResponseHeadersModule.DeleteCallBuilder.html
new file mode 100644
index 0000000..b24d3ad
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/EndpointResponseHeadersModule.DeleteCallBuilder.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.EndpointResponseHeadersModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointResponseHeadersModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointResponseHeadersModule. get String id)
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointResponseHeadersModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointResponseHeadersModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/EndpointSamlModule.DeleteCallBuilder.html b/docs/com/ngrok/services/class-use/EndpointSamlModule.DeleteCallBuilder.html
new file mode 100644
index 0000000..7ad08ff
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/EndpointSamlModule.DeleteCallBuilder.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.EndpointSamlModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointSamlModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointSamlModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointSamlModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Ngrok.PointcfgModuleNamespace. saml
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointTlsTerminationModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointTlsTerminationModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointTlsTerminationModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointTlsTerminationModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/EndpointWebhookValidationModule.DeleteCallBuilder.html b/docs/com/ngrok/services/class-use/EndpointWebhookValidationModule.DeleteCallBuilder.html
new file mode 100644
index 0000000..ec334c4
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/EndpointWebhookValidationModule.DeleteCallBuilder.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.EndpointWebhookValidationModule.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a call builder for the Delete API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointWebhookValidationModule.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EndpointWebhookValidationModule. get String id)
+
+
Creates a call builder for the Get API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointWebhookValidationModule.ReplaceCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the module parameter.
+
+
+
+
+
Sets (or unsets) the module parameter.
+
+
+
+
+
Creates a call builder for the Replace API operation.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EndpointWebhookValidationModule (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/EventDestinations.CreateCallBuilder.html b/docs/com/ngrok/services/class-use/EventDestinations.CreateCallBuilder.html
new file mode 100644
index 0000000..e5090db
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/EventDestinations.CreateCallBuilder.html
@@ -0,0 +1,134 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.EventDestinations.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Create a new Event Destination.
+
+
+
+
+
Human-readable description of the Event Destination.
+
+
+
+
+
Human-readable description of the Event Destination.
+
+
+
+
+
The output format you would like to serialize events into when sending to their
+ target.
+
+
+
+
+
The output format you would like to serialize events into when sending to their
+ target.
+
+
+
+
+
Arbitrary user-defined machine-readable data of this Event Destination.
+
+
+
+
+
Arbitrary user-defined machine-readable data of this Event Destination.
+
+
+
+
+
An object that encapsulates where and how to send your events.
+
+
+
+
+
An object that encapsulates where and how to send your events.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EventDestinations.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Delete an Event Destination.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EventDestinations.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Get detailed information about an Event Destination by ID.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EventDestinations.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
List all Event Destinations on this account.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EventDestinations.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Human-readable description of the Event Destination.
+
+
+
+
+
Human-readable description of the Event Destination.
+
+
+
+
+
The output format you would like to serialize events into when sending to their
+ target.
+
+
+
+
+
The output format you would like to serialize events into when sending to their
+ target.
+
+
+
+
+
Arbitrary user-defined machine-readable data of this Event Destination.
+
+
+
+
+
Arbitrary user-defined machine-readable data of this Event Destination.
+
+
+
+
+
An object that encapsulates where and how to send your events.
+
+
+
+
+
An object that encapsulates where and how to send your events.
+
+
+
+
+
Update attributes of an Event Destination.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EventDestinations (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a service client for EventDestinations.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EventSources.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Type of event for which an event subscription will trigger
+
+
+
+
+
Type of event for which an event subscription will trigger
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EventSources.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/EventSources.GetCallBuilder.html b/docs/com/ngrok/services/class-use/EventSources.GetCallBuilder.html
new file mode 100644
index 0000000..4aae633
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/EventSources.GetCallBuilder.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.EventSources.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/EventSources.ListCallBuilder.html b/docs/com/ngrok/services/class-use/EventSources.ListCallBuilder.html
new file mode 100644
index 0000000..94ed4f5
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/EventSources.ListCallBuilder.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.EventSources.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/EventSources.UpdateCallBuilder.html b/docs/com/ngrok/services/class-use/EventSources.UpdateCallBuilder.html
new file mode 100644
index 0000000..3471a1f
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/EventSources.UpdateCallBuilder.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.EventSources.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/EventSources.html b/docs/com/ngrok/services/class-use/EventSources.html
new file mode 100644
index 0000000..134f377
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/EventSources.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.EventSources (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a service client for EventSources.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EventStreams.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Create a new Event Stream.
+
+
+
+
+
Human-readable description of the Event Stream.
+
+
+
+
+
Human-readable description of the Event Stream.
+
+
+
+
+
A list of Event Destination IDs which should be used for this Event Stream.
+
+
+
+
+
A list of Event Destination IDs which should be used for this Event Stream.
+
+
+
+
+
The protocol that determines which events will be collected.
+
+
+
+
+
The protocol that determines which events will be collected.
+
+
+
+
+
A list of protocol-specific fields you want to collect on each event.
+
+
+
+
+
A list of protocol-specific fields you want to collect on each event.
+
+
+
+
+
Arbitrary user-defined machine-readable data of this Event Stream.
+
+
+
+
+
Arbitrary user-defined machine-readable data of this Event Stream.
+
+
+
EventStreams.CreateCallBuilder. samplingRate
+
+
The percentage of all events you would like to capture.
+
+
+
+
+
The percentage of all events you would like to capture.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EventStreams.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Delete an Event Stream.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EventStreams.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Get detailed information about an Event Stream by ID.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EventStreams.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
List all Event Streams available on this account.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EventStreams.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Human-readable description of the Event Stream.
+
+
+
+
+
Human-readable description of the Event Stream.
+
+
+
+
+
A list of Event Destination IDs which should be used for this Event Stream.
+
+
+
+
+
A list of Event Destination IDs which should be used for this Event Stream.
+
+
+
+
+
A list of protocol-specific fields you want to collect on each event.
+
+
+
+
+
A list of protocol-specific fields you want to collect on each event.
+
+
+
+
+
Arbitrary user-defined machine-readable data of this Event Stream.
+
+
+
+
+
Arbitrary user-defined machine-readable data of this Event Stream.
+
+
+
EventStreams.UpdateCallBuilder. samplingRate
+
+
The percentage of all events you would like to capture.
+
+
+
+
+
The percentage of all events you would like to capture.
+
+
+
+
+
Update attributes of an Event Stream by ID.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EventStreams (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a service client for EventStreams.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EventSubscriptions.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Create an Event Subscription.
+
+
+
+
+
Arbitrary customer supplied information intended to be human readable.
+
+
+
+
+
Arbitrary customer supplied information intended to be human readable.
+
+
+
+
+
A list of Event Destination IDs which should be used for this Event Stream.
+
+
+
+
+
A list of Event Destination IDs which should be used for this Event Stream.
+
+
+
+
+
Arbitrary customer supplied information intended to be machine readable.
+
+
+
+
+
Arbitrary customer supplied information intended to be machine readable.
+
+
+
+
+
Sources containing the types for which this event subscription will trigger
+
+
+
+
+
Sources containing the types for which this event subscription will trigger
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EventSubscriptions.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Delete an Event Subscription.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EventSubscriptions.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Get an Event Subscription by ID.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EventSubscriptions.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
EventSubscriptions.ListCallBuilder. limit String limit)
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
EventSubscriptions. list
+
+
List this Account's Event Subscriptions.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EventSubscriptions.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Arbitrary customer supplied information intended to be human readable.
+
+
+
+
+
Arbitrary customer supplied information intended to be human readable.
+
+
+
+
+
A list of Event Destination IDs which should be used for this Event Stream.
+
+
+
+
+
A list of Event Destination IDs which should be used for this Event Stream.
+
+
+
+
+
Arbitrary customer supplied information intended to be machine readable.
+
+
+
+
+
Arbitrary customer supplied information intended to be machine readable.
+
+
+
+
+
Sources containing the types for which this event subscription will trigger
+
+
+
+
+
Sources containing the types for which this event subscription will trigger
+
+
+
+
+
Update an Event Subscription.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.EventSubscriptions (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Creates a service client for EventSubscriptions.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.IpPolicies.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Create a new IP policy.
+
+
+
+
+
human-readable description of the source IPs of this IP policy.
+
+
+
+
+
human-readable description of the source IPs of this IP policy.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP policy.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP policy.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.IpPolicies.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/IpPolicies.GetCallBuilder.html b/docs/com/ngrok/services/class-use/IpPolicies.GetCallBuilder.html
new file mode 100644
index 0000000..1f20d70
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/IpPolicies.GetCallBuilder.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.IpPolicies.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Get detailed information about an IP policy by ID.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.IpPolicies.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.IpPolicies.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
human-readable description of the source IPs of this IP policy.
+
+
+
+
+
human-readable description of the source IPs of this IP policy.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP policy.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP policy.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.IpPolicies (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
IP Policies are reusable groups of CIDR ranges with an allow or
+ deny
+ action.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.IpPolicyRules.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Create a new IP policy rule attached to an IP Policy.
+
+
+
+
+
human-readable description of the source IPs of this IP rule.
+
+
+
+
+
human-readable description of the source IPs of this IP rule.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP policy rule.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP policy rule.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.IpPolicyRules.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Delete an IP policy rule.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.IpPolicyRules.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Get detailed information about an IP policy rule by ID.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.IpPolicyRules.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.IpPolicyRules.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
IpPolicyRules.UpdateCallBuilder. cidr String cidr)
+
+
an IP or IP range specified in CIDR notation.
+
+
+
+
+
an IP or IP range specified in CIDR notation.
+
+
+
+
+
human-readable description of the source IPs of this IP rule.
+
+
+
+
+
human-readable description of the source IPs of this IP rule.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP policy rule.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP policy rule.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.IpPolicyRules (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
IP Policy Rules are the IPv4 or IPv6 CIDRs entries that
+ make up an IP Policy.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.IpRestrictions.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
human-readable description of this IP restriction.
+
+
+
+
+
human-readable description of this IP restriction.
+
+
+
IpRestrictions.CreateCallBuilder. enforced
+
+
true if the IP restriction will be enforced.
+
+
+
+
+
true if the IP restriction will be enforced.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP restriction.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP restriction.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.IpRestrictions.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/IpRestrictions.GetCallBuilder.html b/docs/com/ngrok/services/class-use/IpRestrictions.GetCallBuilder.html
new file mode 100644
index 0000000..8adcbb7
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/IpRestrictions.GetCallBuilder.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.IpRestrictions.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/IpRestrictions.ListCallBuilder.html b/docs/com/ngrok/services/class-use/IpRestrictions.ListCallBuilder.html
new file mode 100644
index 0000000..92e518e
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/IpRestrictions.ListCallBuilder.html
@@ -0,0 +1,114 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.IpRestrictions.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.IpRestrictions.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
human-readable description of this IP restriction.
+
+
+
+
+
human-readable description of this IP restriction.
+
+
+
IpRestrictions.UpdateCallBuilder. enforced
+
+
true if the IP restriction will be enforced.
+
+
+
+
+
true if the IP restriction will be enforced.
+
+
+
+
+
the set of IP policy identifiers that are used to enforce the restriction
+
+
+
+
+
the set of IP policy identifiers that are used to enforce the restriction
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP restriction.
+
+
+
+
+
arbitrary user-defined machine-readable data of this IP restriction.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.IpRestrictions (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
An IP restriction is a restriction placed on the CIDRs that are allowed to
+ initate traffic to a specific aspect of your ngrok account.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ReservedAddrs.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Create a new reserved address.
+
+
+
+
+
human-readable description of what this reserved address will be used for
+
+
+
+
+
human-readable description of what this reserved address will be used for
+
+
+
+
+
ID of an endpoint configuration of type tcp that will be used to handle inbound
+ traffic to this address
+
+
+
+
+
ID of an endpoint configuration of type tcp that will be used to handle inbound
+ traffic to this address
+
+
+
+
+
arbitrary user-defined machine-readable data of this reserved address.
+
+
+
+
+
arbitrary user-defined machine-readable data of this reserved address.
+
+
+
+
+
reserve the address in this geographic ngrok datacenter.
+
+
+
+
+
reserve the address in this geographic ngrok datacenter.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ReservedAddrs.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Delete a reserved address.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ReservedAddrs.DeleteEndpointConfigCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Detach the endpoint configuration attached to a reserved address.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ReservedAddrs.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Get the details of a reserved address.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ReservedAddrs.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
List all reserved addresses on this account.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ReservedAddrs.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
human-readable description of what this reserved address will be used for
+
+
+
+
+
human-readable description of what this reserved address will be used for
+
+
+
+
+
ID of an endpoint configuration of type tcp that will be used to handle inbound
+ traffic to this address
+
+
+
+
+
ID of an endpoint configuration of type tcp that will be used to handle inbound
+ traffic to this address
+
+
+
+
+
arbitrary user-defined machine-readable data of this reserved address.
+
+
+
+
+
arbitrary user-defined machine-readable data of this reserved address.
+
+
+
+
+
Update the attributes of a reserved address.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ReservedAddrs (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Reserved Addresses are TCP addresses that can be used to listen for traffic.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ReservedDomains.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
ID of a user-uploaded TLS certificate to use for connections to targeting this
+ domain.
+
+
+
+
+
ID of a user-uploaded TLS certificate to use for connections to targeting this
+ domain.
+
+
+
+
+
configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled.
+
+
+
+
+
configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled.
+
+
+
+
+
Create a new reserved domain.
+
+
+
+
+
human-readable description of what this reserved domain will be used for
+
+
+
+
+
human-readable description of what this reserved domain will be used for
+
+
+
+
+
ID of an endpoint configuration of type http that will be used to handle inbound
+ http traffic to this domain
+
+
+
+
+
ID of an endpoint configuration of type http that will be used to handle inbound
+ http traffic to this domain
+
+
+
+
+
ID of an endpoint configuration of type https that will be used to handle
+ inbound https traffic to this domain
+
+
+
+
+
ID of an endpoint configuration of type https that will be used to handle
+ inbound https traffic to this domain
+
+
+
+
+
arbitrary user-defined machine-readable data of this reserved domain.
+
+
+
+
+
arbitrary user-defined machine-readable data of this reserved domain.
+
+
+
+
+
reserve the domain in this geographic ngrok datacenter.
+
+
+
+
+
reserve the domain in this geographic ngrok datacenter.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ReservedDomains.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Delete a reserved domain.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ReservedDomains.DeleteCertificateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Detach the certificate attached to a reserved domain.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ReservedDomains.DeleteCertificateManagementPolicyCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Detach the certificate management policy attached to a reserved domain.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ReservedDomains.DeleteHttpEndpointConfigCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Detach the http endpoint configuration attached to a reserved domain.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ReservedDomains.DeleteHttpsEndpointConfigCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Detach the https endpoint configuration attached to a reserved domain.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ReservedDomains.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Get the details of a reserved domain.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ReservedDomains.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
List all reserved domains on this account.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ReservedDomains.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
ID of a user-uploaded TLS certificate to use for connections to targeting this
+ domain.
+
+
+
+
+
ID of a user-uploaded TLS certificate to use for connections to targeting this
+ domain.
+
+
+
+
+
configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled.
+
+
+
+
+
configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled.
+
+
+
+
+
human-readable description of what this reserved domain will be used for
+
+
+
+
+
human-readable description of what this reserved domain will be used for
+
+
+
+
+
ID of an endpoint configuration of type http that will be used to handle inbound
+ http traffic to this domain
+
+
+
+
+
ID of an endpoint configuration of type http that will be used to handle inbound
+ http traffic to this domain
+
+
+
+
+
ID of an endpoint configuration of type https that will be used to handle
+ inbound https traffic to this domain
+
+
+
+
+
ID of an endpoint configuration of type https that will be used to handle
+ inbound https traffic to this domain
+
+
+
+
+
arbitrary user-defined machine-readable data of this reserved domain.
+
+
+
+
+
arbitrary user-defined machine-readable data of this reserved domain.
+
+
+
+
+
Update the attributes of a reserved domain.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.ReservedDomains (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Reserved Domains are hostnames that you can listen for traffic on.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.SshCertificateAuthorities.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SshCertificateAuthorities. create
+
+
+
+
+
human-readable description of this SSH Certificate Authority.
+
+
+
+
+
human-readable description of this SSH Certificate Authority.
+
+
+
+
+
the type of elliptic curve to use when creating an ECDSA key
+
+
+
+
+
the type of elliptic curve to use when creating an ECDSA key
+
+
+
SshCertificateAuthorities.CreateCallBuilder. keySize
+
+
the key size to use when creating an RSA key.
+
+
+
+
+
the key size to use when creating an RSA key.
+
+
+
SshCertificateAuthorities.CreateCallBuilder. metadata String metadata)
+
+
arbitrary user-defined machine-readable data of this SSH Certificate Authority.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH Certificate Authority.
+
+
+
+
+
the type of private key to generate.
+
+
+
+
+
the type of private key to generate.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.SshCertificateAuthorities.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/SshCertificateAuthorities.GetCallBuilder.html b/docs/com/ngrok/services/class-use/SshCertificateAuthorities.GetCallBuilder.html
new file mode 100644
index 0000000..aea03d3
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/SshCertificateAuthorities.GetCallBuilder.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.SshCertificateAuthorities.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/SshCertificateAuthorities.ListCallBuilder.html b/docs/com/ngrok/services/class-use/SshCertificateAuthorities.ListCallBuilder.html
new file mode 100644
index 0000000..e6125d2
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/SshCertificateAuthorities.ListCallBuilder.html
@@ -0,0 +1,114 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.SshCertificateAuthorities.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
SshCertificateAuthorities.ListCallBuilder. limit String limit)
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
SshCertificateAuthorities. list
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.SshCertificateAuthorities.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
human-readable description of this SSH Certificate Authority.
+
+
+
+
+
human-readable description of this SSH Certificate Authority.
+
+
+
SshCertificateAuthorities.UpdateCallBuilder. metadata String metadata)
+
+
arbitrary user-defined machine-readable data of this SSH Certificate Authority.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH Certificate Authority.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.SshCertificateAuthorities (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
An SSH Certificate Authority is a pair of an SSH Certificate and its private
+ key that can be used to sign other SSH host and user certificates.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.SshCredentials.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
optional list of ACL rules.
+
+
+
+
+
optional list of ACL rules.
+
+
+
+
+
Create a new ssh_credential from an uploaded public SSH key.
+
+
+
+
+
human-readable description of who or what will use the ssh credential to
+ authenticate.
+
+
+
+
+
human-readable description of who or what will use the ssh credential to
+ authenticate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this ssh credential.
+
+
+
+
+
arbitrary user-defined machine-readable data of this ssh credential.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.SshCredentials.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/SshCredentials.GetCallBuilder.html b/docs/com/ngrok/services/class-use/SshCredentials.GetCallBuilder.html
new file mode 100644
index 0000000..119c43f
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/SshCredentials.GetCallBuilder.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.SshCredentials.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/SshCredentials.ListCallBuilder.html b/docs/com/ngrok/services/class-use/SshCredentials.ListCallBuilder.html
new file mode 100644
index 0000000..976da8f
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/SshCredentials.ListCallBuilder.html
@@ -0,0 +1,114 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.SshCredentials.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.SshCredentials.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
optional list of ACL rules.
+
+
+
+
+
optional list of ACL rules.
+
+
+
+
+
human-readable description of who or what will use the ssh credential to
+ authenticate.
+
+
+
+
+
human-readable description of who or what will use the ssh credential to
+ authenticate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this ssh credential.
+
+
+
+
+
arbitrary user-defined machine-readable data of this ssh credential.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.SshCredentials (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SSH Credentials are SSH public keys that can be used to start SSH tunnels
+ via the ngrok SSH tunnel gateway.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.SshHostCertificates.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
human-readable description of this SSH Host Certificate.
+
+
+
+
+
human-readable description of this SSH Host Certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH Host Certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH Host Certificate.
+
+
+
+
+
the list of principals included in the ssh host certificate.
+
+
+
+
+
the list of principals included in the ssh host certificate.
+
+
+
+
+
The time when the host certificate becomes valid, in RFC 3339 format.
+
+
+
+
+
The time when the host certificate becomes valid, in RFC 3339 format.
+
+
+
+
+
The time when this host certificate becomes invalid, in RFC 3339 format.
+
+
+
+
+
The time when this host certificate becomes invalid, in RFC 3339 format.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.SshHostCertificates.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/SshHostCertificates.GetCallBuilder.html b/docs/com/ngrok/services/class-use/SshHostCertificates.GetCallBuilder.html
new file mode 100644
index 0000000..e18e989
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/SshHostCertificates.GetCallBuilder.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.SshHostCertificates.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/SshHostCertificates.ListCallBuilder.html b/docs/com/ngrok/services/class-use/SshHostCertificates.ListCallBuilder.html
new file mode 100644
index 0000000..979e5fc
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/SshHostCertificates.ListCallBuilder.html
@@ -0,0 +1,114 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.SshHostCertificates.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
SshHostCertificates.ListCallBuilder. limit String limit)
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
SshHostCertificates. list
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.SshHostCertificates.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
human-readable description of this SSH Host Certificate.
+
+
+
+
+
human-readable description of this SSH Host Certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH Host Certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH Host Certificate.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.SshHostCertificates (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SSH Host Certificates along with the corresponding private key allows an SSH
+ server to assert its authenticity to connecting SSH clients who trust the
+ SSH Certificate Authority that was used to sign the certificate.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.SshUserCertificates.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A map of critical options included in the certificate.
+
+
+
+
+
A map of critical options included in the certificate.
+
+
+
+
+
human-readable description of this SSH User Certificate.
+
+
+
+
+
human-readable description of this SSH User Certificate.
+
+
+
+
+
A map of extensions included in the certificate.
+
+
+
+
+
A map of extensions included in the certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH User Certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH User Certificate.
+
+
+
+
+
the list of principals included in the ssh user certificate.
+
+
+
+
+
the list of principals included in the ssh user certificate.
+
+
+
+
+
The time when the user certificate becomes valid, in RFC 3339 format.
+
+
+
+
+
The time when the user certificate becomes valid, in RFC 3339 format.
+
+
+
+
+
The time when this host certificate becomes invalid, in RFC 3339 format.
+
+
+
+
+
The time when this host certificate becomes invalid, in RFC 3339 format.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.SshUserCertificates.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/SshUserCertificates.GetCallBuilder.html b/docs/com/ngrok/services/class-use/SshUserCertificates.GetCallBuilder.html
new file mode 100644
index 0000000..3613ca5
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/SshUserCertificates.GetCallBuilder.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.SshUserCertificates.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/SshUserCertificates.ListCallBuilder.html b/docs/com/ngrok/services/class-use/SshUserCertificates.ListCallBuilder.html
new file mode 100644
index 0000000..ab64ddc
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/SshUserCertificates.ListCallBuilder.html
@@ -0,0 +1,114 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.SshUserCertificates.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
SshUserCertificates.ListCallBuilder. limit String limit)
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
SshUserCertificates. list
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.SshUserCertificates.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
human-readable description of this SSH User Certificate.
+
+
+
+
+
human-readable description of this SSH User Certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH User Certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this SSH User Certificate.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.SshUserCertificates (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SSH User Certificates are presented by SSH clients when connecting to an SSH
+ server to authenticate their connection.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.TlsCertificates.CreateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
human-readable description of this TLS certificate.
+
+
+
+
+
human-readable description of this TLS certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this TLS certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this TLS certificate.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.TlsCertificates.DeleteCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/TlsCertificates.GetCallBuilder.html b/docs/com/ngrok/services/class-use/TlsCertificates.GetCallBuilder.html
new file mode 100644
index 0000000..14f85f9
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/TlsCertificates.GetCallBuilder.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.TlsCertificates.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/TlsCertificates.ListCallBuilder.html b/docs/com/ngrok/services/class-use/TlsCertificates.ListCallBuilder.html
new file mode 100644
index 0000000..625fd16
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/TlsCertificates.ListCallBuilder.html
@@ -0,0 +1,114 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.TlsCertificates.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.TlsCertificates.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
human-readable description of this TLS certificate.
+
+
+
+
+
human-readable description of this TLS certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this TLS certificate.
+
+
+
+
+
arbitrary user-defined machine-readable data of this TLS certificate.
+
+
+
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.TlsCertificates (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
TLS Certificates are pairs of x509 certificates and their matching private
+ key that can be used to terminate TLS traffic.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.TunnelSessions.GetCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/class-use/TunnelSessions.ListCallBuilder.html b/docs/com/ngrok/services/class-use/TunnelSessions.ListCallBuilder.html
new file mode 100644
index 0000000..7fc24f3
--- /dev/null
+++ b/docs/com/ngrok/services/class-use/TunnelSessions.ListCallBuilder.html
@@ -0,0 +1,112 @@
+
+
+
+
+
+Uses of Class com.ngrok.services.TunnelSessions.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
List all online tunnel sessions running on this account.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.TunnelSessions.RestartCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Issues a command instructing the ngrok agent to restart.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.TunnelSessions.StopCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Issues a command instructing the ngrok agent that started this tunnel session to
+ exit.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.TunnelSessions.UpdateCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Issues a command instructing the ngrok agent to update itself to the latest
+ version.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.TunnelSessions (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
+ sessions that are running and connected to the ngrok service.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.Tunnels.ListCallBuilder (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets the before_id parameter.
+
+
+
+
+
Sets (or unsets) the before_id parameter.
+
+
+
+
+
Sets the limit parameter.
+
+
+
+
+
Sets (or unsets) the limit parameter.
+
+
+
+
+
List all online tunnels currently running on the account.
+
+
+
+
+
+
+
+
+
Uses of Class com.ngrok.services.Tunnels (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Tunnels provide endpoints to access services exposed by a running ngrok
+ agent tunnel session or an SSH reverse tunnel session.
+
+
+
+
+
+
+
+
+
com.ngrok.services (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+package com.ngrok.services
+
+
+
+Class Summary
+
+
+
+
+
+
Abuse Reports allow you to submit take-down requests for URLs hosted by
+ ngrok that violate ngrok's terms of service.
+
+
+
+
+
+
+
+
Certificate Authorities are x509 certificates that are used to sign other
+ x509 certificates.
+
+
+
+
Tunnel Credentials are ngrok agent authtokens.
+
+
+
+
+
+
+
+
Endpoint Configurations are a reusable group of modules that encapsulate how
+ traffic to a domain or address is handled.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
IP Policies are reusable groups of CIDR ranges with an allow or
+ deny
+ action.
+
+
+
+
IP Policy Rules are the IPv4 or IPv6 CIDRs entries that
+ make up an IP Policy.
+
+
+
+
An IP restriction is a restriction placed on the CIDRs that are allowed to
+ initate traffic to a specific aspect of your ngrok account.
+
+
+
+
Reserved Addresses are TCP addresses that can be used to listen for traffic.
+
+
+
+
Reserved Domains are hostnames that you can listen for traffic on.
+
+
+
+
An SSH Certificate Authority is a pair of an SSH Certificate and its private
+ key that can be used to sign other SSH host and user certificates.
+
+
+
+
SSH Credentials are SSH public keys that can be used to start SSH tunnels
+ via the ngrok SSH tunnel gateway.
+
+
+
+
SSH Host Certificates along with the corresponding private key allows an SSH
+ server to assert its authenticity to connecting SSH clients who trust the
+ SSH Certificate Authority that was used to sign the certificate.
+
+
+
+
SSH User Certificates are presented by SSH clients when connecting to an SSH
+ server to authenticate their connection.
+
+
+
+
TLS Certificates are pairs of x509 certificates and their matching private
+ key that can be used to terminate TLS traffic.
+
+
+
+
Tunnels provide endpoints to access services exposed by a running ngrok
+ agent tunnel session or an SSH reverse tunnel session.
+
+
+
+
Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
+ sessions that are running and connected to the ngrok service.
+
+
+
+
+
+
+
+
com.ngrok.services Class Hierarchy (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/com/ngrok/services/package-use.html b/docs/com/ngrok/services/package-use.html
new file mode 100644
index 0000000..24c5b6a
--- /dev/null
+++ b/docs/com/ngrok/services/package-use.html
@@ -0,0 +1,824 @@
+
+
+
+
+
+Uses of Package com.ngrok.services (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Abuse Reports allow you to submit take-down requests for URLs hosted by
+ ngrok that violate ngrok's terms of service.
+
+
+
+
+
+
+
+
Certificate Authorities are x509 certificates that are used to sign other
+ x509 certificates.
+
+
+
+
Tunnel Credentials are ngrok agent authtokens.
+
+
+
+
+
+
+
+
Endpoint Configurations are a reusable group of modules that encapsulate how
+ traffic to a domain or address is handled.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
IP Policies are reusable groups of CIDR ranges with an allow or
+ deny
+ action.
+
+
+
+
IP Policy Rules are the IPv4 or IPv6 CIDRs entries that
+ make up an IP Policy.
+
+
+
+
An IP restriction is a restriction placed on the CIDRs that are allowed to
+ initate traffic to a specific aspect of your ngrok account.
+
+
+
+
Reserved Addresses are TCP addresses that can be used to listen for traffic.
+
+
+
+
Reserved Domains are hostnames that you can listen for traffic on.
+
+
+
+
An SSH Certificate Authority is a pair of an SSH Certificate and its private
+ key that can be used to sign other SSH host and user certificates.
+
+
+
+
SSH Credentials are SSH public keys that can be used to start SSH tunnels
+ via the ngrok SSH tunnel gateway.
+
+
+
+
SSH Host Certificates along with the corresponding private key allows an SSH
+ server to assert its authenticity to connecting SSH clients who trust the
+ SSH Certificate Authority that was used to sign the certificate.
+
+
+
+
SSH User Certificates are presented by SSH clients when connecting to an SSH
+ server to authenticate their connection.
+
+
+
+
TLS Certificates are pairs of x509 certificates and their matching private
+ key that can be used to terminate TLS traffic.
+
+
+
+
Tunnels provide endpoints to access services exposed by a running ngrok
+ agent tunnel session or an SSH reverse tunnel session.
+
+
+
+
Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
+ sessions that are running and connected to the ngrok service.
+
+
+
+
+
+
+
+
+
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent Replace API call.
+
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent DeleteEndpointConfig API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent DeleteCertificate API call.
+
+
+
+
A builder object encapsulating state for an unsent DeleteCertificateManagementPolicy API call.
+
+
+
+
A builder object encapsulating state for an unsent DeleteHttpEndpointConfig API call.
+
+
+
+
A builder object encapsulating state for an unsent DeleteHttpsEndpointConfig API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
A builder object encapsulating state for an unsent Create API call.
+
+
+
+
A builder object encapsulating state for an unsent Delete API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
A builder object encapsulating state for an unsent Get API call.
+
+
+
+
A builder object encapsulating state for an unsent List API call.
+
+
+
+
A builder object encapsulating state for an unsent Restart API call.
+
+
+
+
A builder object encapsulating state for an unsent Stop API call.
+
+
+
+
A builder object encapsulating state for an unsent Update API call.
+
+
+
+
+
+
+
+
+
Constant Field Values (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+com.ngrok.*
+
+
+
+
+
+
+
+
+
+
"2"
+
+
+
"0.2.0"
+
+
+
+
+
+
+
API Help (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+Overview
+The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+
+
+Package
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain six categories:
+
+Interfaces
+Classes
+Enums
+Exceptions
+Errors
+Annotation Types
+
+
+
+Class or Interface
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+
+Class Inheritance Diagram
+Direct Subclasses
+All Known Subinterfaces
+All Known Implementing Classes
+Class or Interface Declaration
+Class or Interface Description
+
+
+Nested Class Summary
+Field Summary
+Property Summary
+Constructor Summary
+Method Summary
+
+
+Field Details
+Property Details
+Constructor Details
+Method Details
+
+The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+
+
+Annotation Type
+Each annotation type has its own separate page with the following sections:
+
+Annotation Type Declaration
+Annotation Type Description
+Required Element Summary
+Optional Element Summary
+Element Details
+
+
+
+Enum
+Each enum has its own separate page with the following sections:
+
+Enum Declaration
+Enum Description
+Enum Constant Summary
+Enum Constant Details
+
+
+
+Use
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its "Use" page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+
+
+Tree (Class Hierarchy)
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.
+
+When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
+When viewing a particular package, class or interface page, clicking on "Tree" displays the hierarchy for only that package.
+
+
+
+Index
+The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields, as well as lists of all packages and all classes.
+
+
+Serialized Form
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.
+
+
+
+Search
+You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API, using some or all of the name, optionally using "camel-case" abbreviations. For example:
+
+j.l.obj will match "java.lang.Object"InpStr will match "java.io.InputStream"HM.cK will match "java.util.HashMap.containsKey(Object)"
+Refer to the Javadoc Search Specification for a full description of search features.
+
+
+
+
+
Index (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+A B C D E F G H I K L M N O P R S T U V W All Classes | All Packages | Constant Field Values | Serialized Form
+A
+
+AbuseReport com.ngrok.definitions
+
+
+AbuseReport(String, URI, OffsetDateTime, List<URI>, String, String, List<AbuseReportHostname>) AbuseReport
+
+
+AbuseReportHostname com.ngrok.definitions
+
+
+AbuseReportHostname(String, String) AbuseReportHostname
+
+
+abuseReports() Ngrok
+Abuse Reports allow you to submit take-down requests for URLs hosted by
+ ngrok that violate ngrok's terms of service.
+
+AbuseReports com.ngrok.services
+Abuse Reports allow you to submit take-down requests for URLs hosted by
+ ngrok that violate ngrok's terms of service.
+
+AbuseReports(NgrokApiClient) AbuseReports
+Creates a new sub-client for AbuseReports.
+
+AbuseReports.CreateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Create API call.
+
+AbuseReports.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+acl(List<String>) Credentials.CreateCallBuilder
+optional list of ACL rules.
+
+acl(List<String>) Credentials.UpdateCallBuilder
+optional list of ACL rules.
+
+acl(List<String>) SshCredentials.CreateCallBuilder
+optional list of ACL rules.
+
+acl(List<String>) SshCredentials.UpdateCallBuilder
+optional list of ACL rules.
+
+acl(Optional<List<String>>) Credentials.CreateCallBuilder
+optional list of ACL rules.
+
+acl(Optional<List<String>>) Credentials.UpdateCallBuilder
+optional list of ACL rules.
+
+acl(Optional<List<String>>) SshCredentials.CreateCallBuilder
+optional list of ACL rules.
+
+acl(Optional<List<String>>) SshCredentials.UpdateCallBuilder
+optional list of ACL rules.
+
+add(Map<String, String>) EndpointRequestHeaders.Builder
+a map of header key to header value that will be injected into the HTTP Request
+ before being sent to the upstream application server
+
+add(Map<String, String>) EndpointResponseHeaders.Builder
+a map of header key to header value that will be injected into the HTTP Response
+ returned to the HTTP client
+
+add(Optional<Map<String, String>>) EndpointRequestHeaders.Builder
+a map of header key to header value that will be injected into the HTTP Request
+ before being sent to the upstream application server
+
+add(Optional<Map<String, String>>) EndpointResponseHeaders.Builder
+a map of header key to header value that will be injected into the HTTP Response
+ returned to the HTTP client
+
+AgentIngress com.ngrok.definitions
+
+
+AgentIngress(String, URI, String, String, String, List<String>, List<String>, String) AgentIngress
+
+
+agentIngresses() Ngrok
+Creates a service client for AgentIngresses.
+
+AgentIngresses com.ngrok.services
+
+
+AgentIngresses(NgrokApiClient) AgentIngresses
+Creates a new sub-client for AgentIngresses.
+
+AgentIngresses.CreateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Create API call.
+
+AgentIngresses.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+AgentIngresses.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+AgentIngresses.ListCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent List API call.
+
+AgentIngresses.UpdateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Update API call.
+
+AgentIngressList com.ngrok.definitions
+
+
+AgentIngressList(List<AgentIngress>, URI, Optional<URI>) AgentIngressList
+
+
+allowIdpInitiated(boolean) EndpointSamlMutate.Builder
+If true, the IdP may initiate a login directly (e.g.
+
+allowIdpInitiated(Optional<Boolean>) EndpointSamlMutate.Builder
+If true, the IdP may initiate a login directly (e.g.
+
+API_VERSION Version
+The ngrok API version in use
+
+ApiKey com.ngrok.definitions
+A class encapsulating the
ApiKey resource.
+ApiKey(String, URI, String, String, OffsetDateTime, Optional<String>) ApiKey
+Creates a new instance of
ApiKey.
+ApiKeyList com.ngrok.definitions
+
+
+ApiKeyList(List<ApiKey>, URI, Optional<URI>) ApiKeyList
+
+
+apiKeys() Ngrok
+
+
+ApiKeys com.ngrok.services
+
+
+ApiKeys(NgrokApiClient) ApiKeys
+Creates a new sub-client for ApiKeys.
+
+ApiKeys.CreateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Create API call.
+
+ApiKeys.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+ApiKeys.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+ApiKeys.ListCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent List API call.
+
+ApiKeys.UpdateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Update API call.
+
+auth(AwsAuth) EventTargetCloudwatchLogs.Builder
+Configuration for how to authenticate into your AWS account.
+
+auth(AwsAuth) EventTargetFirehose.Builder
+Configuration for how to authenticate into your AWS account.
+
+auth(AwsAuth) EventTargetKinesis.Builder
+Configuration for how to authenticate into your AWS account.
+
+auth(Optional<AwsAuth>) EventTargetCloudwatchLogs.Builder
+Configuration for how to authenticate into your AWS account.
+
+auth(Optional<AwsAuth>) EventTargetFirehose.Builder
+Configuration for how to authenticate into your AWS account.
+
+auth(Optional<AwsAuth>) EventTargetKinesis.Builder
+Configuration for how to authenticate into your AWS account.
+
+authCheckInterval(long) EndpointOAuth.Builder
+Integer number of seconds after which ngrok guarantees it will refresh user
+ state from the identity provider and recheck whether the user is still
+ authorized to access the endpoint.
+
+authCheckInterval(Optional<Long>) EndpointOAuth.Builder
+Integer number of seconds after which ngrok guarantees it will refresh user
+ state from the identity provider and recheck whether the user is still
+ authorized to access the endpoint.
+
+authority(String) ReservedDomainCertPolicy.Builder
+certificate authority to request certificates from.
+
+authority(Optional<String>) ReservedDomainCertPolicy.Builder
+certificate authority to request certificates from.
+
+authorizedGroups(List<String>) EndpointSamlMutate.Builder
+If present, only users who are a member of one of the listed groups may access
+ the target endpoint.
+
+authorizedGroups(Optional<List<String>>) EndpointSamlMutate.Builder
+If present, only users who are a member of one of the listed groups may access
+ the target endpoint.
+
+AwsAuth com.ngrok.definitions
+A class encapsulating the
AwsAuth resource.
+AwsAuth.Builder com.ngrok.definitions
+
+
+AwsCredentials com.ngrok.definitions
+
+
+AwsCredentials.Builder com.ngrok.definitions
+
+
+AwsRole com.ngrok.definitions
+A class encapsulating the
AwsRole resource.
+AwsRole.Builder com.ngrok.definitions
+
+
+
+B
+
+baseUri(URI) DefaultNgrokApiClient.Builder
+Sets the API base URI.
+
+baseUri(Optional<URI>) DefaultNgrokApiClient.Builder
+Sets the API base URI.
+
+beforeId(String) AgentIngresses.ListCallBuilder
+Sets the before_id parameter.
+
+beforeId(String) ApiKeys.ListCallBuilder
+Sets the before_id parameter.
+
+beforeId(String) CertificateAuthorities.ListCallBuilder
+Sets the before_id parameter.
+
+beforeId(String) Credentials.ListCallBuilder
+Sets the before_id parameter.
+
+beforeId(String) EndpointConfigurations.ListCallBuilder
+Sets the before_id parameter.
+
+beforeId(String) EventDestinations.ListCallBuilder
+Sets the before_id parameter.
+
+beforeId(String) EventStreams.ListCallBuilder
+Sets the before_id parameter.
+
+beforeId(String) EventSubscriptions.ListCallBuilder
+Sets the before_id parameter.
+
+beforeId(String) IpPolicies.ListCallBuilder
+Sets the before_id parameter.
+
+beforeId(String) IpPolicyRules.ListCallBuilder
+Sets the before_id parameter.
+
+beforeId(String) IpRestrictions.ListCallBuilder
+Sets the before_id parameter.
+
+beforeId(String) ReservedAddrs.ListCallBuilder
+Sets the before_id parameter.
+
+beforeId(String) ReservedDomains.ListCallBuilder
+Sets the before_id parameter.
+
+beforeId(String) SshCertificateAuthorities.ListCallBuilder
+Sets the before_id parameter.
+
+beforeId(String) SshCredentials.ListCallBuilder
+Sets the before_id parameter.
+
+beforeId(String) SshHostCertificates.ListCallBuilder
+Sets the before_id parameter.
+
+beforeId(String) SshUserCertificates.ListCallBuilder
+Sets the before_id parameter.
+
+beforeId(String) TlsCertificates.ListCallBuilder
+Sets the before_id parameter.
+
+beforeId(String) Tunnels.ListCallBuilder
+Sets the before_id parameter.
+
+beforeId(String) TunnelSessions.ListCallBuilder
+Sets the before_id parameter.
+
+beforeId(Optional<String>) AgentIngresses.ListCallBuilder
+Sets (or unsets) the before_id parameter.
+
+beforeId(Optional<String>) ApiKeys.ListCallBuilder
+Sets (or unsets) the before_id parameter.
+
+beforeId(Optional<String>) CertificateAuthorities.ListCallBuilder
+Sets (or unsets) the before_id parameter.
+
+beforeId(Optional<String>) Credentials.ListCallBuilder
+Sets (or unsets) the before_id parameter.
+
+beforeId(Optional<String>) EndpointConfigurations.ListCallBuilder
+Sets (or unsets) the before_id parameter.
+
+beforeId(Optional<String>) EventDestinations.ListCallBuilder
+Sets (or unsets) the before_id parameter.
+
+beforeId(Optional<String>) EventStreams.ListCallBuilder
+Sets (or unsets) the before_id parameter.
+
+beforeId(Optional<String>) EventSubscriptions.ListCallBuilder
+Sets (or unsets) the before_id parameter.
+
+beforeId(Optional<String>) IpPolicies.ListCallBuilder
+Sets (or unsets) the before_id parameter.
+
+beforeId(Optional<String>) IpPolicyRules.ListCallBuilder
+Sets (or unsets) the before_id parameter.
+
+beforeId(Optional<String>) IpRestrictions.ListCallBuilder
+Sets (or unsets) the before_id parameter.
+
+beforeId(Optional<String>) ReservedAddrs.ListCallBuilder
+Sets (or unsets) the before_id parameter.
+
+beforeId(Optional<String>) ReservedDomains.ListCallBuilder
+Sets (or unsets) the before_id parameter.
+
+beforeId(Optional<String>) SshCertificateAuthorities.ListCallBuilder
+Sets (or unsets) the before_id parameter.
+
+beforeId(Optional<String>) SshCredentials.ListCallBuilder
+Sets (or unsets) the before_id parameter.
+
+beforeId(Optional<String>) SshHostCertificates.ListCallBuilder
+Sets (or unsets) the before_id parameter.
+
+beforeId(Optional<String>) SshUserCertificates.ListCallBuilder
+Sets (or unsets) the before_id parameter.
+
+beforeId(Optional<String>) TlsCertificates.ListCallBuilder
+Sets (or unsets) the before_id parameter.
+
+beforeId(Optional<String>) Tunnels.ListCallBuilder
+Sets (or unsets) the before_id parameter.
+
+beforeId(Optional<String>) TunnelSessions.ListCallBuilder
+Sets (or unsets) the before_id parameter.
+
+blockingCall() AbuseReports.CreateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() AbuseReports.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() AgentIngresses.CreateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() AgentIngresses.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() AgentIngresses.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() AgentIngresses.ListCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() AgentIngresses.UpdateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() ApiKeys.CreateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() ApiKeys.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() ApiKeys.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() ApiKeys.ListCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() ApiKeys.UpdateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() CertificateAuthorities.CreateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() CertificateAuthorities.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() CertificateAuthorities.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() CertificateAuthorities.ListCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() CertificateAuthorities.UpdateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() Credentials.CreateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() Credentials.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() Credentials.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() Credentials.ListCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() Credentials.UpdateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointCircuitBreakerModule.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointCircuitBreakerModule.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointCircuitBreakerModule.ReplaceCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointCompressionModule.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointCompressionModule.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointCompressionModule.ReplaceCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointConfigurations.CreateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointConfigurations.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointConfigurations.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointConfigurations.ListCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointConfigurations.UpdateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointIpPolicyModule.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointIpPolicyModule.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointIpPolicyModule.ReplaceCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointLoggingModule.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointLoggingModule.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointLoggingModule.ReplaceCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointMutualTlsModule.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointMutualTlsModule.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointMutualTlsModule.ReplaceCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointOAuthModule.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointOAuthModule.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointOAuthModule.ReplaceCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointOidcModule.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointOidcModule.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointOidcModule.ReplaceCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointRequestHeadersModule.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointRequestHeadersModule.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointRequestHeadersModule.ReplaceCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointResponseHeadersModule.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointResponseHeadersModule.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointResponseHeadersModule.ReplaceCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointSamlModule.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointSamlModule.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointSamlModule.ReplaceCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointTlsTerminationModule.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointTlsTerminationModule.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointTlsTerminationModule.ReplaceCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointWebhookValidationModule.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointWebhookValidationModule.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EndpointWebhookValidationModule.ReplaceCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EventDestinations.CreateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EventDestinations.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EventDestinations.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EventDestinations.ListCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EventDestinations.UpdateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EventSources.CreateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EventSources.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EventSources.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EventSources.ListCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EventSources.UpdateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EventStreams.CreateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EventStreams.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EventStreams.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EventStreams.ListCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EventStreams.UpdateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EventSubscriptions.CreateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EventSubscriptions.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EventSubscriptions.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EventSubscriptions.ListCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() EventSubscriptions.UpdateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() IpPolicies.CreateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() IpPolicies.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() IpPolicies.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() IpPolicies.ListCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() IpPolicies.UpdateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() IpPolicyRules.CreateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() IpPolicyRules.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() IpPolicyRules.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() IpPolicyRules.ListCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() IpPolicyRules.UpdateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() IpRestrictions.CreateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() IpRestrictions.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() IpRestrictions.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() IpRestrictions.ListCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() IpRestrictions.UpdateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() ReservedAddrs.CreateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() ReservedAddrs.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() ReservedAddrs.DeleteEndpointConfigCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() ReservedAddrs.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() ReservedAddrs.ListCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() ReservedAddrs.UpdateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() ReservedDomains.CreateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() ReservedDomains.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() ReservedDomains.DeleteCertificateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() ReservedDomains.DeleteCertificateManagementPolicyCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() ReservedDomains.DeleteHttpEndpointConfigCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() ReservedDomains.DeleteHttpsEndpointConfigCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() ReservedDomains.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() ReservedDomains.ListCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() ReservedDomains.UpdateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() SshCertificateAuthorities.CreateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() SshCertificateAuthorities.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() SshCertificateAuthorities.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() SshCertificateAuthorities.ListCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() SshCertificateAuthorities.UpdateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() SshCredentials.CreateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() SshCredentials.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() SshCredentials.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() SshCredentials.ListCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() SshCredentials.UpdateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() SshHostCertificates.CreateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() SshHostCertificates.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() SshHostCertificates.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() SshHostCertificates.ListCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() SshHostCertificates.UpdateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() SshUserCertificates.CreateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() SshUserCertificates.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() SshUserCertificates.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() SshUserCertificates.ListCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() SshUserCertificates.UpdateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() TlsCertificates.CreateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() TlsCertificates.DeleteCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() TlsCertificates.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() TlsCertificates.ListCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() TlsCertificates.UpdateCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() Tunnels.ListCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() TunnelSessions.GetCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() TunnelSessions.ListCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() TunnelSessions.RestartCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() TunnelSessions.StopCallBuilder
+Initiates the API call and blocks until it returns.
+
+blockingCall() TunnelSessions.UpdateCallBuilder
+Initiates the API call and blocks until it returns.
+
+build() DefaultNgrokApiClient.Builder
+Builds the ngrok API client instance.
+
+build() AwsAuth.Builder
+
+
+build() AwsCredentials.Builder
+
+
+build() AwsRole.Builder
+
+
+build() EndpointCircuitBreaker.Builder
+
+
+build() EndpointCompression.Builder
+
+
+build() EndpointIpPolicyMutate.Builder
+
+
+build() EndpointLoggingMutate.Builder
+
+
+build() EndpointMutualTlsMutate.Builder
+
+
+build() EndpointOAuth.Builder
+
+
+build() EndpointOAuthFacebook.Builder
+
+
+build() EndpointOAuthGitHub.Builder
+
+
+build() EndpointOAuthGoogle.Builder
+
+
+build() EndpointOAuthMicrosoft.Builder
+
+
+build() EndpointOAuthProvider.Builder
+
+
+build() EndpointOidc.Builder
+
+
+build() EndpointRequestHeaders.Builder
+
+
+build() EndpointResponseHeaders.Builder
+
+
+build() EndpointSamlMutate.Builder
+
+
+build() EndpointTlsTermination.Builder
+
+
+build() EndpointWebhookValidation.Builder
+
+
+build() EventSourceReplace.Builder
+
+
+build() EventTarget.Builder
+
+
+build() EventTargetCloudwatchLogs.Builder
+
+
+build() EventTargetFirehose.Builder
+
+
+build() EventTargetKinesis.Builder
+
+
+build() ReservedDomainCertPolicy.Builder
+
+
+
+C
+
+call() AbuseReports.CreateCallBuilder
+Initiates the API call asynchronously.
+
+call() AbuseReports.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() AgentIngresses.CreateCallBuilder
+Initiates the API call asynchronously.
+
+call() AgentIngresses.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() AgentIngresses.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() AgentIngresses.ListCallBuilder
+Initiates the API call asynchronously.
+
+call() AgentIngresses.UpdateCallBuilder
+Initiates the API call asynchronously.
+
+call() ApiKeys.CreateCallBuilder
+Initiates the API call asynchronously.
+
+call() ApiKeys.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() ApiKeys.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() ApiKeys.ListCallBuilder
+Initiates the API call asynchronously.
+
+call() ApiKeys.UpdateCallBuilder
+Initiates the API call asynchronously.
+
+call() CertificateAuthorities.CreateCallBuilder
+Initiates the API call asynchronously.
+
+call() CertificateAuthorities.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() CertificateAuthorities.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() CertificateAuthorities.ListCallBuilder
+Initiates the API call asynchronously.
+
+call() CertificateAuthorities.UpdateCallBuilder
+Initiates the API call asynchronously.
+
+call() Credentials.CreateCallBuilder
+Initiates the API call asynchronously.
+
+call() Credentials.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() Credentials.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() Credentials.ListCallBuilder
+Initiates the API call asynchronously.
+
+call() Credentials.UpdateCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointCircuitBreakerModule.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointCircuitBreakerModule.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointCircuitBreakerModule.ReplaceCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointCompressionModule.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointCompressionModule.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointCompressionModule.ReplaceCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointConfigurations.CreateCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointConfigurations.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointConfigurations.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointConfigurations.ListCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointConfigurations.UpdateCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointIpPolicyModule.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointIpPolicyModule.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointIpPolicyModule.ReplaceCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointLoggingModule.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointLoggingModule.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointLoggingModule.ReplaceCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointMutualTlsModule.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointMutualTlsModule.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointMutualTlsModule.ReplaceCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointOAuthModule.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointOAuthModule.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointOAuthModule.ReplaceCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointOidcModule.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointOidcModule.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointOidcModule.ReplaceCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointRequestHeadersModule.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointRequestHeadersModule.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointRequestHeadersModule.ReplaceCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointResponseHeadersModule.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointResponseHeadersModule.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointResponseHeadersModule.ReplaceCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointSamlModule.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointSamlModule.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointSamlModule.ReplaceCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointTlsTerminationModule.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointTlsTerminationModule.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointTlsTerminationModule.ReplaceCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointWebhookValidationModule.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointWebhookValidationModule.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() EndpointWebhookValidationModule.ReplaceCallBuilder
+Initiates the API call asynchronously.
+
+call() EventDestinations.CreateCallBuilder
+Initiates the API call asynchronously.
+
+call() EventDestinations.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() EventDestinations.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() EventDestinations.ListCallBuilder
+Initiates the API call asynchronously.
+
+call() EventDestinations.UpdateCallBuilder
+Initiates the API call asynchronously.
+
+call() EventSources.CreateCallBuilder
+Initiates the API call asynchronously.
+
+call() EventSources.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() EventSources.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() EventSources.ListCallBuilder
+Initiates the API call asynchronously.
+
+call() EventSources.UpdateCallBuilder
+Initiates the API call asynchronously.
+
+call() EventStreams.CreateCallBuilder
+Initiates the API call asynchronously.
+
+call() EventStreams.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() EventStreams.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() EventStreams.ListCallBuilder
+Initiates the API call asynchronously.
+
+call() EventStreams.UpdateCallBuilder
+Initiates the API call asynchronously.
+
+call() EventSubscriptions.CreateCallBuilder
+Initiates the API call asynchronously.
+
+call() EventSubscriptions.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() EventSubscriptions.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() EventSubscriptions.ListCallBuilder
+Initiates the API call asynchronously.
+
+call() EventSubscriptions.UpdateCallBuilder
+Initiates the API call asynchronously.
+
+call() IpPolicies.CreateCallBuilder
+Initiates the API call asynchronously.
+
+call() IpPolicies.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() IpPolicies.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() IpPolicies.ListCallBuilder
+Initiates the API call asynchronously.
+
+call() IpPolicies.UpdateCallBuilder
+Initiates the API call asynchronously.
+
+call() IpPolicyRules.CreateCallBuilder
+Initiates the API call asynchronously.
+
+call() IpPolicyRules.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() IpPolicyRules.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() IpPolicyRules.ListCallBuilder
+Initiates the API call asynchronously.
+
+call() IpPolicyRules.UpdateCallBuilder
+Initiates the API call asynchronously.
+
+call() IpRestrictions.CreateCallBuilder
+Initiates the API call asynchronously.
+
+call() IpRestrictions.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() IpRestrictions.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() IpRestrictions.ListCallBuilder
+Initiates the API call asynchronously.
+
+call() IpRestrictions.UpdateCallBuilder
+Initiates the API call asynchronously.
+
+call() ReservedAddrs.CreateCallBuilder
+Initiates the API call asynchronously.
+
+call() ReservedAddrs.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() ReservedAddrs.DeleteEndpointConfigCallBuilder
+Initiates the API call asynchronously.
+
+call() ReservedAddrs.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() ReservedAddrs.ListCallBuilder
+Initiates the API call asynchronously.
+
+call() ReservedAddrs.UpdateCallBuilder
+Initiates the API call asynchronously.
+
+call() ReservedDomains.CreateCallBuilder
+Initiates the API call asynchronously.
+
+call() ReservedDomains.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() ReservedDomains.DeleteCertificateCallBuilder
+Initiates the API call asynchronously.
+
+call() ReservedDomains.DeleteCertificateManagementPolicyCallBuilder
+Initiates the API call asynchronously.
+
+call() ReservedDomains.DeleteHttpEndpointConfigCallBuilder
+Initiates the API call asynchronously.
+
+call() ReservedDomains.DeleteHttpsEndpointConfigCallBuilder
+Initiates the API call asynchronously.
+
+call() ReservedDomains.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() ReservedDomains.ListCallBuilder
+Initiates the API call asynchronously.
+
+call() ReservedDomains.UpdateCallBuilder
+Initiates the API call asynchronously.
+
+call() SshCertificateAuthorities.CreateCallBuilder
+Initiates the API call asynchronously.
+
+call() SshCertificateAuthorities.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() SshCertificateAuthorities.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() SshCertificateAuthorities.ListCallBuilder
+Initiates the API call asynchronously.
+
+call() SshCertificateAuthorities.UpdateCallBuilder
+Initiates the API call asynchronously.
+
+call() SshCredentials.CreateCallBuilder
+Initiates the API call asynchronously.
+
+call() SshCredentials.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() SshCredentials.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() SshCredentials.ListCallBuilder
+Initiates the API call asynchronously.
+
+call() SshCredentials.UpdateCallBuilder
+Initiates the API call asynchronously.
+
+call() SshHostCertificates.CreateCallBuilder
+Initiates the API call asynchronously.
+
+call() SshHostCertificates.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() SshHostCertificates.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() SshHostCertificates.ListCallBuilder
+Initiates the API call asynchronously.
+
+call() SshHostCertificates.UpdateCallBuilder
+Initiates the API call asynchronously.
+
+call() SshUserCertificates.CreateCallBuilder
+Initiates the API call asynchronously.
+
+call() SshUserCertificates.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() SshUserCertificates.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() SshUserCertificates.ListCallBuilder
+Initiates the API call asynchronously.
+
+call() SshUserCertificates.UpdateCallBuilder
+Initiates the API call asynchronously.
+
+call() TlsCertificates.CreateCallBuilder
+Initiates the API call asynchronously.
+
+call() TlsCertificates.DeleteCallBuilder
+Initiates the API call asynchronously.
+
+call() TlsCertificates.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() TlsCertificates.ListCallBuilder
+Initiates the API call asynchronously.
+
+call() TlsCertificates.UpdateCallBuilder
+Initiates the API call asynchronously.
+
+call() Tunnels.ListCallBuilder
+Initiates the API call asynchronously.
+
+call() TunnelSessions.GetCallBuilder
+Initiates the API call asynchronously.
+
+call() TunnelSessions.ListCallBuilder
+Initiates the API call asynchronously.
+
+call() TunnelSessions.RestartCallBuilder
+Initiates the API call asynchronously.
+
+call() TunnelSessions.StopCallBuilder
+Initiates the API call asynchronously.
+
+call() TunnelSessions.UpdateCallBuilder
+Initiates the API call asynchronously.
+
+certificateAuthorities() Ngrok
+Certificate Authorities are x509 certificates that are used to sign other
+ x509 certificates.
+
+CertificateAuthorities com.ngrok.services
+Certificate Authorities are x509 certificates that are used to sign other
+ x509 certificates.
+
+CertificateAuthorities(NgrokApiClient) CertificateAuthorities
+Creates a new sub-client for CertificateAuthorities.
+
+CertificateAuthorities.CreateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Create API call.
+
+CertificateAuthorities.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+CertificateAuthorities.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+CertificateAuthorities.ListCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent List API call.
+
+CertificateAuthorities.UpdateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Update API call.
+
+CertificateAuthority com.ngrok.definitions
+
+
+CertificateAuthority(String, URI, OffsetDateTime, String, String, String, String, OffsetDateTime, OffsetDateTime, List<String>, List<String>) CertificateAuthority
+
+
+certificateAuthorityIds(List<String>) EndpointMutualTlsMutate.Builder
+list of certificate authorities that will be used to validate the TLS client
+ certificate presnted by the initiatiator of the TLS connection
+
+certificateAuthorityIds(Optional<List<String>>) EndpointMutualTlsMutate.Builder
+list of certificate authorities that will be used to validate the TLS client
+ certificate presnted by the initiatiator of the TLS connection
+
+CertificateAuthorityList com.ngrok.definitions
+
+
+CertificateAuthorityList(List<CertificateAuthority>, URI, Optional<URI>) CertificateAuthorityList
+
+
+certificateId(String) ReservedDomains.CreateCallBuilder
+ID of a user-uploaded TLS certificate to use for connections to targeting this
+ domain.
+
+certificateId(String) ReservedDomains.UpdateCallBuilder
+ID of a user-uploaded TLS certificate to use for connections to targeting this
+ domain.
+
+certificateId(Optional<String>) ReservedDomains.CreateCallBuilder
+ID of a user-uploaded TLS certificate to use for connections to targeting this
+ domain.
+
+certificateId(Optional<String>) ReservedDomains.UpdateCallBuilder
+ID of a user-uploaded TLS certificate to use for connections to targeting this
+ domain.
+
+certificateManagementPolicy(ReservedDomainCertPolicy) ReservedDomains.CreateCallBuilder
+configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled.
+
+certificateManagementPolicy(ReservedDomainCertPolicy) ReservedDomains.UpdateCallBuilder
+configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled.
+
+certificateManagementPolicy(Optional<ReservedDomainCertPolicy>) ReservedDomains.CreateCallBuilder
+configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled.
+
+certificateManagementPolicy(Optional<ReservedDomainCertPolicy>) ReservedDomains.UpdateCallBuilder
+configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled.
+
+cidr(String) IpPolicyRules.UpdateCallBuilder
+an IP or IP range specified in CIDR notation.
+
+cidr(Optional<String>) IpPolicyRules.UpdateCallBuilder
+an IP or IP range specified in CIDR notation.
+
+circuitBreaker() Ngrok.PointcfgModuleNamespace
+
+
+circuitBreaker(EndpointCircuitBreaker) EndpointConfigurations.CreateCallBuilder
+circuit breaker module configuration or null
+
+circuitBreaker(EndpointCircuitBreaker) EndpointConfigurations.UpdateCallBuilder
+circuit breaker module configuration or null
+
+circuitBreaker(Optional<EndpointCircuitBreaker>) EndpointConfigurations.CreateCallBuilder
+circuit breaker module configuration or null
+
+circuitBreaker(Optional<EndpointCircuitBreaker>) EndpointConfigurations.UpdateCallBuilder
+circuit breaker module configuration or null
+
+CLIENT_VERSION Version
+This API client's version string
+
+clientId(String) EndpointOAuthFacebook.Builder
+the OAuth app client ID.
+
+clientId(String) EndpointOAuthGitHub.Builder
+the OAuth app client ID.
+
+clientId(String) EndpointOAuthGoogle.Builder
+the OAuth app client ID.
+
+clientId(String) EndpointOAuthMicrosoft.Builder
+the OAuth app client ID.
+
+clientId(String) EndpointOidc.Builder
+The OIDC app's client ID and OIDC audience.
+
+clientId(Optional<String>) EndpointOAuthFacebook.Builder
+the OAuth app client ID.
+
+clientId(Optional<String>) EndpointOAuthGitHub.Builder
+the OAuth app client ID.
+
+clientId(Optional<String>) EndpointOAuthGoogle.Builder
+the OAuth app client ID.
+
+clientId(Optional<String>) EndpointOAuthMicrosoft.Builder
+the OAuth app client ID.
+
+clientId(Optional<String>) EndpointOidc.Builder
+The OIDC app's client ID and OIDC audience.
+
+clientSecret(String) EndpointOAuthFacebook.Builder
+the OAuth app client secret.
+
+clientSecret(String) EndpointOAuthGitHub.Builder
+the OAuth app client secret.
+
+clientSecret(String) EndpointOAuthGoogle.Builder
+the OAuth app client secret.
+
+clientSecret(String) EndpointOAuthMicrosoft.Builder
+the OAuth app client secret.
+
+clientSecret(String) EndpointOidc.Builder
+The OIDC app's client secret.
+
+clientSecret(Optional<String>) EndpointOAuthFacebook.Builder
+the OAuth app client secret.
+
+clientSecret(Optional<String>) EndpointOAuthGitHub.Builder
+the OAuth app client secret.
+
+clientSecret(Optional<String>) EndpointOAuthGoogle.Builder
+the OAuth app client secret.
+
+clientSecret(Optional<String>) EndpointOAuthMicrosoft.Builder
+the OAuth app client secret.
+
+clientSecret(Optional<String>) EndpointOidc.Builder
+The OIDC app's client secret.
+
+cloudwatchLogs(EventTargetCloudwatchLogs) EventTarget.Builder
+Configuration used to send events to Amazon CloudWatch Logs.
+
+cloudwatchLogs(Optional<EventTargetCloudwatchLogs>) EventTarget.Builder
+Configuration used to send events to Amazon CloudWatch Logs.
+
+com.ngrok - package com.ngrok
+com.ngrok.definitions - package com.ngrok.definitions
+com.ngrok.services - package com.ngrok.services
+compression() Ngrok.PointcfgModuleNamespace
+
+
+compression(EndpointCompression) EndpointConfigurations.CreateCallBuilder
+compression module configuration or null
+
+compression(EndpointCompression) EndpointConfigurations.UpdateCallBuilder
+compression module configuration or null
+
+compression(Optional<EndpointCompression>) EndpointConfigurations.CreateCallBuilder
+compression module configuration or null
+
+compression(Optional<EndpointCompression>) EndpointConfigurations.UpdateCallBuilder
+compression module configuration or null
+
+cookiePrefix(String) EndpointOAuth.Builder
+the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+cookiePrefix(String) EndpointOidc.Builder
+the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+cookiePrefix(String) EndpointSamlMutate.Builder
+the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+cookiePrefix(Optional<String>) EndpointOAuth.Builder
+the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+cookiePrefix(Optional<String>) EndpointOidc.Builder
+the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+cookiePrefix(Optional<String>) EndpointSamlMutate.Builder
+the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+create() ApiKeys
+Create a new API key.
+
+create() Credentials
+Create a new tunnel authtoken credential.
+
+create() EndpointConfigurations
+
+
+create() EventDestinations
+Create a new Event Destination.
+
+create() EventStreams
+Create a new Event Stream.
+
+create() EventSubscriptions
+Create an Event Subscription.
+
+create() ReservedAddrs
+Create a new reserved address.
+
+create() SshCertificateAuthorities
+
+
+create(String) AgentIngresses
+Create a new Agent Ingress.
+
+create(String) CertificateAuthorities
+
+
+create(String) EventSources
+
+
+create(String) IpPolicies
+Create a new IP policy.
+
+create(String) ReservedDomains
+Create a new reserved domain.
+
+create(String) SshCredentials
+Create a new ssh_credential from an uploaded public SSH key.
+
+create(String, String) IpPolicyRules
+Create a new IP policy rule attached to an IP Policy.
+
+create(String, String) SshHostCertificates
+
+
+create(String, String) SshUserCertificates
+
+
+create(String, String) TlsCertificates
+
+
+create(String, List<String>) IpRestrictions
+
+
+create(List<URI>) AbuseReports
+Creates a new abuse report which will be reviewed by our system and abuse
+ response team.
+
+createDefault() Ngrok
+Creates a new ngrok API instance using the default API client.
+
+createDefault(String) Ngrok
+Creates a new ngrok API instance using the default API client.
+
+Credential com.ngrok.definitions
+
+
+Credential(String, URI, OffsetDateTime, String, String, Optional<String>, List<String>) Credential
+
+
+CredentialList com.ngrok.definitions
+
+
+CredentialList(List<Credential>, URI, Optional<URI>) CredentialList
+
+
+credentials() Ngrok
+Tunnel Credentials are ngrok agent authtokens.
+
+Credentials com.ngrok.services
+Tunnel Credentials are ngrok agent authtokens.
+
+Credentials(NgrokApiClient) Credentials
+Creates a new sub-client for Credentials.
+
+Credentials.CreateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Create API call.
+
+Credentials.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+Credentials.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+Credentials.ListCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent List API call.
+
+Credentials.UpdateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Update API call.
+
+creds(AwsCredentials) AwsAuth.Builder
+Credentials to your AWS account if you prefer ngrok to sign in with long-term
+ access keys.
+
+creds(Optional<AwsCredentials>) AwsAuth.Builder
+Credentials to your AWS account if you prefer ngrok to sign in with long-term
+ access keys.
+
+criticalOptions(Map<String, String>) SshUserCertificates.CreateCallBuilder
+A map of critical options included in the certificate.
+
+criticalOptions(Optional<Map<String, String>>) SshUserCertificates.CreateCallBuilder
+A map of critical options included in the certificate.
+
+
+D
+
+DEFAULT_BASE_URI NgrokApiClient
+The default base URI for the public ngrok API server
+
+DefaultNgrokApiClient com.ngrok
+Default implementation of
NgrokApiClient based on the Armeria HTTP client.
+DefaultNgrokApiClient.Builder com.ngrok
+Builder class for the default API client.
+
+delete(String) AgentIngresses
+
+
+delete(String) ApiKeys
+
+
+delete(String) CertificateAuthorities
+
+
+delete(String) Credentials
+
+
+delete(String) EndpointCircuitBreakerModule
+Creates a call builder for the Delete API operation.
+
+delete(String) EndpointCompressionModule
+Creates a call builder for the Delete API operation.
+
+delete(String) EndpointConfigurations
+Delete an endpoint configuration.
+
+delete(String) EndpointIpPolicyModule
+Creates a call builder for the Delete API operation.
+
+delete(String) EndpointLoggingModule
+Creates a call builder for the Delete API operation.
+
+delete(String) EndpointMutualTlsModule
+Creates a call builder for the Delete API operation.
+
+delete(String) EndpointOAuthModule
+Creates a call builder for the Delete API operation.
+
+delete(String) EndpointOidcModule
+Creates a call builder for the Delete API operation.
+
+delete(String) EndpointRequestHeadersModule
+Creates a call builder for the Delete API operation.
+
+delete(String) EndpointResponseHeadersModule
+Creates a call builder for the Delete API operation.
+
+delete(String) EndpointSamlModule
+Creates a call builder for the Delete API operation.
+
+delete(String) EndpointTlsTerminationModule
+Creates a call builder for the Delete API operation.
+
+delete(String) EndpointWebhookValidationModule
+Creates a call builder for the Delete API operation.
+
+delete(String) EventDestinations
+Delete an Event Destination.
+
+delete(String) EventStreams
+Delete an Event Stream.
+
+delete(String) EventSubscriptions
+Delete an Event Subscription.
+
+delete(String) IpPolicies
+Delete an IP policy.
+
+delete(String) IpPolicyRules
+Delete an IP policy rule.
+
+delete(String) IpRestrictions
+
+
+delete(String) ReservedAddrs
+Delete a reserved address.
+
+delete(String) ReservedDomains
+Delete a reserved domain.
+
+delete(String) SshCertificateAuthorities
+
+
+delete(String) SshCredentials
+
+
+delete(String) SshHostCertificates
+
+
+delete(String) SshUserCertificates
+
+
+delete(String) TlsCertificates
+
+
+delete(String, String) EventSources
+
+
+DELETE NgrokApiClient.HttpMethod
+HTTP DELETE
+
+deleteCertificate(String) ReservedDomains
+Detach the certificate attached to a reserved domain.
+
+deleteCertificateManagementPolicy(String) ReservedDomains
+Detach the certificate management policy attached to a reserved domain.
+
+deleteEndpointConfig(String) ReservedAddrs
+Detach the endpoint configuration attached to a reserved address.
+
+deleteHttpEndpointConfig(String) ReservedDomains
+Detach the http endpoint configuration attached to a reserved domain.
+
+deleteHttpsEndpointConfig(String) ReservedDomains
+Detach the https endpoint configuration attached to a reserved domain.
+
+deliveryStreamArn(String) EventTargetFirehose.Builder
+An Amazon Resource Name specifying the Firehose delivery stream to deposit
+ events into.
+
+deliveryStreamArn(Optional<String>) EventTargetFirehose.Builder
+An Amazon Resource Name specifying the Firehose delivery stream to deposit
+ events into.
+
+description(String) AgentIngresses.CreateCallBuilder
+human-readable description of the use of this Agent Ingress.
+
+description(String) AgentIngresses.UpdateCallBuilder
+human-readable description of the use of this Agent Ingress.
+
+description(String) ApiKeys.CreateCallBuilder
+human-readable description of what uses the API key to authenticate.
+
+description(String) ApiKeys.UpdateCallBuilder
+human-readable description of what uses the API key to authenticate.
+
+description(String) CertificateAuthorities.CreateCallBuilder
+human-readable description of this Certificate Authority.
+
+description(String) CertificateAuthorities.UpdateCallBuilder
+human-readable description of this Certificate Authority.
+
+description(String) Credentials.CreateCallBuilder
+human-readable description of who or what will use the credential to
+ authenticate.
+
+description(String) Credentials.UpdateCallBuilder
+human-readable description of who or what will use the credential to
+ authenticate.
+
+description(String) EndpointConfigurations.CreateCallBuilder
+human-readable description of what this endpoint configuration will be do when
+ applied or what traffic it will be applied to.
+
+description(String) EndpointConfigurations.UpdateCallBuilder
+human-readable description of what this endpoint configuration will be do when
+ applied or what traffic it will be applied to.
+
+description(String) EventDestinations.CreateCallBuilder
+Human-readable description of the Event Destination.
+
+description(String) EventDestinations.UpdateCallBuilder
+Human-readable description of the Event Destination.
+
+description(String) EventStreams.CreateCallBuilder
+Human-readable description of the Event Stream.
+
+description(String) EventStreams.UpdateCallBuilder
+Human-readable description of the Event Stream.
+
+description(String) EventSubscriptions.CreateCallBuilder
+Arbitrary customer supplied information intended to be human readable.
+
+description(String) EventSubscriptions.UpdateCallBuilder
+Arbitrary customer supplied information intended to be human readable.
+
+description(String) IpPolicies.CreateCallBuilder
+human-readable description of the source IPs of this IP policy.
+
+description(String) IpPolicies.UpdateCallBuilder
+human-readable description of the source IPs of this IP policy.
+
+description(String) IpPolicyRules.CreateCallBuilder
+human-readable description of the source IPs of this IP rule.
+
+description(String) IpPolicyRules.UpdateCallBuilder
+human-readable description of the source IPs of this IP rule.
+
+description(String) IpRestrictions.CreateCallBuilder
+human-readable description of this IP restriction.
+
+description(String) IpRestrictions.UpdateCallBuilder
+human-readable description of this IP restriction.
+
+description(String) ReservedAddrs.CreateCallBuilder
+human-readable description of what this reserved address will be used for
+
+description(String) ReservedAddrs.UpdateCallBuilder
+human-readable description of what this reserved address will be used for
+
+description(String) ReservedDomains.CreateCallBuilder
+human-readable description of what this reserved domain will be used for
+
+description(String) ReservedDomains.UpdateCallBuilder
+human-readable description of what this reserved domain will be used for
+
+description(String) SshCertificateAuthorities.CreateCallBuilder
+human-readable description of this SSH Certificate Authority.
+
+description(String) SshCertificateAuthorities.UpdateCallBuilder
+human-readable description of this SSH Certificate Authority.
+
+description(String) SshCredentials.CreateCallBuilder
+human-readable description of who or what will use the ssh credential to
+ authenticate.
+
+description(String) SshCredentials.UpdateCallBuilder
+human-readable description of who or what will use the ssh credential to
+ authenticate.
+
+description(String) SshHostCertificates.CreateCallBuilder
+human-readable description of this SSH Host Certificate.
+
+description(String) SshHostCertificates.UpdateCallBuilder
+human-readable description of this SSH Host Certificate.
+
+description(String) SshUserCertificates.CreateCallBuilder
+human-readable description of this SSH User Certificate.
+
+description(String) SshUserCertificates.UpdateCallBuilder
+human-readable description of this SSH User Certificate.
+
+description(String) TlsCertificates.CreateCallBuilder
+human-readable description of this TLS certificate.
+
+description(String) TlsCertificates.UpdateCallBuilder
+human-readable description of this TLS certificate.
+
+description(Optional<String>) AgentIngresses.CreateCallBuilder
+human-readable description of the use of this Agent Ingress.
+
+description(Optional<String>) AgentIngresses.UpdateCallBuilder
+human-readable description of the use of this Agent Ingress.
+
+description(Optional<String>) ApiKeys.CreateCallBuilder
+human-readable description of what uses the API key to authenticate.
+
+description(Optional<String>) ApiKeys.UpdateCallBuilder
+human-readable description of what uses the API key to authenticate.
+
+description(Optional<String>) CertificateAuthorities.CreateCallBuilder
+human-readable description of this Certificate Authority.
+
+description(Optional<String>) CertificateAuthorities.UpdateCallBuilder
+human-readable description of this Certificate Authority.
+
+description(Optional<String>) Credentials.CreateCallBuilder
+human-readable description of who or what will use the credential to
+ authenticate.
+
+description(Optional<String>) Credentials.UpdateCallBuilder
+human-readable description of who or what will use the credential to
+ authenticate.
+
+description(Optional<String>) EndpointConfigurations.CreateCallBuilder
+human-readable description of what this endpoint configuration will be do when
+ applied or what traffic it will be applied to.
+
+description(Optional<String>) EndpointConfigurations.UpdateCallBuilder
+human-readable description of what this endpoint configuration will be do when
+ applied or what traffic it will be applied to.
+
+description(Optional<String>) EventDestinations.CreateCallBuilder
+Human-readable description of the Event Destination.
+
+description(Optional<String>) EventDestinations.UpdateCallBuilder
+Human-readable description of the Event Destination.
+
+description(Optional<String>) EventStreams.CreateCallBuilder
+Human-readable description of the Event Stream.
+
+description(Optional<String>) EventStreams.UpdateCallBuilder
+Human-readable description of the Event Stream.
+
+description(Optional<String>) EventSubscriptions.CreateCallBuilder
+Arbitrary customer supplied information intended to be human readable.
+
+description(Optional<String>) EventSubscriptions.UpdateCallBuilder
+Arbitrary customer supplied information intended to be human readable.
+
+description(Optional<String>) IpPolicies.CreateCallBuilder
+human-readable description of the source IPs of this IP policy.
+
+description(Optional<String>) IpPolicies.UpdateCallBuilder
+human-readable description of the source IPs of this IP policy.
+
+description(Optional<String>) IpPolicyRules.CreateCallBuilder
+human-readable description of the source IPs of this IP rule.
+
+description(Optional<String>) IpPolicyRules.UpdateCallBuilder
+human-readable description of the source IPs of this IP rule.
+
+description(Optional<String>) IpRestrictions.CreateCallBuilder
+human-readable description of this IP restriction.
+
+description(Optional<String>) IpRestrictions.UpdateCallBuilder
+human-readable description of this IP restriction.
+
+description(Optional<String>) ReservedAddrs.CreateCallBuilder
+human-readable description of what this reserved address will be used for
+
+description(Optional<String>) ReservedAddrs.UpdateCallBuilder
+human-readable description of what this reserved address will be used for
+
+description(Optional<String>) ReservedDomains.CreateCallBuilder
+human-readable description of what this reserved domain will be used for
+
+description(Optional<String>) ReservedDomains.UpdateCallBuilder
+human-readable description of what this reserved domain will be used for
+
+description(Optional<String>) SshCertificateAuthorities.CreateCallBuilder
+human-readable description of this SSH Certificate Authority.
+
+description(Optional<String>) SshCertificateAuthorities.UpdateCallBuilder
+human-readable description of this SSH Certificate Authority.
+
+description(Optional<String>) SshCredentials.CreateCallBuilder
+human-readable description of who or what will use the ssh credential to
+ authenticate.
+
+description(Optional<String>) SshCredentials.UpdateCallBuilder
+human-readable description of who or what will use the ssh credential to
+ authenticate.
+
+description(Optional<String>) SshHostCertificates.CreateCallBuilder
+human-readable description of this SSH Host Certificate.
+
+description(Optional<String>) SshHostCertificates.UpdateCallBuilder
+human-readable description of this SSH Host Certificate.
+
+description(Optional<String>) SshUserCertificates.CreateCallBuilder
+human-readable description of this SSH User Certificate.
+
+description(Optional<String>) SshUserCertificates.UpdateCallBuilder
+human-readable description of this SSH User Certificate.
+
+description(Optional<String>) TlsCertificates.CreateCallBuilder
+human-readable description of this TLS certificate.
+
+description(Optional<String>) TlsCertificates.UpdateCallBuilder
+human-readable description of this TLS certificate.
+
+destinationIds(List<String>) EventStreams.CreateCallBuilder
+A list of Event Destination IDs which should be used for this Event Stream.
+
+destinationIds(List<String>) EventStreams.UpdateCallBuilder
+A list of Event Destination IDs which should be used for this Event Stream.
+
+destinationIds(List<String>) EventSubscriptions.CreateCallBuilder
+A list of Event Destination IDs which should be used for this Event Stream.
+
+destinationIds(List<String>) EventSubscriptions.UpdateCallBuilder
+A list of Event Destination IDs which should be used for this Event Stream.
+
+destinationIds(Optional<List<String>>) EventStreams.CreateCallBuilder
+A list of Event Destination IDs which should be used for this Event Stream.
+
+destinationIds(Optional<List<String>>) EventStreams.UpdateCallBuilder
+A list of Event Destination IDs which should be used for this Event Stream.
+
+destinationIds(Optional<List<String>>) EventSubscriptions.CreateCallBuilder
+A list of Event Destination IDs which should be used for this Event Stream.
+
+destinationIds(Optional<List<String>>) EventSubscriptions.UpdateCallBuilder
+A list of Event Destination IDs which should be used for this Event Stream.
+
+
+E
+
+ellipticCurve(String) SshCertificateAuthorities.CreateCallBuilder
+the type of elliptic curve to use when creating an ECDSA key
+
+ellipticCurve(Optional<String>) SshCertificateAuthorities.CreateCallBuilder
+the type of elliptic curve to use when creating an ECDSA key
+
+emailAddresses(List<String>) EndpointOAuthFacebook.Builder
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+emailAddresses(List<String>) EndpointOAuthGitHub.Builder
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+emailAddresses(List<String>) EndpointOAuthGoogle.Builder
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+emailAddresses(List<String>) EndpointOAuthMicrosoft.Builder
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+emailAddresses(Optional<List<String>>) EndpointOAuthFacebook.Builder
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+emailAddresses(Optional<List<String>>) EndpointOAuthGitHub.Builder
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+emailAddresses(Optional<List<String>>) EndpointOAuthGoogle.Builder
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+emailAddresses(Optional<List<String>>) EndpointOAuthMicrosoft.Builder
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+emailDomains(List<String>) EndpointOAuthFacebook.Builder
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+emailDomains(List<String>) EndpointOAuthGitHub.Builder
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+emailDomains(List<String>) EndpointOAuthGoogle.Builder
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+emailDomains(List<String>) EndpointOAuthMicrosoft.Builder
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+emailDomains(Optional<List<String>>) EndpointOAuthFacebook.Builder
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+emailDomains(Optional<List<String>>) EndpointOAuthGitHub.Builder
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+emailDomains(Optional<List<String>>) EndpointOAuthGoogle.Builder
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+emailDomains(Optional<List<String>>) EndpointOAuthMicrosoft.Builder
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+enabled(boolean) EndpointCircuitBreaker.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(boolean) EndpointCompression.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(boolean) EndpointIpPolicyMutate.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(boolean) EndpointLoggingMutate.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(boolean) EndpointMutualTlsMutate.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(boolean) EndpointOAuth.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(boolean) EndpointOidc.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(boolean) EndpointRequestHeaders.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(boolean) EndpointResponseHeaders.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(boolean) EndpointSamlMutate.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(boolean) EndpointTlsTermination.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(boolean) EndpointWebhookValidation.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(Optional<Boolean>) EndpointCircuitBreaker.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(Optional<Boolean>) EndpointCompression.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(Optional<Boolean>) EndpointIpPolicyMutate.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(Optional<Boolean>) EndpointLoggingMutate.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(Optional<Boolean>) EndpointMutualTlsMutate.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(Optional<Boolean>) EndpointOAuth.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(Optional<Boolean>) EndpointOidc.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(Optional<Boolean>) EndpointRequestHeaders.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(Optional<Boolean>) EndpointResponseHeaders.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(Optional<Boolean>) EndpointSamlMutate.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(Optional<Boolean>) EndpointTlsTermination.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+enabled(Optional<Boolean>) EndpointWebhookValidation.Builder
+true if the module will be applied to traffic, false
+ to disable.
+
+EndpointCircuitBreaker com.ngrok.definitions
+
+
+EndpointCircuitBreaker.Builder com.ngrok.definitions
+
+
+EndpointCircuitBreakerModule com.ngrok.services
+
+
+EndpointCircuitBreakerModule(NgrokApiClient) EndpointCircuitBreakerModule
+Creates a new sub-client for EndpointCircuitBreakerModule.
+
+EndpointCircuitBreakerModule.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+EndpointCircuitBreakerModule.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+EndpointCircuitBreakerModule.ReplaceCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Replace API call.
+
+EndpointCompression com.ngrok.definitions
+
+
+EndpointCompression.Builder com.ngrok.definitions
+
+
+EndpointCompressionModule com.ngrok.services
+
+
+EndpointCompressionModule(NgrokApiClient) EndpointCompressionModule
+Creates a new sub-client for EndpointCompressionModule.
+
+EndpointCompressionModule.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+EndpointCompressionModule.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+EndpointCompressionModule.ReplaceCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Replace API call.
+
+EndpointConfiguration com.ngrok.definitions
+
+
+EndpointConfiguration(String, String, String, String, OffsetDateTime, URI, Optional<EndpointCircuitBreaker>, Optional<EndpointCompression>, Optional<EndpointRequestHeaders>, Optional<EndpointResponseHeaders>, Optional<EndpointIpPolicy>, Optional<EndpointMutualTls>, Optional<EndpointTlsTermination>, Optional<EndpointWebhookValidation>, Optional<EndpointOAuth>, Optional<EndpointLogging>, Optional<EndpointSaml>, Optional<EndpointOidc>) EndpointConfiguration
+
+
+endpointConfigurationId(String) ReservedAddrs.CreateCallBuilder
+ID of an endpoint configuration of type tcp that will be used to handle inbound
+ traffic to this address
+
+endpointConfigurationId(String) ReservedAddrs.UpdateCallBuilder
+ID of an endpoint configuration of type tcp that will be used to handle inbound
+ traffic to this address
+
+endpointConfigurationId(Optional<String>) ReservedAddrs.CreateCallBuilder
+ID of an endpoint configuration of type tcp that will be used to handle inbound
+ traffic to this address
+
+endpointConfigurationId(Optional<String>) ReservedAddrs.UpdateCallBuilder
+ID of an endpoint configuration of type tcp that will be used to handle inbound
+ traffic to this address
+
+EndpointConfigurationList com.ngrok.definitions
+
+
+EndpointConfigurationList(List<EndpointConfiguration>, URI, Optional<URI>) EndpointConfigurationList
+
+
+endpointConfigurations() Ngrok
+Endpoint Configurations are a reusable group of modules that encapsulate how
+ traffic to a domain or address is handled.
+
+EndpointConfigurations com.ngrok.services
+Endpoint Configurations are a reusable group of modules that encapsulate how
+ traffic to a domain or address is handled.
+
+EndpointConfigurations(NgrokApiClient) EndpointConfigurations
+Creates a new sub-client for EndpointConfigurations.
+
+EndpointConfigurations.CreateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Create API call.
+
+EndpointConfigurations.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+EndpointConfigurations.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+EndpointConfigurations.ListCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent List API call.
+
+EndpointConfigurations.UpdateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Update API call.
+
+EndpointIpPolicy com.ngrok.definitions
+
+
+EndpointIpPolicy(Optional<Boolean>, List<Ref>) EndpointIpPolicy
+
+
+EndpointIpPolicyModule com.ngrok.services
+
+
+EndpointIpPolicyModule(NgrokApiClient) EndpointIpPolicyModule
+Creates a new sub-client for EndpointIpPolicyModule.
+
+EndpointIpPolicyModule.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+EndpointIpPolicyModule.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+EndpointIpPolicyModule.ReplaceCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Replace API call.
+
+EndpointIpPolicyMutate com.ngrok.definitions
+
+
+EndpointIpPolicyMutate.Builder com.ngrok.definitions
+
+
+EndpointLogging com.ngrok.definitions
+
+
+EndpointLogging(Optional<Boolean>, List<Ref>) EndpointLogging
+
+
+EndpointLoggingModule com.ngrok.services
+
+
+EndpointLoggingModule(NgrokApiClient) EndpointLoggingModule
+Creates a new sub-client for EndpointLoggingModule.
+
+EndpointLoggingModule.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+EndpointLoggingModule.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+EndpointLoggingModule.ReplaceCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Replace API call.
+
+EndpointLoggingMutate com.ngrok.definitions
+
+
+EndpointLoggingMutate.Builder com.ngrok.definitions
+
+
+EndpointMutualTls com.ngrok.definitions
+
+
+EndpointMutualTls(Optional<Boolean>, List<Ref>) EndpointMutualTls
+
+
+EndpointMutualTlsModule com.ngrok.services
+
+
+EndpointMutualTlsModule(NgrokApiClient) EndpointMutualTlsModule
+Creates a new sub-client for EndpointMutualTlsModule.
+
+EndpointMutualTlsModule.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+EndpointMutualTlsModule.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+EndpointMutualTlsModule.ReplaceCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Replace API call.
+
+EndpointMutualTlsMutate com.ngrok.definitions
+
+
+EndpointMutualTlsMutate.Builder com.ngrok.definitions
+
+
+EndpointOAuth com.ngrok.definitions
+
+
+EndpointOAuth.Builder com.ngrok.definitions
+
+
+EndpointOAuthFacebook com.ngrok.definitions
+
+
+EndpointOAuthFacebook.Builder com.ngrok.definitions
+
+
+EndpointOAuthGitHub com.ngrok.definitions
+
+
+EndpointOAuthGitHub.Builder com.ngrok.definitions
+
+
+EndpointOAuthGoogle com.ngrok.definitions
+
+
+EndpointOAuthGoogle.Builder com.ngrok.definitions
+
+
+EndpointOAuthMicrosoft com.ngrok.definitions
+
+
+EndpointOAuthMicrosoft.Builder com.ngrok.definitions
+
+
+EndpointOAuthModule com.ngrok.services
+
+
+EndpointOAuthModule(NgrokApiClient) EndpointOAuthModule
+Creates a new sub-client for EndpointOAuthModule.
+
+EndpointOAuthModule.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+EndpointOAuthModule.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+EndpointOAuthModule.ReplaceCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Replace API call.
+
+EndpointOAuthProvider com.ngrok.definitions
+
+
+EndpointOAuthProvider.Builder com.ngrok.definitions
+
+
+EndpointOidc com.ngrok.definitions
+
+
+EndpointOidc.Builder com.ngrok.definitions
+
+
+EndpointOidcModule com.ngrok.services
+
+
+EndpointOidcModule(NgrokApiClient) EndpointOidcModule
+Creates a new sub-client for EndpointOidcModule.
+
+EndpointOidcModule.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+EndpointOidcModule.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+EndpointOidcModule.ReplaceCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Replace API call.
+
+EndpointRequestHeaders com.ngrok.definitions
+
+
+EndpointRequestHeaders.Builder com.ngrok.definitions
+
+
+EndpointRequestHeadersModule com.ngrok.services
+
+
+EndpointRequestHeadersModule(NgrokApiClient) EndpointRequestHeadersModule
+Creates a new sub-client for EndpointRequestHeadersModule.
+
+EndpointRequestHeadersModule.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+EndpointRequestHeadersModule.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+EndpointRequestHeadersModule.ReplaceCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Replace API call.
+
+EndpointResponseHeaders com.ngrok.definitions
+
+
+EndpointResponseHeaders.Builder com.ngrok.definitions
+
+
+EndpointResponseHeadersModule com.ngrok.services
+
+
+EndpointResponseHeadersModule(NgrokApiClient) EndpointResponseHeadersModule
+Creates a new sub-client for EndpointResponseHeadersModule.
+
+EndpointResponseHeadersModule.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+EndpointResponseHeadersModule.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+EndpointResponseHeadersModule.ReplaceCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Replace API call.
+
+EndpointSaml com.ngrok.definitions
+
+
+EndpointSaml(Optional<Boolean>, Boolean, String, Long, Duration, String, Boolean, Optional<Boolean>, List<String>, String, URI, URI, String, URI, String) EndpointSaml
+
+
+EndpointSamlModule com.ngrok.services
+
+
+EndpointSamlModule(NgrokApiClient) EndpointSamlModule
+Creates a new sub-client for EndpointSamlModule.
+
+EndpointSamlModule.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+EndpointSamlModule.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+EndpointSamlModule.ReplaceCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Replace API call.
+
+EndpointSamlMutate com.ngrok.definitions
+
+
+EndpointSamlMutate.Builder com.ngrok.definitions
+
+
+EndpointTlsTermination com.ngrok.definitions
+
+
+EndpointTlsTermination.Builder com.ngrok.definitions
+
+
+EndpointTlsTerminationModule com.ngrok.services
+
+
+EndpointTlsTerminationModule(NgrokApiClient) EndpointTlsTerminationModule
+Creates a new sub-client for EndpointTlsTerminationModule.
+
+EndpointTlsTerminationModule.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+EndpointTlsTerminationModule.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+EndpointTlsTerminationModule.ReplaceCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Replace API call.
+
+EndpointWebhookValidation com.ngrok.definitions
+
+
+EndpointWebhookValidation.Builder com.ngrok.definitions
+
+
+EndpointWebhookValidationModule com.ngrok.services
+
+
+EndpointWebhookValidationModule(NgrokApiClient) EndpointWebhookValidationModule
+Creates a new sub-client for EndpointWebhookValidationModule.
+
+EndpointWebhookValidationModule.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+EndpointWebhookValidationModule.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+EndpointWebhookValidationModule.ReplaceCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Replace API call.
+
+enforced(boolean) IpRestrictions.CreateCallBuilder
+true if the IP restriction will be enforced.
+
+enforced(boolean) IpRestrictions.UpdateCallBuilder
+true if the IP restriction will be enforced.
+
+enforced(Optional<Boolean>) IpRestrictions.CreateCallBuilder
+true if the IP restriction will be enforced.
+
+enforced(Optional<Boolean>) IpRestrictions.UpdateCallBuilder
+true if the IP restriction will be enforced.
+
+equals(Object) AbuseReport
+equals(Object) AbuseReportHostname
+equals(Object) AgentIngress
+equals(Object) AgentIngressList
+equals(Object) ApiKey
+equals(Object) ApiKeyList
+equals(Object) AwsAuth
+equals(Object) AwsCredentials
+equals(Object) AwsRole
+equals(Object) CertificateAuthority
+equals(Object) CertificateAuthorityList
+equals(Object) Credential
+equals(Object) CredentialList
+equals(Object) EndpointCircuitBreaker
+equals(Object) EndpointCompression
+equals(Object) EndpointConfiguration
+equals(Object) EndpointConfigurationList
+equals(Object) EndpointIpPolicy
+equals(Object) EndpointIpPolicyMutate
+equals(Object) EndpointLogging
+equals(Object) EndpointLoggingMutate
+equals(Object) EndpointMutualTls
+equals(Object) EndpointMutualTlsMutate
+equals(Object) EndpointOAuth
+equals(Object) EndpointOAuthFacebook
+equals(Object) EndpointOAuthGitHub
+equals(Object) EndpointOAuthGoogle
+equals(Object) EndpointOAuthMicrosoft
+equals(Object) EndpointOAuthProvider
+equals(Object) EndpointOidc
+equals(Object) EndpointRequestHeaders
+equals(Object) EndpointResponseHeaders
+equals(Object) EndpointSaml
+equals(Object) EndpointSamlMutate
+equals(Object) EndpointTlsTermination
+equals(Object) EndpointWebhookValidation
+equals(Object) EventDestination
+equals(Object) EventDestinationList
+equals(Object) EventSource
+equals(Object) EventSourceList
+equals(Object) EventSourceReplace
+equals(Object) EventStream
+equals(Object) EventStreamList
+equals(Object) EventSubscription
+equals(Object) EventSubscriptionList
+equals(Object) EventTarget
+equals(Object) EventTargetCloudwatchLogs
+equals(Object) EventTargetFirehose
+equals(Object) EventTargetKinesis
+equals(Object) IpPolicy
+equals(Object) IpPolicyList
+equals(Object) IpPolicyRule
+equals(Object) IpPolicyRuleList
+equals(Object) IpRestriction
+equals(Object) IpRestrictionList
+equals(Object) Ref
+equals(Object) ReservedAddr
+equals(Object) ReservedAddrList
+equals(Object) ReservedDomain
+equals(Object) ReservedDomainCertJob
+equals(Object) ReservedDomainCertPolicy
+equals(Object) ReservedDomainCertStatus
+equals(Object) ReservedDomainList
+equals(Object) SshCertificateAuthority
+equals(Object) SshCertificateAuthorityList
+equals(Object) SshCredential
+equals(Object) SshCredentialList
+equals(Object) SshHostCertificate
+equals(Object) SshHostCertificateList
+equals(Object) SshUserCertificate
+equals(Object) SshUserCertificateList
+equals(Object) TlsCertificate
+equals(Object) TlsCertificateList
+equals(Object) TlsCertificateSaNs
+equals(Object) Tunnel
+equals(Object) TunnelList
+equals(Object) TunnelSession
+equals(Object) TunnelSessionList
+errorThresholdPercentage(double) EndpointCircuitBreaker.Builder
+Error threshold percentage should be between 0 - 1.0, not 0-100.0
+
+errorThresholdPercentage(Optional<Double>) EndpointCircuitBreaker.Builder
+Error threshold percentage should be between 0 - 1.0, not 0-100.0
+
+EventDestination com.ngrok.definitions
+
+
+EventDestination(String, String, OffsetDateTime, String, String, EventTarget, URI) EventDestination
+
+
+EventDestinationList com.ngrok.definitions
+
+
+EventDestinationList(List<EventDestination>, URI, Optional<URI>) EventDestinationList
+
+
+eventDestinations() Ngrok
+Creates a service client for EventDestinations.
+
+EventDestinations com.ngrok.services
+
+
+EventDestinations(NgrokApiClient) EventDestinations
+Creates a new sub-client for EventDestinations.
+
+EventDestinations.CreateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Create API call.
+
+EventDestinations.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+EventDestinations.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+EventDestinations.ListCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent List API call.
+
+EventDestinations.UpdateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Update API call.
+
+EventSource com.ngrok.definitions
+
+
+EventSource(String, URI) EventSource
+
+
+EventSourceList com.ngrok.definitions
+
+
+EventSourceList(List<EventSource>, URI) EventSourceList
+
+
+EventSourceReplace com.ngrok.definitions
+
+
+EventSourceReplace.Builder com.ngrok.definitions
+
+
+eventSources() Ngrok
+Creates a service client for EventSources.
+
+EventSources com.ngrok.services
+
+
+EventSources(NgrokApiClient) EventSources
+Creates a new sub-client for EventSources.
+
+EventSources.CreateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Create API call.
+
+EventSources.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+EventSources.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+EventSources.ListCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent List API call.
+
+EventSources.UpdateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Update API call.
+
+EventStream com.ngrok.definitions
+
+
+EventStream(String, URI, OffsetDateTime, String, String, List<String>, String, List<String>, Double) EventStream
+
+
+eventStreamIds(List<String>) EndpointLoggingMutate.Builder
+list of all EventStreams that will be used to configure and export this
+ endpoint's logs
+
+eventStreamIds(Optional<List<String>>) EndpointLoggingMutate.Builder
+list of all EventStreams that will be used to configure and export this
+ endpoint's logs
+
+EventStreamList com.ngrok.definitions
+
+
+EventStreamList(List<EventStream>, URI, Optional<URI>) EventStreamList
+
+
+eventStreams() Ngrok
+Creates a service client for EventStreams.
+
+EventStreams com.ngrok.services
+
+
+EventStreams(NgrokApiClient) EventStreams
+Creates a new sub-client for EventStreams.
+
+EventStreams.CreateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Create API call.
+
+EventStreams.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+EventStreams.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+EventStreams.ListCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent List API call.
+
+EventStreams.UpdateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Update API call.
+
+EventSubscription com.ngrok.definitions
+
+
+EventSubscription(String, URI, OffsetDateTime, String, String, List<EventSource>, List<Ref>) EventSubscription
+
+
+EventSubscriptionList com.ngrok.definitions
+
+
+EventSubscriptionList(List<EventSubscription>, URI, Optional<URI>) EventSubscriptionList
+
+
+eventSubscriptions() Ngrok
+Creates a service client for EventSubscriptions.
+
+EventSubscriptions com.ngrok.services
+
+
+EventSubscriptions(NgrokApiClient) EventSubscriptions
+Creates a new sub-client for EventSubscriptions.
+
+EventSubscriptions.CreateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Create API call.
+
+EventSubscriptions.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+EventSubscriptions.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+EventSubscriptions.ListCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent List API call.
+
+EventSubscriptions.UpdateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Update API call.
+
+EventTarget com.ngrok.definitions
+
+
+EventTarget.Builder com.ngrok.definitions
+
+
+EventTargetCloudwatchLogs com.ngrok.definitions
+
+
+EventTargetCloudwatchLogs.Builder com.ngrok.definitions
+
+
+EventTargetFirehose com.ngrok.definitions
+
+
+EventTargetFirehose.Builder com.ngrok.definitions
+
+
+EventTargetKinesis com.ngrok.definitions
+
+
+EventTargetKinesis.Builder com.ngrok.definitions
+
+
+eventType(String) EventStreams.CreateCallBuilder
+The protocol that determines which events will be collected.
+
+eventType(Optional<String>) EventStreams.CreateCallBuilder
+The protocol that determines which events will be collected.
+
+extensions(Map<String, String>) SshUserCertificates.CreateCallBuilder
+A map of extensions included in the certificate.
+
+extensions(Optional<Map<String, String>>) SshUserCertificates.CreateCallBuilder
+A map of extensions included in the certificate.
+
+
+F
+
+facebook(EndpointOAuthFacebook) EndpointOAuthProvider.Builder
+configuration for using facebook as the identity provider
+
+facebook(Optional<EndpointOAuthFacebook>) EndpointOAuthProvider.Builder
+configuration for using facebook as the identity provider
+
+fields(List<String>) EventStreams.CreateCallBuilder
+A list of protocol-specific fields you want to collect on each event.
+
+fields(List<String>) EventStreams.UpdateCallBuilder
+A list of protocol-specific fields you want to collect on each event.
+
+fields(Optional<List<String>>) EventStreams.CreateCallBuilder
+A list of protocol-specific fields you want to collect on each event.
+
+fields(Optional<List<String>>) EventStreams.UpdateCallBuilder
+A list of protocol-specific fields you want to collect on each event.
+
+firehose(EventTargetFirehose) EventTarget.Builder
+Configuration used to send events to Amazon Kinesis Data Firehose.
+
+firehose(Optional<EventTargetFirehose>) EventTarget.Builder
+Configuration used to send events to Amazon Kinesis Data Firehose.
+
+forceAuthn(boolean) EndpointSamlMutate.Builder
+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.
+
+forceAuthn(Optional<Boolean>) EndpointSamlMutate.Builder
+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.
+
+format(String) EventDestinations.CreateCallBuilder
+The output format you would like to serialize events into when sending to their
+ target.
+
+format(String) EventDestinations.UpdateCallBuilder
+The output format you would like to serialize events into when sending to their
+ target.
+
+format(Optional<String>) EventDestinations.CreateCallBuilder
+The output format you would like to serialize events into when sending to their
+ target.
+
+format(Optional<String>) EventDestinations.UpdateCallBuilder
+The output format you would like to serialize events into when sending to their
+ target.
+
+
+G
+
+get(String) AbuseReports
+Get the detailed status of abuse report by ID.
+
+get(String) AgentIngresses
+Get the details of an Agent Ingress by ID.
+
+get(String) ApiKeys
+Get the details of an API key by ID.
+
+get(String) CertificateAuthorities
+
+
+get(String) Credentials
+
+
+get(String) EndpointCircuitBreakerModule
+Creates a call builder for the Get API operation.
+
+get(String) EndpointCompressionModule
+Creates a call builder for the Get API operation.
+
+get(String) EndpointConfigurations
+
+
+get(String) EndpointIpPolicyModule
+Creates a call builder for the Get API operation.
+
+get(String) EndpointLoggingModule
+Creates a call builder for the Get API operation.
+
+get(String) EndpointMutualTlsModule
+Creates a call builder for the Get API operation.
+
+get(String) EndpointOAuthModule
+Creates a call builder for the Get API operation.
+
+get(String) EndpointOidcModule
+Creates a call builder for the Get API operation.
+
+get(String) EndpointRequestHeadersModule
+Creates a call builder for the Get API operation.
+
+get(String) EndpointResponseHeadersModule
+Creates a call builder for the Get API operation.
+
+get(String) EndpointSamlModule
+Creates a call builder for the Get API operation.
+
+get(String) EndpointTlsTerminationModule
+Creates a call builder for the Get API operation.
+
+get(String) EndpointWebhookValidationModule
+Creates a call builder for the Get API operation.
+
+get(String) EventDestinations
+Get detailed information about an Event Destination by ID.
+
+get(String) EventStreams
+Get detailed information about an Event Stream by ID.
+
+get(String) EventSubscriptions
+Get an Event Subscription by ID.
+
+get(String) IpPolicies
+Get detailed information about an IP policy by ID.
+
+get(String) IpPolicyRules
+Get detailed information about an IP policy rule by ID.
+
+get(String) IpRestrictions
+
+
+get(String) ReservedAddrs
+Get the details of a reserved address.
+
+get(String) ReservedDomains
+Get the details of a reserved domain.
+
+get(String) SshCertificateAuthorities
+
+
+get(String) SshCredentials
+
+
+get(String) SshHostCertificates
+
+
+get(String) SshUserCertificates
+
+
+get(String) TlsCertificates
+
+
+get(String) TunnelSessions
+
+
+get(String, String) EventSources
+
+
+GET NgrokApiClient.HttpMethod
+HTTP GET
+
+getAcl() Credential
+optional list of ACL rules.
+
+getAcl() SshCredential
+optional list of ACL rules.
+
+getAcmeChallengeCnameTarget() ReservedDomain
+DNS CNAME target for the host _acme-challenge.example.com, where example.com is
+ your reserved domain name.
+
+getAction() IpPolicy
+the IP policy action.
+
+getAdd() EndpointRequestHeaders
+a map of header key to header value that will be injected into the HTTP Request
+ before being sent to the upstream application server
+
+getAdd() EndpointResponseHeaders
+a map of header key to header value that will be injected into the HTTP Response
+ returned to the HTTP client
+
+getAddr() ReservedAddr
+hostname:port of the reserved address that was assigned at creation time
+
+getAgentVersion() TunnelSession
+version of the ngrok agent that started this ngrok tunnel session
+
+getAllowIdpInitiated() EndpointSaml
+If true, the IdP may initiate a login directly (e.g.
+
+getAllowIdpInitiated() EndpointSamlMutate
+If true, the IdP may initiate a login directly (e.g.
+
+getAssertionConsumerServiceUrl() EndpointSaml
+The public URL of the SP's Assertion Consumer Service.
+
+getAuth() EventTargetCloudwatchLogs
+Configuration for how to authenticate into your AWS account.
+
+getAuth() EventTargetFirehose
+Configuration for how to authenticate into your AWS account.
+
+getAuth() EventTargetKinesis
+Configuration for how to authenticate into your AWS account.
+
+getAuthCheckInterval() EndpointOAuth
+Integer number of seconds after which ngrok guarantees it will refresh user
+ state from the identity provider and recheck whether the user is still
+ authorized to access the endpoint.
+
+getAuthority() ReservedDomainCertPolicy
+certificate authority to request certificates from.
+
+getAuthorizedGroups() EndpointSaml
+If present, only users who are a member of one of the listed groups may access
+ the target endpoint.
+
+getAuthorizedGroups() EndpointSamlMutate
+If present, only users who are a member of one of the listed groups may access
+ the target endpoint.
+
+getAwsAccessKeyId() AwsCredentials
+The ID portion of an AWS access key.
+
+getAwsSecretAccessKey() AwsCredentials
+The secret portion of an AWS access key.
+
+getCaPem() CertificateAuthority
+raw PEM of the Certificate Authority
+
+getCertificate() ReservedDomain
+object referencing the TLS certificate used for connections to this domain.
+
+getCertificate() SshHostCertificate
+the signed SSH certificate in OpenSSH Authorized Keys format.
+
+getCertificate() SshUserCertificate
+the signed SSH certificate in OpenSSH Authorized Keys Format.
+
+getCertificateAuthorities() CertificateAuthorityList
+the list of all certificate authorities on this account
+
+getCertificateAuthorities() EndpointMutualTls
+PEM-encoded CA certificates that will be used to validate.
+
+getCertificateAuthorityIds() EndpointMutualTlsMutate
+list of certificate authorities that will be used to validate the TLS client
+ certificate presnted by the initiatiator of the TLS connection
+
+getCertificateManagementPolicy() ReservedDomain
+configuration for automatic management of TLS certificates for this domain, or
+ null if automatic management is disabled
+
+getCertificateManagementStatus() ReservedDomain
+status of the automatic certificate management for this domain, or null if
+ automatic management is disabled
+
+getCertificatePem() TlsCertificate
+chain of PEM-encoded certificates, leaf first.
+
+getCidr() IpPolicyRule
+an IP or IP range specified in CIDR notation.
+
+getCircuitBreaker() EndpointConfiguration
+circuit breaker module configuration or null
+
+getClientId() EndpointOAuthFacebook
+the OAuth app client ID.
+
+getClientId() EndpointOAuthGitHub
+the OAuth app client ID.
+
+getClientId() EndpointOAuthGoogle
+the OAuth app client ID.
+
+getClientId() EndpointOAuthMicrosoft
+the OAuth app client ID.
+
+getClientId() EndpointOidc
+The OIDC app's client ID and OIDC audience.
+
+getClientSecret() EndpointOAuthFacebook
+the OAuth app client secret.
+
+getClientSecret() EndpointOAuthGitHub
+the OAuth app client secret.
+
+getClientSecret() EndpointOAuthGoogle
+the OAuth app client secret.
+
+getClientSecret() EndpointOAuthMicrosoft
+the OAuth app client secret.
+
+getClientSecret() EndpointOidc
+The OIDC app's client secret.
+
+getCloudwatchLogs() EventTarget
+Configuration used to send events to Amazon CloudWatch Logs.
+
+getCnameTarget() ReservedDomain
+DNS CNAME target for a custom hostname, or null if the reserved domain is a
+ subdomain of *.ngrok.io
+
+getCompression() EndpointConfiguration
+compression module configuration or null
+
+getCookiePrefix() EndpointOAuth
+the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+getCookiePrefix() EndpointOidc
+the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+getCookiePrefix() EndpointSaml
+the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+getCookiePrefix() EndpointSamlMutate
+the prefix of the session cookie that ngrok sets on the http client to cache
+ authentication.
+
+getCreatedAt() AbuseReport
+timestamp that the abuse report record was created in RFC 3339 format
+
+getCreatedAt() AgentIngress
+timestamp when the Agent Ingress was created, RFC 3339 format
+
+getCreatedAt() ApiKey
+timestamp when the api key was created, RFC 3339 format
+
+getCreatedAt() CertificateAuthority
+timestamp when the Certificate Authority was created, RFC 3339 format
+
+getCreatedAt() Credential
+timestamp when the tunnel credential was created, RFC 3339 format
+
+getCreatedAt() EndpointConfiguration
+timestamp when the endpoint configuration was created, RFC 3339 format
+
+getCreatedAt() EventDestination
+Timestamp when the Event Destination was created, RFC 3339 format.
+
+getCreatedAt() EventStream
+Timestamp when the Event Stream was created, RFC 3339 format.
+
+getCreatedAt() EventSubscription
+When the Event Subscription was created (RFC 3339 format).
+
+getCreatedAt() IpPolicy
+timestamp when the IP policy was created, RFC 3339 format
+
+getCreatedAt() IpPolicyRule
+timestamp when the IP policy rule was created, RFC 3339 format
+
+getCreatedAt() IpRestriction
+timestamp when the IP restriction was created, RFC 3339 format
+
+getCreatedAt() ReservedAddr
+timestamp when the reserved address was created, RFC 3339 format
+
+getCreatedAt() ReservedDomain
+timestamp when the reserved domain was created, RFC 3339 format
+
+getCreatedAt() SshCertificateAuthority
+timestamp when the SSH Certificate Authority API resource was created, RFC 3339
+ format
+
+getCreatedAt() SshCredential
+timestamp when the ssh credential was created, RFC 3339 format
+
+getCreatedAt() SshHostCertificate
+timestamp when the SSH Host Certificate API resource was created, RFC 3339
+ format
+
+getCreatedAt() SshUserCertificate
+timestamp when the SSH User Certificate API resource was created, RFC 3339
+ format
+
+getCreatedAt() TlsCertificate
+timestamp when the TLS certificate was created, RFC 3339 format
+
+getCredential() TunnelSession
+reference to the tunnel credential or ssh credential used by the ngrok agent to
+ start this tunnel session
+
+getCredentials() CredentialList
+the list of all tunnel credentials on this account
+
+getCreds() AwsAuth
+Credentials to your AWS account if you prefer ngrok to sign in with long-term
+ access keys.
+
+getCriticalOptions() SshUserCertificate
+A map of critical options included in the certificate.
+
+getDeliveryStreamArn() EventTargetFirehose
+An Amazon Resource Name specifying the Firehose delivery stream to deposit
+ events into.
+
+getDescription() AgentIngress
+human-readable description of the use of this Agent Ingress.
+
+getDescription() ApiKey
+human-readable description of what uses the API key to authenticate.
+
+getDescription() CertificateAuthority
+human-readable description of this Certificate Authority.
+
+getDescription() Credential
+human-readable description of who or what will use the credential to
+ authenticate.
+
+getDescription() EndpointConfiguration
+human-readable description of what this endpoint configuration will be do when
+ applied or what traffic it will be applied to.
+
+getDescription() EventDestination
+Human-readable description of the Event Destination.
+
+getDescription() EventStream
+Human-readable description of the Event Stream.
+
+getDescription() EventSubscription
+Arbitrary customer supplied information intended to be human readable.
+
+getDescription() IpPolicy
+human-readable description of the source IPs of this IP policy.
+
+getDescription() IpPolicyRule
+human-readable description of the source IPs of this IP rule.
+
+getDescription() IpRestriction
+human-readable description of this IP restriction.
+
+getDescription() ReservedAddr
+human-readable description of what this reserved address will be used for
+
+getDescription() ReservedDomain
+human-readable description of what this reserved domain will be used for
+
+getDescription() SshCertificateAuthority
+human-readable description of this SSH Certificate Authority.
+
+getDescription() SshCredential
+human-readable description of who or what will use the ssh credential to
+ authenticate.
+
+getDescription() SshHostCertificate
+human-readable description of this SSH Host Certificate.
+
+getDescription() SshUserCertificate
+human-readable description of this SSH User Certificate.
+
+getDescription() TlsCertificate
+human-readable description of this TLS certificate.
+
+getDestinationIds() EventStream
+A list of Event Destination IDs which should be used for this Event Stream.
+
+getDestinations() EventSubscription
+Destinations to which these events will be sent
+
+getDetails() NgrokApiError
+Fetches any further details about the error.
+
+getDnsNames() TlsCertificateSaNs
+set of additional domains (including wildcards) this TLS certificate is valid
+ for
+
+getDomain() AgentIngress
+the domain that you own to be used as the base domain name to generate regional
+ agent ingress domains.
+
+getDomain() ReservedDomain
+hostname of the reserved domain
+
+getEmailAddresses() EndpointOAuthFacebook
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+getEmailAddresses() EndpointOAuthGitHub
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+getEmailAddresses() EndpointOAuthGoogle
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+getEmailAddresses() EndpointOAuthMicrosoft
+a list of email addresses of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+getEmailDomains() EndpointOAuthFacebook
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+getEmailDomains() EndpointOAuthGitHub
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+getEmailDomains() EndpointOAuthGoogle
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+getEmailDomains() EndpointOAuthMicrosoft
+a list of email domains of users authenticated by identity provider who are
+ allowed access to the endpoint
+
+getEnabled() EndpointCircuitBreaker
+true if the module will be applied to traffic, false
+ to disable.
+
+getEnabled() EndpointCompression
+true if the module will be applied to traffic, false
+ to disable.
+
+getEnabled() EndpointIpPolicy
+true if the module will be applied to traffic, false
+ to disable.
+
+getEnabled() EndpointIpPolicyMutate
+true if the module will be applied to traffic, false
+ to disable.
+
+getEnabled() EndpointLogging
+true if the module will be applied to traffic, false
+ to disable.
+
+getEnabled() EndpointLoggingMutate
+true if the module will be applied to traffic, false
+ to disable.
+
+getEnabled() EndpointMutualTls
+true if the module will be applied to traffic, false
+ to disable.
+
+getEnabled() EndpointMutualTlsMutate
+true if the module will be applied to traffic, false
+ to disable.
+
+getEnabled() EndpointOAuth
+true if the module will be applied to traffic, false
+ to disable.
+
+getEnabled() EndpointOidc
+true if the module will be applied to traffic, false
+ to disable.
+
+getEnabled() EndpointRequestHeaders
+true if the module will be applied to traffic, false
+ to disable.
+
+getEnabled() EndpointResponseHeaders
+true if the module will be applied to traffic, false
+ to disable.
+
+getEnabled() EndpointSaml
+true if the module will be applied to traffic, false
+ to disable.
+
+getEnabled() EndpointSamlMutate
+true if the module will be applied to traffic, false
+ to disable.
+
+getEnabled() EndpointTlsTermination
+true if the module will be applied to traffic, false
+ to disable.
+
+getEnabled() EndpointWebhookValidation
+true if the module will be applied to traffic, false
+ to disable.
+
+getEndpointConfiguration() ReservedAddr
+object reference to the endpoint configuration that will be applied to traffic
+ to this address
+
+getEndpointConfigurations() EndpointConfigurationList
+the list of all endpoint configurations on this account
+
+getEnforced() IpRestriction
+true if the IP restriction will be enforced.
+
+getEntityId() EndpointSaml
+The SP Entity's unique ID.
+
+getErrorCode() NgrokApiError
+Fetches the ngrok API error code, if any.
+
+getErrorCode() ReservedDomainCertJob
+if present, an error code indicating why provisioning is failing.
+
+getErrorThresholdPercentage() EndpointCircuitBreaker
+Error threshold percentage should be between 0 - 1.0, not 0-100.0
+
+getEventDestinations() EventDestinationList
+The list of all Event Destinations on this account.
+
+getEventStreamIds() EndpointLoggingMutate
+list of all EventStreams that will be used to configure and export this
+ endpoint's logs
+
+getEventStreams() EndpointLogging
+list of all EventStreams that will be used to configure and export this
+ endpoint's logs
+
+getEventStreams() EventStreamList
+The list of all Event Streams on this account.
+
+getEventSubscriptions() EventSubscriptionList
+The list of all Event Subscriptions on this account.
+
+getEventType() EventStream
+The protocol that determines which events will be collected.
+
+getExtendedKeyUsages() CertificateAuthority
+extended set of actions the private key of this Certificate Authority can be
+ used for
+
+getExtendedKeyUsages() TlsCertificate
+extended set of actions the private key of this TLS certificate can be used for
+
+getExtensions() SshUserCertificate
+A map of extensions included in the certificate.
+
+getFacebook() EndpointOAuthProvider
+configuration for using facebook as the identity provider
+
+getFields() EventStream
+A list of protocol-specific fields you want to collect on each event.
+
+getFirehose() EventTarget
+Configuration used to send events to Amazon Kinesis Data Firehose.
+
+getForceAuthn() EndpointSaml
+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.
+
+getForceAuthn() EndpointSamlMutate
+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.
+
+getFormat() EventDestination
+The output format you would like to serialize events into when sending to their
+ target.
+
+getGithub() EndpointOAuthProvider
+configuration for using github as the identity provider
+
+getGoogle() EndpointOAuthProvider
+configuration for using google as the identity provider
+
+getHostname() AbuseReportHostname
+the hostname ngrok has parsed out of one of the reported URLs in this abuse
+ report
+
+getHostnames() AbuseReport
+an array of hostname statuses related to the report
+
+getHttpEndpointConfiguration() ReservedDomain
+object referencing the endpoint configuration applied to http traffic on this
+ domain
+
+getHttpsEndpointConfiguration() ReservedDomain
+object referencing the endpoint configuration applied to https traffic on this
+ domain
+
+getHttpStatusCode() NgrokApiError
+Fetches the HTTP status code.
+
+getId() AbuseReport
+ID of the abuse report
+
+getId() AgentIngress
+unique Agent Ingress resource identifier
+
+getId() ApiKey
+unique API key resource identifier
+
+getId() CertificateAuthority
+unique identifier for this Certificate Authority
+
+getId() Credential
+unique tunnel credential resource identifier
+
+getId() EndpointConfiguration
+unique identifier of this endpoint configuration
+
+getId() EventDestination
+Unique identifier for this Event Destination.
+
+getId() EventStream
+Unique identifier for this Event Stream.
+
+getId() EventSubscription
+Unique identifier for this Event Subscription.
+
+getId() IpPolicy
+unique identifier for this IP policy
+
+getId() IpPolicyRule
+unique identifier for this IP policy rule
+
+getId() IpRestriction
+unique identifier for this IP restriction
+
+getId() Ref
+a resource identifier
+
+getId() ReservedAddr
+unique reserved address resource identifier
+
+getId() ReservedDomain
+unique reserved domain resource identifier
+
+getId() SshCertificateAuthority
+unique identifier for this SSH Certificate Authority
+
+getId() SshCredential
+unique ssh credential resource identifier
+
+getId() SshHostCertificate
+unique identifier for this SSH Host Certificate
+
+getId() SshUserCertificate
+unique identifier for this SSH User Certificate
+
+getId() TlsCertificate
+unique identifier for this TLS certificate
+
+getId() Tunnel
+unique tunnel resource identifier
+
+getId() TunnelSession
+unique tunnel session resource identifier
+
+getIdpMetadata() EndpointSaml
+The full XML IdP EntityDescriptor.
+
+getIdpMetadata() EndpointSamlMutate
+The full XML IdP EntityDescriptor.
+
+getInactivityTimeout() EndpointOAuth
+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.
+
+getInactivityTimeout() EndpointOidc
+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.
+
+getInactivityTimeout() EndpointSaml
+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.
+
+getInactivityTimeout() EndpointSamlMutate
+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.
+
+getIngresses() AgentIngressList
+the list of Agent Ingresses owned by this account
+
+getIp() TunnelSession
+source ip address of the tunnel session
+
+getIpPolicies() EndpointIpPolicy
+Fetches the value of the ipPolicies property.
+
+getIpPolicies() IpPolicyList
+the list of all IP policies on this account
+
+getIpPolicies() IpRestriction
+the set of IP policies that are used to enforce the restriction
+
+getIpPolicy() EndpointConfiguration
+ip policy module configuration or null
+
+getIpPolicy() IpPolicyRule
+object describing the IP policy this IP Policy Rule belongs to
+
+getIpPolicyIds() EndpointIpPolicyMutate
+list of all IP policies that will be used to check if a source IP is allowed
+ access to the endpoint
+
+getIpPolicyRules() IpPolicyRuleList
+the list of all IP policy rules on this account
+
+getIpRestrictions() IpRestrictionList
+the list of all IP restrictions on this account
+
+getIps() TlsCertificateSaNs
+set of IP addresses this TLS certificate is also valid for
+
+getIssuedAt() TlsCertificate
+timestamp (in RFC 3339 format) when this TLS certificate was issued
+ automatically, or null if this certificate was user-uploaded
+
+getIssuer() EndpointOidc
+URL of the OIDC "OpenID provider".
+
+getIssuerCommonName() TlsCertificate
+issuer common name from the leaf of this TLS certificate
+
+getKeys() ApiKeyList
+the list of API keys for this account
+
+getKeyType() SshCertificateAuthority
+the type of private key for this SSH Certificate Authority
+
+getKeyType() SshHostCertificate
+the key type of the public_key, one of rsa,
+ ecdsa or ed25519
+
+getKeyType() SshUserCertificate
+the key type of the public_key, one of rsa,
+ ecdsa or ed25519
+
+getKeyUsages() CertificateAuthority
+set of actions the private key of this Certificate Authority can be used for
+
+getKeyUsages() TlsCertificate
+set of actions the private key of this TLS certificate can be used for
+
+getKinesis() EventTarget
+Configuration used to send events to Amazon Kinesis.
+
+getLogging() EndpointConfiguration
+logging module configuration or null
+
+getLogGroupArn() EventTargetCloudwatchLogs
+An Amazon Resource Name specifying the CloudWatch Logs group to deposit events
+ into.
+
+getMaximumDuration() EndpointOAuth
+Integer number of seconds of the maximum duration of an authenticated session.
+
+getMaximumDuration() EndpointOidc
+Integer number of seconds of the maximum duration of an authenticated session.
+
+getMaximumDuration() EndpointSaml
+Integer number of seconds of the maximum duration of an authenticated session.
+
+getMaximumDuration() EndpointSamlMutate
+Integer number of seconds of the maximum duration of an authenticated session.
+
+getMetadata() AbuseReport
+arbitrary user-defined data about this abuse report.
+
+getMetadata() AgentIngress
+arbitrary user-defined machine-readable data of this Agent Ingress.
+
+getMetadata() ApiKey
+arbitrary user-defined data of this API key.
+
+getMetadata() CertificateAuthority
+arbitrary user-defined machine-readable data of this Certificate Authority.
+
+getMetadata() Credential
+arbitrary user-defined machine-readable data of this credential.
+
+getMetadata() EndpointConfiguration
+arbitrary user-defined machine-readable data of this endpoint configuration.
+
+getMetadata() EventDestination
+Arbitrary user-defined machine-readable data of this Event Destination.
+
+getMetadata() EventStream
+Arbitrary user-defined machine-readable data of this Event Stream.
+
+getMetadata() EventSubscription
+Arbitrary customer supplied information intended to be machine readable.
+
+getMetadata() IpPolicy
+arbitrary user-defined machine-readable data of this IP policy.
+
+getMetadata() IpPolicyRule
+arbitrary user-defined machine-readable data of this IP policy rule.
+
+getMetadata() IpRestriction
+arbitrary user-defined machine-readable data of this IP restriction.
+
+getMetadata() ReservedAddr
+arbitrary user-defined machine-readable data of this reserved address.
+
+getMetadata() ReservedDomain
+arbitrary user-defined machine-readable data of this reserved domain.
+
+getMetadata() SshCertificateAuthority
+arbitrary user-defined machine-readable data of this SSH Certificate Authority.
+
+getMetadata() SshCredential
+arbitrary user-defined machine-readable data of this ssh credential.
+
+getMetadata() SshHostCertificate
+arbitrary user-defined machine-readable data of this SSH Host Certificate.
+
+getMetadata() SshUserCertificate
+arbitrary user-defined machine-readable data of this SSH User Certificate.
+
+getMetadata() TlsCertificate
+arbitrary user-defined machine-readable data of this TLS certificate.
+
+getMetadata() Tunnel
+user-supplied metadata for the tunnel defined in the ngrok configuration file.
+
+getMetadata() TunnelSession
+arbitrary user-defined data specified in the metadata property in the ngrok
+ configuration file.
+
+getMetadataUrl() EndpointSaml
+A public URL where the SP's metadata is hosted.
+
+getMicrosoft() EndpointOAuthProvider
+configuration for using microsoft as the identity provider
+
+getMinVersion() EndpointTlsTermination
+The minimum TLS version used for termination and advertised to the client during
+ the TLS handshake.
+
+getMsg() ReservedDomainCertJob
+a message describing the current status or error
+
+getMutualTls() EndpointConfiguration
+mutual TLS module configuration or null
+
+getNameidFormat() EndpointSaml
+Defines the name identifier format the SP expects the IdP to use in its
+ assertions to identify subjects.
+
+getNameidFormat() EndpointSamlMutate
+Defines the name identifier format the SP expects the IdP to use in its
+ assertions to identify subjects.
+
+getNextPageUri() AgentIngressList
+URI of the next page, or null if there is no next page
+
+getNextPageUri() ApiKeyList
+URI of the next page, or null if there is no next page
+
+getNextPageUri() CertificateAuthorityList
+URI of the next page, or null if there is no next page
+
+getNextPageUri() CredentialList
+URI of the next page, or null if there is no next page
+
+getNextPageUri() EndpointConfigurationList
+URI of the next page, or null if there is no next page
+
+getNextPageUri() EventDestinationList
+URI of the next page, or null if there is no next page.
+
+getNextPageUri() EventStreamList
+URI of the next page, or null if there is no next page.
+
+getNextPageUri() EventSubscriptionList
+URI of next page, or null if there is no next page.
+
+getNextPageUri() IpPolicyList
+URI of the next page, or null if there is no next page
+
+getNextPageUri() IpPolicyRuleList
+URI of the next page, or null if there is no next page
+
+getNextPageUri() IpRestrictionList
+URI of the next page, or null if there is no next page
+
+getNextPageUri() Pageable
+Fetches the URI of the next page.
+
+getNextPageUri() ReservedAddrList
+URI of the next page, or null if there is no next page
+
+getNextPageUri() ReservedDomainList
+URI of the next page, or null if there is no next page
+
+getNextPageUri() SshCertificateAuthorityList
+URI of the next page, or null if there is no next page
+
+getNextPageUri() SshCredentialList
+URI of the next page, or null if there is no next page
+
+getNextPageUri() SshHostCertificateList
+URI of the next page, or null if there is no next page
+
+getNextPageUri() SshUserCertificateList
+URI of the next page, or null if there is no next page
+
+getNextPageUri() TlsCertificateList
+URI of the next page, or null if there is no next page
+
+getNextPageUri() TunnelList
+URI of the next page, or null if there is no next page
+
+getNextPageUri() TunnelSessionList
+URI of the next page, or null if there is no next page
+
+getNotAfter() CertificateAuthority
+timestamp when this Certificate Authority becomes invalid, RFC 3339 format
+
+getNotAfter() TlsCertificate
+timestamp when this TLS certificate becomes invalid, RFC 3339 format
+
+getNotBefore() CertificateAuthority
+timestamp when this Certificate Authority becomes valid, RFC 3339 format
+
+getNotBefore() TlsCertificate
+timestamp when this TLS certificate becomes valid, RFC 3339 format
+
+getNsTargets() AgentIngress
+a list of target values to use as the values of NS records for the domain
+ property these values will delegate control over the domain to ngrok
+
+getNumBuckets() EndpointCircuitBreaker
+Integer number of buckets into which metrics are retained.
+
+getOauth() EndpointConfiguration
+oauth module configuration or null
+
+getOidc() EndpointConfiguration
+oidc module configuration or null
+
+getOptionsPassthrough() EndpointOAuth
+Do not enforce authentication on HTTP OPTIONS requests.
+
+getOptionsPassthrough() EndpointOidc
+Do not enforce authentication on HTTP OPTIONS requests.
+
+getOptionsPassthrough() EndpointSaml
+Do not enforce authentication on HTTP OPTIONS requests.
+
+getOptionsPassthrough() EndpointSamlMutate
+Do not enforce authentication on HTTP OPTIONS requests.
+
+getOrganizations() EndpointOAuthGitHub
+a list of github org identifiers.
+
+getOs() TunnelSession
+operating system of the host the ngrok agent is running on
+
+getPage() Page
+Returns the current response page.
+
+getPrincipals() SshHostCertificate
+the list of principals included in the ssh host certificate.
+
+getPrincipals() SshUserCertificate
+the list of principals included in the ssh user certificate.
+
+getPrivateKeyType() ReservedDomainCertPolicy
+type of private key to use when requesting certificates.
+
+getPrivateKeyType() TlsCertificate
+type of the private key of this TLS certificate.
+
+getProto() Tunnel
+tunnel protocol.
+
+getProvider() EndpointOAuth
+an object which defines the identity provider to use for authentication and
+ configuration for who may access the endpoint
+
+getProvider() EndpointWebhookValidation
+a string indicating which webhook provider will be sending webhooks to this
+ endpoint.
+
+getProvisioningJob() ReservedDomainCertStatus
+status of the certificate provisioning job, or null if the certificiate isn't
+ being provisioned or renewed
+
+getPublicKey() SshCertificateAuthority
+raw public key for this SSH Certificate Authority
+
+getPublicKey() SshCredential
+the PEM-encoded public key of the SSH keypair that will be used to authenticate
+
+getPublicKey() SshHostCertificate
+a public key in OpenSSH Authorized Keys format that this certificate signs
+
+getPublicKey() SshUserCertificate
+a public key in OpenSSH Authorized Keys format that this certificate signs
+
+getPublicUrl() Tunnel
+URL of the tunnel's public endpoint
+
+getRegion() ReservedAddr
+reserve the address in this geographic ngrok datacenter.
+
+getRegion() ReservedDomain
+reserve the domain in this geographic ngrok datacenter.
+
+getRegion() Tunnel
+identifier of tune region where the tunnel is running
+
+getRegion() TunnelSession
+the ngrok region identifier in which this tunnel session was started
+
+getRegionDomains() AgentIngress
+a list of regional agent ingress domains that are subdomains of the value of
+ domain this value may increase over time as ngrok adds more regions
+
+getRemove() EndpointRequestHeaders
+a list of header names that will be removed from the HTTP Request before being
+ sent to the upstream application server
+
+getRemove() EndpointResponseHeaders
+a list of header names that will be removed from the HTTP Response returned to
+ the HTTP client
+
+getRenewsAt() ReservedDomainCertStatus
+timestamp when the next renewal will be requested, RFC 3339 format
+
+getRequestHeaders() EndpointConfiguration
+request headers module configuration or null
+
+getRequestSigningCertificatePem() EndpointSaml
+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.
+
+getReservedAddrs() ReservedAddrList
+the list of all reserved addresses on this account
+
+getReservedDomains() ReservedDomainList
+the list of all reserved domains on this account
+
+getResponseHeaders() EndpointConfiguration
+response headers module configuration or null
+
+getRetriesAt() ReservedDomainCertJob
+timestamp when the provisioning job will be retried
+
+getRole() AwsAuth
+A role for ngrok to assume on your behalf to deposit events into your AWS
+ account.
+
+getRoleArn() AwsRole
+An ARN that specifies the role that ngrok should use to deliver to the
+ configured target.
+
+getRollingWindow() EndpointCircuitBreaker
+Integer number of seconds in the statistical rolling window that metrics are
+ retained for.
+
+getSaml() EndpointConfiguration
+saml module configuration or null
+
+getSamplingRate() EventStream
+The percentage of all events you would like to capture.
+
+getScopes() EndpointOAuthFacebook
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+getScopes() EndpointOAuthGitHub
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+getScopes() EndpointOAuthGoogle
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+getScopes() EndpointOAuthMicrosoft
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+getScopes() EndpointOidc
+The set of scopes to request from the OIDC identity provider.
+
+getSecret() EndpointWebhookValidation
+a string secret used to validate requests from the given provider.
+
+getSerialNumber() TlsCertificate
+serial number of the leaf of this TLS certificate
+
+getSingleLogoutUrl() EndpointSaml
+The public URL of the SP's Single Logout Service.
+
+getSources() EventSourceList
+The list of all Event Sources for an Event Subscription
+
+getSources() EventSubscription
+Sources containing the types for which this event subscription will trigger
+
+getSshCertificateAuthorities() SshCertificateAuthorityList
+the list of all certificate authorities on this account
+
+getSshCertificateAuthorityId() SshHostCertificate
+the ssh certificate authority that is used to sign this ssh host certificate
+
+getSshCertificateAuthorityId() SshUserCertificate
+the ssh certificate authority that is used to sign this ssh user certificate
+
+getSshCredentials() SshCredentialList
+the list of all ssh credentials on this account
+
+getSshHostCertificates() SshHostCertificateList
+the list of all ssh host certificates on this account
+
+getSshUserCertificates() SshUserCertificateList
+the list of all ssh user certificates on this account
+
+getStartedAt() ReservedDomainCertJob
+timestamp when the provisioning job started, RFC 3339 format
+
+getStartedAt() Tunnel
+timestamp when the tunnel was initiated in RFC 3339 format
+
+getStartedAt() TunnelSession
+time when the tunnel session first connected to the ngrok servers
+
+getStatus() AbuseReport
+Indicates whether ngrok has processed the abuse report.
+
+getStatus() AbuseReportHostname
+indicates what action ngrok has taken against the hostname.
+
+getStreamArn() EventTargetKinesis
+An Amazon Resource Name specifying the Kinesis stream to deposit events into.
+
+getSubjectAlternativeNames() TlsCertificate
+subject alternative names (SANs) from the leaf of this TLS certificate
+
+getSubjectCommonName() CertificateAuthority
+subject common name of the Certificate Authority
+
+getSubjectCommonName() TlsCertificate
+subject common name from the leaf of this TLS certificate
+
+getSubjectCountry() TlsCertificate
+subject country from the leaf of this TLS certificate
+
+getSubjectLocality() TlsCertificate
+subject locality from the leaf of this TLS certificate
+
+getSubjectOrganization() TlsCertificate
+subject organization from the leaf of this TLS certificate
+
+getSubjectOrganizationalUnit() TlsCertificate
+subject organizational unit from the leaf of this TLS certificate
+
+getSubjectProvince() TlsCertificate
+subject province from the leaf of this TLS certificate
+
+getTarget() EventDestination
+An object that encapsulates where and how to send your events.
+
+getTeams() EndpointOAuthGitHub
+a list of github teams identifiers.
+
+getTerminateAt() EndpointTlsTermination
+edge if the ngrok edge should terminate TLS traffic,
+ upstream if TLS traffic should be passed through to the upstream
+ ngrok agent / application server for termination.
+
+getTlsCertificates() TlsCertificateList
+the list of all TLS certificates on this account
+
+getTlsTermination() EndpointConfiguration
+TLS termination module configuration or null
+
+getToken() ApiKey
+the bearer token that can be placed into the Authorization header to
+ authenticate request to the ngrok API.
+
+getToken() Credential
+the credential's authtoken that can be used to authenticate an ngrok client.
+
+getTransport() TunnelSession
+the transport protocol used to start the tunnel session.
+
+getTrippedDuration() EndpointCircuitBreaker
+Integer number of seconds after which the circuit is tripped to wait before
+ re-evaluating upstream health
+
+getTunnels() TunnelList
+the list of all online tunnels on this account
+
+getTunnelSession() Tunnel
+reference object pointing to the tunnel session on which this tunnel was started
+
+getTunnelSessions() TunnelSessionList
+list of all tunnel sessions on this account
+
+getType() EndpointConfiguration
+they type of traffic this endpoint configuration can be applied to.
+
+getType() EventSource
+Type of event for which an event subscription will trigger
+
+getType() EventSourceReplace
+Type of event for which an event subscription will trigger
+
+getType() IpRestriction
+the type of IP restriction.
+
+getUri() AbuseReport
+URI of the abuse report API resource
+
+getUri() AgentIngress
+URI to the API resource of this Agent ingress
+
+getUri() AgentIngressList
+URI of the Agent Ingress list API resource
+
+getUri() ApiKey
+URI to the API resource of this API key
+
+getUri() ApiKeyList
+URI of the API keys list API resource
+
+getUri() CertificateAuthority
+URI of the Certificate Authority API resource
+
+getUri() CertificateAuthorityList
+URI of the certificates authorities list API resource
+
+getUri() Credential
+URI of the tunnel credential API resource
+
+getUri() CredentialList
+URI of the tunnel credential list API resource
+
+getUri() EndpointConfiguration
+URI of the endpoint configuration API resource
+
+getUri() EndpointConfigurationList
+URI of the endpoint configurations list API resource
+
+getUri() EventDestination
+URI of the Event Destination API resource.
+
+getUri() EventDestinationList
+URI of the Event Destinations list API resource.
+
+getUri() EventSource
+URI of the Event Source API resource.
+
+getUri() EventSourceList
+URI of the next page, or null if there is no next page.
+
+getUri() EventStream
+URI of the Event Stream API resource.
+
+getUri() EventStreamList
+URI of the Event Stream list API resource.
+
+getUri() EventSubscription
+URI of the Event Subscription API resource.
+
+getUri() EventSubscriptionList
+URI of the Event Subscriptions list API resource.
+
+getUri() IpPolicy
+URI of the IP Policy API resource
+
+getUri() IpPolicyList
+URI of the IP policy list API resource
+
+getUri() IpPolicyRule
+URI of the IP policy rule API resource
+
+getUri() IpPolicyRuleList
+URI of the IP policy rule list API resource
+
+getUri() IpRestriction
+URI of the IP restriction API resource
+
+getUri() IpRestrictionList
+URI of the IP resrtrictions list API resource
+
+getUri() Ref
+a uri for locating a resource
+
+getUri() ReservedAddr
+URI of the reserved address API resource
+
+getUri() ReservedAddrList
+URI of the reserved address list API resource
+
+getUri() ReservedDomain
+URI of the reserved domain API resource
+
+getUri() ReservedDomainList
+URI of the reserved domain list API resource
+
+getUri() SshCertificateAuthority
+URI of the SSH Certificate Authority API resource
+
+getUri() SshCertificateAuthorityList
+URI of the certificates authorities list API resource
+
+getUri() SshCredential
+URI of the ssh credential API resource
+
+getUri() SshCredentialList
+URI of the ssh credential list API resource
+
+getUri() SshHostCertificate
+URI of the SSH Host Certificate API resource
+
+getUri() SshHostCertificateList
+URI of the ssh host certificates list API resource
+
+getUri() SshUserCertificate
+URI of the SSH User Certificate API resource
+
+getUri() SshUserCertificateList
+URI of the ssh user certificates list API resource
+
+getUri() TlsCertificate
+URI of the TLS certificate API resource
+
+getUri() TlsCertificateList
+URI of the TLS certificates list API resource
+
+getUri() TunnelList
+URI of the tunnels list API resource
+
+getUri() TunnelSession
+URI to the API resource of the tunnel session
+
+getUri() TunnelSessionList
+URI to the API resource of the tunnel session list
+
+getUrls() AbuseReport
+a list of URLs containing suspected abusive content
+
+getValidAfter() SshHostCertificate
+the time when the ssh host certificate becomes valid, in RFC 3339 format.
+
+getValidAfter() SshUserCertificate
+the time when the ssh host certificate becomes valid, in RFC 3339 format.
+
+getValidUntil() SshHostCertificate
+the time after which the ssh host certificate becomes invalid, in RFC 3339
+ format.
+
+getValidUntil() SshUserCertificate
+the time after which the ssh host certificate becomes invalid, in RFC 3339
+ format.
+
+getVolumeThreshold() EndpointCircuitBreaker
+Integer number of requests in a rolling window that will trip the circuit.
+
+getWebhookValidation() EndpointConfiguration
+webhook validation module configuration or null
+
+github(EndpointOAuthGitHub) EndpointOAuthProvider.Builder
+configuration for using github as the identity provider
+
+github(Optional<EndpointOAuthGitHub>) EndpointOAuthProvider.Builder
+configuration for using github as the identity provider
+
+google(EndpointOAuthGoogle) EndpointOAuthProvider.Builder
+configuration for using google as the identity provider
+
+google(Optional<EndpointOAuthGoogle>) EndpointOAuthProvider.Builder
+configuration for using google as the identity provider
+
+
+H
+
+hashCode() AbuseReport
+hashCode() AbuseReportHostname
+hashCode() AgentIngress
+hashCode() AgentIngressList
+hashCode() ApiKey
+hashCode() ApiKeyList
+hashCode() AwsAuth
+hashCode() AwsCredentials
+hashCode() AwsRole
+hashCode() CertificateAuthority
+hashCode() CertificateAuthorityList
+hashCode() Credential
+hashCode() CredentialList
+hashCode() EndpointCircuitBreaker
+hashCode() EndpointCompression
+hashCode() EndpointConfiguration
+hashCode() EndpointConfigurationList
+hashCode() EndpointIpPolicy
+hashCode() EndpointIpPolicyMutate
+hashCode() EndpointLogging
+hashCode() EndpointLoggingMutate
+hashCode() EndpointMutualTls
+hashCode() EndpointMutualTlsMutate
+hashCode() EndpointOAuth
+hashCode() EndpointOAuthFacebook
+hashCode() EndpointOAuthGitHub
+hashCode() EndpointOAuthGoogle
+hashCode() EndpointOAuthMicrosoft
+hashCode() EndpointOAuthProvider
+hashCode() EndpointOidc
+hashCode() EndpointRequestHeaders
+hashCode() EndpointResponseHeaders
+hashCode() EndpointSaml
+hashCode() EndpointSamlMutate
+hashCode() EndpointTlsTermination
+hashCode() EndpointWebhookValidation
+hashCode() EventDestination
+hashCode() EventDestinationList
+hashCode() EventSource
+hashCode() EventSourceList
+hashCode() EventSourceReplace
+hashCode() EventStream
+hashCode() EventStreamList
+hashCode() EventSubscription
+hashCode() EventSubscriptionList
+hashCode() EventTarget
+hashCode() EventTargetCloudwatchLogs
+hashCode() EventTargetFirehose
+hashCode() EventTargetKinesis
+hashCode() IpPolicy
+hashCode() IpPolicyList
+hashCode() IpPolicyRule
+hashCode() IpPolicyRuleList
+hashCode() IpRestriction
+hashCode() IpRestrictionList
+hashCode() Ref
+hashCode() ReservedAddr
+hashCode() ReservedAddrList
+hashCode() ReservedDomain
+hashCode() ReservedDomainCertJob
+hashCode() ReservedDomainCertPolicy
+hashCode() ReservedDomainCertStatus
+hashCode() ReservedDomainList
+hashCode() SshCertificateAuthority
+hashCode() SshCertificateAuthorityList
+hashCode() SshCredential
+hashCode() SshCredentialList
+hashCode() SshHostCertificate
+hashCode() SshHostCertificateList
+hashCode() SshUserCertificate
+hashCode() SshUserCertificateList
+hashCode() TlsCertificate
+hashCode() TlsCertificateList
+hashCode() TlsCertificateSaNs
+hashCode() Tunnel
+hashCode() TunnelList
+hashCode() TunnelSession
+hashCode() TunnelSessionList
+httpClient(WebClient) DefaultNgrokApiClient.Builder
+Sets the HTTP client to use to make requests.
+
+httpClient(Optional<WebClient>) DefaultNgrokApiClient.Builder
+Sets the HTTP client to use to make requests.
+
+httpEndpointConfigurationId(String) ReservedDomains.CreateCallBuilder
+ID of an endpoint configuration of type http that will be used to handle inbound
+ http traffic to this domain
+
+httpEndpointConfigurationId(String) ReservedDomains.UpdateCallBuilder
+ID of an endpoint configuration of type http that will be used to handle inbound
+ http traffic to this domain
+
+httpEndpointConfigurationId(Optional<String>) ReservedDomains.CreateCallBuilder
+ID of an endpoint configuration of type http that will be used to handle inbound
+ http traffic to this domain
+
+httpEndpointConfigurationId(Optional<String>) ReservedDomains.UpdateCallBuilder
+ID of an endpoint configuration of type http that will be used to handle inbound
+ http traffic to this domain
+
+httpsEndpointConfigurationId(String) ReservedDomains.CreateCallBuilder
+ID of an endpoint configuration of type https that will be used to handle
+ inbound https traffic to this domain
+
+httpsEndpointConfigurationId(String) ReservedDomains.UpdateCallBuilder
+ID of an endpoint configuration of type https that will be used to handle
+ inbound https traffic to this domain
+
+httpsEndpointConfigurationId(Optional<String>) ReservedDomains.CreateCallBuilder
+ID of an endpoint configuration of type https that will be used to handle
+ inbound https traffic to this domain
+
+httpsEndpointConfigurationId(Optional<String>) ReservedDomains.UpdateCallBuilder
+ID of an endpoint configuration of type https that will be used to handle
+ inbound https traffic to this domain
+
+
+I
+
+idpMetadata(String) EndpointSamlMutate.Builder
+The full XML IdP EntityDescriptor.
+
+idpMetadata(Optional<String>) EndpointSamlMutate.Builder
+The full XML IdP EntityDescriptor.
+
+inactivityTimeout(long) EndpointOAuth.Builder
+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.
+
+inactivityTimeout(long) EndpointOidc.Builder
+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.
+
+inactivityTimeout(long) EndpointSamlMutate.Builder
+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.
+
+inactivityTimeout(Optional<Long>) EndpointOAuth.Builder
+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.
+
+inactivityTimeout(Optional<Long>) EndpointOidc.Builder
+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.
+
+inactivityTimeout(Optional<Long>) EndpointSamlMutate.Builder
+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.
+
+ipPolicies() Ngrok
+IP Policies are reusable groups of CIDR ranges with an allow or
+ deny
+ action.
+
+IpPolicies com.ngrok.services
+IP Policies are reusable groups of CIDR ranges with an allow or
+ deny
+ action.
+
+IpPolicies(NgrokApiClient) IpPolicies
+Creates a new sub-client for IpPolicies.
+
+IpPolicies.CreateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Create API call.
+
+IpPolicies.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+IpPolicies.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+IpPolicies.ListCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent List API call.
+
+IpPolicies.UpdateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Update API call.
+
+ipPolicy() Ngrok.PointcfgModuleNamespace
+
+
+ipPolicy(EndpointIpPolicyMutate) EndpointConfigurations.CreateCallBuilder
+ip policy module configuration or null
+
+ipPolicy(EndpointIpPolicyMutate) EndpointConfigurations.UpdateCallBuilder
+ip policy module configuration or null
+
+ipPolicy(Optional<EndpointIpPolicyMutate>) EndpointConfigurations.CreateCallBuilder
+ip policy module configuration or null
+
+ipPolicy(Optional<EndpointIpPolicyMutate>) EndpointConfigurations.UpdateCallBuilder
+ip policy module configuration or null
+
+IpPolicy com.ngrok.definitions
+A class encapsulating the
IpPolicy resource.
+IpPolicy(String, URI, OffsetDateTime, String, String, String) IpPolicy
+
+
+ipPolicyIds(List<String>) EndpointIpPolicyMutate.Builder
+list of all IP policies that will be used to check if a source IP is allowed
+ access to the endpoint
+
+ipPolicyIds(List<String>) IpRestrictions.UpdateCallBuilder
+the set of IP policy identifiers that are used to enforce the restriction
+
+ipPolicyIds(Optional<List<String>>) EndpointIpPolicyMutate.Builder
+list of all IP policies that will be used to check if a source IP is allowed
+ access to the endpoint
+
+ipPolicyIds(Optional<List<String>>) IpRestrictions.UpdateCallBuilder
+the set of IP policy identifiers that are used to enforce the restriction
+
+IpPolicyList com.ngrok.definitions
+
+
+IpPolicyList(List<IpPolicy>, URI, Optional<URI>) IpPolicyList
+
+
+IpPolicyRule com.ngrok.definitions
+
+
+IpPolicyRule(String, URI, OffsetDateTime, String, String, String, Ref) IpPolicyRule
+
+
+IpPolicyRuleList com.ngrok.definitions
+
+
+IpPolicyRuleList(List<IpPolicyRule>, URI, Optional<URI>) IpPolicyRuleList
+
+
+ipPolicyRules() Ngrok
+IP Policy Rules are the IPv4 or IPv6 CIDRs entries that
+ make up an IP Policy.
+
+IpPolicyRules com.ngrok.services
+IP Policy Rules are the IPv4 or IPv6 CIDRs entries that
+ make up an IP Policy.
+
+IpPolicyRules(NgrokApiClient) IpPolicyRules
+Creates a new sub-client for IpPolicyRules.
+
+IpPolicyRules.CreateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Create API call.
+
+IpPolicyRules.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+IpPolicyRules.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+IpPolicyRules.ListCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent List API call.
+
+IpPolicyRules.UpdateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Update API call.
+
+IpRestriction com.ngrok.definitions
+
+
+IpRestriction(String, URI, OffsetDateTime, String, String, Boolean, String, List<Ref>) IpRestriction
+
+
+IpRestrictionList com.ngrok.definitions
+
+
+IpRestrictionList(List<IpRestriction>, URI, Optional<URI>) IpRestrictionList
+
+
+ipRestrictions() Ngrok
+An IP restriction is a restriction placed on the CIDRs that are allowed to
+ initate traffic to a specific aspect of your ngrok account.
+
+IpRestrictions com.ngrok.services
+An IP restriction is a restriction placed on the CIDRs that are allowed to
+ initate traffic to a specific aspect of your ngrok account.
+
+IpRestrictions(NgrokApiClient) IpRestrictions
+Creates a new sub-client for IpRestrictions.
+
+IpRestrictions.CreateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Create API call.
+
+IpRestrictions.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+IpRestrictions.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+IpRestrictions.ListCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent List API call.
+
+IpRestrictions.UpdateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Update API call.
+
+isErrorCode(String...) NgrokApiError
+Checks if this error object contains one of the provided codes.
+
+issuer(String) EndpointOidc.Builder
+URL of the OIDC "OpenID provider".
+
+issuer(Optional<String>) EndpointOidc.Builder
+URL of the OIDC "OpenID provider".
+
+
+K
+
+keySize(long) SshCertificateAuthorities.CreateCallBuilder
+the key size to use when creating an RSA key.
+
+keySize(Optional<Long>) SshCertificateAuthorities.CreateCallBuilder
+the key size to use when creating an RSA key.
+
+kinesis(EventTargetKinesis) EventTarget.Builder
+Configuration used to send events to Amazon Kinesis.
+
+kinesis(Optional<EventTargetKinesis>) EventTarget.Builder
+Configuration used to send events to Amazon Kinesis.
+
+
+L
+
+limit(String) AgentIngresses.ListCallBuilder
+Sets the limit parameter.
+
+limit(String) ApiKeys.ListCallBuilder
+Sets the limit parameter.
+
+limit(String) CertificateAuthorities.ListCallBuilder
+Sets the limit parameter.
+
+limit(String) Credentials.ListCallBuilder
+Sets the limit parameter.
+
+limit(String) EndpointConfigurations.ListCallBuilder
+Sets the limit parameter.
+
+limit(String) EventDestinations.ListCallBuilder
+Sets the limit parameter.
+
+limit(String) EventStreams.ListCallBuilder
+Sets the limit parameter.
+
+limit(String) EventSubscriptions.ListCallBuilder
+Sets the limit parameter.
+
+limit(String) IpPolicies.ListCallBuilder
+Sets the limit parameter.
+
+limit(String) IpPolicyRules.ListCallBuilder
+Sets the limit parameter.
+
+limit(String) IpRestrictions.ListCallBuilder
+Sets the limit parameter.
+
+limit(String) ReservedAddrs.ListCallBuilder
+Sets the limit parameter.
+
+limit(String) ReservedDomains.ListCallBuilder
+Sets the limit parameter.
+
+limit(String) SshCertificateAuthorities.ListCallBuilder
+Sets the limit parameter.
+
+limit(String) SshCredentials.ListCallBuilder
+Sets the limit parameter.
+
+limit(String) SshHostCertificates.ListCallBuilder
+Sets the limit parameter.
+
+limit(String) SshUserCertificates.ListCallBuilder
+Sets the limit parameter.
+
+limit(String) TlsCertificates.ListCallBuilder
+Sets the limit parameter.
+
+limit(String) Tunnels.ListCallBuilder
+Sets the limit parameter.
+
+limit(String) TunnelSessions.ListCallBuilder
+Sets the limit parameter.
+
+limit(Optional<String>) AgentIngresses.ListCallBuilder
+Sets (or unsets) the limit parameter.
+
+limit(Optional<String>) ApiKeys.ListCallBuilder
+Sets (or unsets) the limit parameter.
+
+limit(Optional<String>) CertificateAuthorities.ListCallBuilder
+Sets (or unsets) the limit parameter.
+
+limit(Optional<String>) Credentials.ListCallBuilder
+Sets (or unsets) the limit parameter.
+
+limit(Optional<String>) EndpointConfigurations.ListCallBuilder
+Sets (or unsets) the limit parameter.
+
+limit(Optional<String>) EventDestinations.ListCallBuilder
+Sets (or unsets) the limit parameter.
+
+limit(Optional<String>) EventStreams.ListCallBuilder
+Sets (or unsets) the limit parameter.
+
+limit(Optional<String>) EventSubscriptions.ListCallBuilder
+Sets (or unsets) the limit parameter.
+
+limit(Optional<String>) IpPolicies.ListCallBuilder
+Sets (or unsets) the limit parameter.
+
+limit(Optional<String>) IpPolicyRules.ListCallBuilder
+Sets (or unsets) the limit parameter.
+
+limit(Optional<String>) IpRestrictions.ListCallBuilder
+Sets (or unsets) the limit parameter.
+
+limit(Optional<String>) ReservedAddrs.ListCallBuilder
+Sets (or unsets) the limit parameter.
+
+limit(Optional<String>) ReservedDomains.ListCallBuilder
+Sets (or unsets) the limit parameter.
+
+limit(Optional<String>) SshCertificateAuthorities.ListCallBuilder
+Sets (or unsets) the limit parameter.
+
+limit(Optional<String>) SshCredentials.ListCallBuilder
+Sets (or unsets) the limit parameter.
+
+limit(Optional<String>) SshHostCertificates.ListCallBuilder
+Sets (or unsets) the limit parameter.
+
+limit(Optional<String>) SshUserCertificates.ListCallBuilder
+Sets (or unsets) the limit parameter.
+
+limit(Optional<String>) TlsCertificates.ListCallBuilder
+Sets (or unsets) the limit parameter.
+
+limit(Optional<String>) Tunnels.ListCallBuilder
+Sets (or unsets) the limit parameter.
+
+limit(Optional<String>) TunnelSessions.ListCallBuilder
+Sets (or unsets) the limit parameter.
+
+list() AgentIngresses
+
+
+list() ApiKeys
+
+
+list() CertificateAuthorities
+
+
+list() Credentials
+
+
+list() EndpointConfigurations
+
+
+list() EventDestinations
+List all Event Destinations on this account.
+
+list() EventStreams
+List all Event Streams available on this account.
+
+list() EventSubscriptions
+List this Account's Event Subscriptions.
+
+list() IpPolicies
+
+
+list() IpPolicyRules
+
+
+list() IpRestrictions
+
+
+list() ReservedAddrs
+List all reserved addresses on this account.
+
+list() ReservedDomains
+List all reserved domains on this account.
+
+list() SshCertificateAuthorities
+
+
+list() SshCredentials
+
+
+list() SshHostCertificates
+
+
+list() SshUserCertificates
+
+
+list() TlsCertificates
+
+
+list() Tunnels
+List all online tunnels currently running on the account.
+
+list() TunnelSessions
+List all online tunnel sessions running on this account.
+
+list(String) EventSources
+
+
+logging() Ngrok.PointcfgModuleNamespace
+
+
+logging(EndpointLoggingMutate) EndpointConfigurations.CreateCallBuilder
+logging module configuration or null
+
+logging(EndpointLoggingMutate) EndpointConfigurations.UpdateCallBuilder
+logging module configuration or null
+
+logging(Optional<EndpointLoggingMutate>) EndpointConfigurations.CreateCallBuilder
+logging module configuration or null
+
+logging(Optional<EndpointLoggingMutate>) EndpointConfigurations.UpdateCallBuilder
+logging module configuration or null
+
+logGroupArn(String) EventTargetCloudwatchLogs.Builder
+An Amazon Resource Name specifying the CloudWatch Logs group to deposit events
+ into.
+
+logGroupArn(Optional<String>) EventTargetCloudwatchLogs.Builder
+An Amazon Resource Name specifying the CloudWatch Logs group to deposit events
+ into.
+
+
+M
+
+maximumDuration(Duration) EndpointOAuth.Builder
+Integer number of seconds of the maximum duration of an authenticated session.
+
+maximumDuration(Duration) EndpointOidc.Builder
+Integer number of seconds of the maximum duration of an authenticated session.
+
+maximumDuration(Duration) EndpointSamlMutate.Builder
+Integer number of seconds of the maximum duration of an authenticated session.
+
+maximumDuration(Optional<Duration>) EndpointOAuth.Builder
+Integer number of seconds of the maximum duration of an authenticated session.
+
+maximumDuration(Optional<Duration>) EndpointOidc.Builder
+Integer number of seconds of the maximum duration of an authenticated session.
+
+maximumDuration(Optional<Duration>) EndpointSamlMutate.Builder
+Integer number of seconds of the maximum duration of an authenticated session.
+
+metadata(String) AbuseReports.CreateCallBuilder
+arbitrary user-defined data about this abuse report.
+
+metadata(String) AgentIngresses.CreateCallBuilder
+arbitrary user-defined machine-readable data of this Agent Ingress.
+
+metadata(String) AgentIngresses.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this Agent Ingress.
+
+metadata(String) ApiKeys.CreateCallBuilder
+arbitrary user-defined data of this API key.
+
+metadata(String) ApiKeys.UpdateCallBuilder
+arbitrary user-defined data of this API key.
+
+metadata(String) CertificateAuthorities.CreateCallBuilder
+arbitrary user-defined machine-readable data of this Certificate Authority.
+
+metadata(String) CertificateAuthorities.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this Certificate Authority.
+
+metadata(String) Credentials.CreateCallBuilder
+arbitrary user-defined machine-readable data of this credential.
+
+metadata(String) Credentials.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this credential.
+
+metadata(String) EndpointConfigurations.CreateCallBuilder
+arbitrary user-defined machine-readable data of this endpoint configuration.
+
+metadata(String) EndpointConfigurations.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this endpoint configuration.
+
+metadata(String) EventDestinations.CreateCallBuilder
+Arbitrary user-defined machine-readable data of this Event Destination.
+
+metadata(String) EventDestinations.UpdateCallBuilder
+Arbitrary user-defined machine-readable data of this Event Destination.
+
+metadata(String) EventStreams.CreateCallBuilder
+Arbitrary user-defined machine-readable data of this Event Stream.
+
+metadata(String) EventStreams.UpdateCallBuilder
+Arbitrary user-defined machine-readable data of this Event Stream.
+
+metadata(String) EventSubscriptions.CreateCallBuilder
+Arbitrary customer supplied information intended to be machine readable.
+
+metadata(String) EventSubscriptions.UpdateCallBuilder
+Arbitrary customer supplied information intended to be machine readable.
+
+metadata(String) IpPolicies.CreateCallBuilder
+arbitrary user-defined machine-readable data of this IP policy.
+
+metadata(String) IpPolicies.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this IP policy.
+
+metadata(String) IpPolicyRules.CreateCallBuilder
+arbitrary user-defined machine-readable data of this IP policy rule.
+
+metadata(String) IpPolicyRules.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this IP policy rule.
+
+metadata(String) IpRestrictions.CreateCallBuilder
+arbitrary user-defined machine-readable data of this IP restriction.
+
+metadata(String) IpRestrictions.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this IP restriction.
+
+metadata(String) ReservedAddrs.CreateCallBuilder
+arbitrary user-defined machine-readable data of this reserved address.
+
+metadata(String) ReservedAddrs.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this reserved address.
+
+metadata(String) ReservedDomains.CreateCallBuilder
+arbitrary user-defined machine-readable data of this reserved domain.
+
+metadata(String) ReservedDomains.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this reserved domain.
+
+metadata(String) SshCertificateAuthorities.CreateCallBuilder
+arbitrary user-defined machine-readable data of this SSH Certificate Authority.
+
+metadata(String) SshCertificateAuthorities.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this SSH Certificate Authority.
+
+metadata(String) SshCredentials.CreateCallBuilder
+arbitrary user-defined machine-readable data of this ssh credential.
+
+metadata(String) SshCredentials.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this ssh credential.
+
+metadata(String) SshHostCertificates.CreateCallBuilder
+arbitrary user-defined machine-readable data of this SSH Host Certificate.
+
+metadata(String) SshHostCertificates.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this SSH Host Certificate.
+
+metadata(String) SshUserCertificates.CreateCallBuilder
+arbitrary user-defined machine-readable data of this SSH User Certificate.
+
+metadata(String) SshUserCertificates.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this SSH User Certificate.
+
+metadata(String) TlsCertificates.CreateCallBuilder
+arbitrary user-defined machine-readable data of this TLS certificate.
+
+metadata(String) TlsCertificates.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this TLS certificate.
+
+metadata(Optional<String>) AbuseReports.CreateCallBuilder
+arbitrary user-defined data about this abuse report.
+
+metadata(Optional<String>) AgentIngresses.CreateCallBuilder
+arbitrary user-defined machine-readable data of this Agent Ingress.
+
+metadata(Optional<String>) AgentIngresses.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this Agent Ingress.
+
+metadata(Optional<String>) ApiKeys.CreateCallBuilder
+arbitrary user-defined data of this API key.
+
+metadata(Optional<String>) ApiKeys.UpdateCallBuilder
+arbitrary user-defined data of this API key.
+
+metadata(Optional<String>) CertificateAuthorities.CreateCallBuilder
+arbitrary user-defined machine-readable data of this Certificate Authority.
+
+metadata(Optional<String>) CertificateAuthorities.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this Certificate Authority.
+
+metadata(Optional<String>) Credentials.CreateCallBuilder
+arbitrary user-defined machine-readable data of this credential.
+
+metadata(Optional<String>) Credentials.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this credential.
+
+metadata(Optional<String>) EndpointConfigurations.CreateCallBuilder
+arbitrary user-defined machine-readable data of this endpoint configuration.
+
+metadata(Optional<String>) EndpointConfigurations.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this endpoint configuration.
+
+metadata(Optional<String>) EventDestinations.CreateCallBuilder
+Arbitrary user-defined machine-readable data of this Event Destination.
+
+metadata(Optional<String>) EventDestinations.UpdateCallBuilder
+Arbitrary user-defined machine-readable data of this Event Destination.
+
+metadata(Optional<String>) EventStreams.CreateCallBuilder
+Arbitrary user-defined machine-readable data of this Event Stream.
+
+metadata(Optional<String>) EventStreams.UpdateCallBuilder
+Arbitrary user-defined machine-readable data of this Event Stream.
+
+metadata(Optional<String>) EventSubscriptions.CreateCallBuilder
+Arbitrary customer supplied information intended to be machine readable.
+
+metadata(Optional<String>) EventSubscriptions.UpdateCallBuilder
+Arbitrary customer supplied information intended to be machine readable.
+
+metadata(Optional<String>) IpPolicies.CreateCallBuilder
+arbitrary user-defined machine-readable data of this IP policy.
+
+metadata(Optional<String>) IpPolicies.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this IP policy.
+
+metadata(Optional<String>) IpPolicyRules.CreateCallBuilder
+arbitrary user-defined machine-readable data of this IP policy rule.
+
+metadata(Optional<String>) IpPolicyRules.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this IP policy rule.
+
+metadata(Optional<String>) IpRestrictions.CreateCallBuilder
+arbitrary user-defined machine-readable data of this IP restriction.
+
+metadata(Optional<String>) IpRestrictions.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this IP restriction.
+
+metadata(Optional<String>) ReservedAddrs.CreateCallBuilder
+arbitrary user-defined machine-readable data of this reserved address.
+
+metadata(Optional<String>) ReservedAddrs.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this reserved address.
+
+metadata(Optional<String>) ReservedDomains.CreateCallBuilder
+arbitrary user-defined machine-readable data of this reserved domain.
+
+metadata(Optional<String>) ReservedDomains.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this reserved domain.
+
+metadata(Optional<String>) SshCertificateAuthorities.CreateCallBuilder
+arbitrary user-defined machine-readable data of this SSH Certificate Authority.
+
+metadata(Optional<String>) SshCertificateAuthorities.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this SSH Certificate Authority.
+
+metadata(Optional<String>) SshCredentials.CreateCallBuilder
+arbitrary user-defined machine-readable data of this ssh credential.
+
+metadata(Optional<String>) SshCredentials.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this ssh credential.
+
+metadata(Optional<String>) SshHostCertificates.CreateCallBuilder
+arbitrary user-defined machine-readable data of this SSH Host Certificate.
+
+metadata(Optional<String>) SshHostCertificates.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this SSH Host Certificate.
+
+metadata(Optional<String>) SshUserCertificates.CreateCallBuilder
+arbitrary user-defined machine-readable data of this SSH User Certificate.
+
+metadata(Optional<String>) SshUserCertificates.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this SSH User Certificate.
+
+metadata(Optional<String>) TlsCertificates.CreateCallBuilder
+arbitrary user-defined machine-readable data of this TLS certificate.
+
+metadata(Optional<String>) TlsCertificates.UpdateCallBuilder
+arbitrary user-defined machine-readable data of this TLS certificate.
+
+microsoft(EndpointOAuthMicrosoft) EndpointOAuthProvider.Builder
+configuration for using microsoft as the identity provider
+
+microsoft(Optional<EndpointOAuthMicrosoft>) EndpointOAuthProvider.Builder
+configuration for using microsoft as the identity provider
+
+minVersion(String) EndpointTlsTermination.Builder
+The minimum TLS version used for termination and advertised to the client during
+ the TLS handshake.
+
+minVersion(Optional<String>) EndpointTlsTermination.Builder
+The minimum TLS version used for termination and advertised to the client during
+ the TLS handshake.
+
+module(EndpointCircuitBreaker) EndpointCircuitBreakerModule.ReplaceCallBuilder
+Sets the module parameter.
+
+module(EndpointCompression) EndpointCompressionModule.ReplaceCallBuilder
+Sets the module parameter.
+
+module(EndpointIpPolicyMutate) EndpointIpPolicyModule.ReplaceCallBuilder
+Sets the module parameter.
+
+module(EndpointLoggingMutate) EndpointLoggingModule.ReplaceCallBuilder
+Sets the module parameter.
+
+module(EndpointMutualTlsMutate) EndpointMutualTlsModule.ReplaceCallBuilder
+Sets the module parameter.
+
+module(EndpointOAuth) EndpointOAuthModule.ReplaceCallBuilder
+Sets the module parameter.
+
+module(EndpointOidc) EndpointOidcModule.ReplaceCallBuilder
+Sets the module parameter.
+
+module(EndpointRequestHeaders) EndpointRequestHeadersModule.ReplaceCallBuilder
+Sets the module parameter.
+
+module(EndpointResponseHeaders) EndpointResponseHeadersModule.ReplaceCallBuilder
+Sets the module parameter.
+
+module(EndpointSamlMutate) EndpointSamlModule.ReplaceCallBuilder
+Sets the module parameter.
+
+module(EndpointTlsTermination) EndpointTlsTerminationModule.ReplaceCallBuilder
+Sets the module parameter.
+
+module(EndpointWebhookValidation) EndpointWebhookValidationModule.ReplaceCallBuilder
+Sets the module parameter.
+
+module(Optional<EndpointCircuitBreaker>) EndpointCircuitBreakerModule.ReplaceCallBuilder
+Sets (or unsets) the module parameter.
+
+module(Optional<EndpointCompression>) EndpointCompressionModule.ReplaceCallBuilder
+Sets (or unsets) the module parameter.
+
+module(Optional<EndpointIpPolicyMutate>) EndpointIpPolicyModule.ReplaceCallBuilder
+Sets (or unsets) the module parameter.
+
+module(Optional<EndpointLoggingMutate>) EndpointLoggingModule.ReplaceCallBuilder
+Sets (or unsets) the module parameter.
+
+module(Optional<EndpointMutualTlsMutate>) EndpointMutualTlsModule.ReplaceCallBuilder
+Sets (or unsets) the module parameter.
+
+module(Optional<EndpointOAuth>) EndpointOAuthModule.ReplaceCallBuilder
+Sets (or unsets) the module parameter.
+
+module(Optional<EndpointOidc>) EndpointOidcModule.ReplaceCallBuilder
+Sets (or unsets) the module parameter.
+
+module(Optional<EndpointRequestHeaders>) EndpointRequestHeadersModule.ReplaceCallBuilder
+Sets (or unsets) the module parameter.
+
+module(Optional<EndpointResponseHeaders>) EndpointResponseHeadersModule.ReplaceCallBuilder
+Sets (or unsets) the module parameter.
+
+module(Optional<EndpointSamlMutate>) EndpointSamlModule.ReplaceCallBuilder
+Sets (or unsets) the module parameter.
+
+module(Optional<EndpointTlsTermination>) EndpointTlsTerminationModule.ReplaceCallBuilder
+Sets (or unsets) the module parameter.
+
+module(Optional<EndpointWebhookValidation>) EndpointWebhookValidationModule.ReplaceCallBuilder
+Sets (or unsets) the module parameter.
+
+mutualTls() Ngrok.PointcfgModuleNamespace
+
+
+mutualTls(EndpointMutualTlsMutate) EndpointConfigurations.CreateCallBuilder
+mutual TLS module configuration or null
+
+mutualTls(EndpointMutualTlsMutate) EndpointConfigurations.UpdateCallBuilder
+mutual TLS module configuration or null
+
+mutualTls(Optional<EndpointMutualTlsMutate>) EndpointConfigurations.CreateCallBuilder
+mutual TLS module configuration or null
+
+mutualTls(Optional<EndpointMutualTlsMutate>) EndpointConfigurations.UpdateCallBuilder
+mutual TLS module configuration or null
+
+
+N
+
+nameidFormat(String) EndpointSamlMutate.Builder
+Defines the name identifier format the SP expects the IdP to use in its
+ assertions to identify subjects.
+
+nameidFormat(Optional<String>) EndpointSamlMutate.Builder
+Defines the name identifier format the SP expects the IdP to use in its
+ assertions to identify subjects.
+
+newBuilder() AwsAuth
+Creates a new builder for the
AwsAuth type.
+newBuilder() EndpointCircuitBreaker
+
+
+newBuilder() EndpointCompression
+
+
+newBuilder() EndpointIpPolicyMutate
+
+
+newBuilder() EndpointLoggingMutate
+
+
+newBuilder() EndpointMutualTlsMutate
+
+
+newBuilder() EndpointOAuth
+
+
+newBuilder() EndpointOAuthFacebook
+
+
+newBuilder() EndpointOAuthGitHub
+
+
+newBuilder() EndpointOAuthGoogle
+
+
+newBuilder() EndpointOAuthMicrosoft
+
+
+newBuilder() EndpointOAuthProvider
+
+
+newBuilder() EndpointOidc
+
+
+newBuilder() EndpointRequestHeaders
+
+
+newBuilder() EndpointResponseHeaders
+
+
+newBuilder() EndpointSamlMutate
+
+
+newBuilder() EndpointTlsTermination
+
+
+newBuilder() EndpointWebhookValidation
+
+
+newBuilder() EventSourceReplace
+
+
+newBuilder() EventTarget
+
+
+newBuilder() EventTargetCloudwatchLogs
+
+
+newBuilder() EventTargetFirehose
+
+
+newBuilder() EventTargetKinesis
+
+
+newBuilder() ReservedDomainCertPolicy
+
+
+newBuilder(String) DefaultNgrokApiClient
+Creates a new ngrok API client builder.
+
+newBuilder(String) AwsRole
+Creates a new builder for the
AwsRole type.
+newBuilder(String, String) AwsCredentials
+
+
+newDefaultHttpClient() DefaultNgrokApiClient
+Creates a new default Armeria WebClient.
+
+next() Page
+Fetches the next page of responses, if any.
+
+Ngrok com.ngrok
+Main entry point for the ngrok API.
+
+Ngrok(NgrokApiClient) Ngrok
+Create a new ngrok API instance.
+
+Ngrok.PointcfgModuleNamespace com.ngrok
+A namespace object for PointcfgModule.
+
+NgrokApiClient com.ngrok
+API client interface.
+
+NgrokApiClient.HttpMethod com.ngrok
+HTTP request methods
+
+NgrokApiError com.ngrok.definitions
+Representation of an API error from ngrok.
+
+NgrokApiError(int) NgrokApiError
+Creates a new API error.
+
+NgrokApiError(int, Optional<String>, Throwable) NgrokApiError
+Creates a new API error.
+
+NgrokApiError(String, int, Optional<String>, Map<String, String>) NgrokApiError
+Creates a new API error.
+
+numBuckets(long) EndpointCircuitBreaker.Builder
+Integer number of buckets into which metrics are retained.
+
+numBuckets(Optional<Long>) EndpointCircuitBreaker.Builder
+Integer number of buckets into which metrics are retained.
+
+
+O
+
+oauth() Ngrok.PointcfgModuleNamespace
+
+
+oauth(EndpointOAuth) EndpointConfigurations.CreateCallBuilder
+oauth module configuration or null
+
+oauth(EndpointOAuth) EndpointConfigurations.UpdateCallBuilder
+oauth module configuration or null
+
+oauth(Optional<EndpointOAuth>) EndpointConfigurations.CreateCallBuilder
+oauth module configuration or null
+
+oauth(Optional<EndpointOAuth>) EndpointConfigurations.UpdateCallBuilder
+oauth module configuration or null
+
+objectMapper(ObjectMapper) DefaultNgrokApiClient.Builder
+Sets the Jackson object mapper to use to serialize request bodies and deserialize response bodies.
+
+objectMapper(Optional<ObjectMapper>) DefaultNgrokApiClient.Builder
+Sets the Jackson object mapper to use to serialize request bodies and deserialize response bodies.
+
+oidc() Ngrok.PointcfgModuleNamespace
+
+
+oidc(EndpointOidc) EndpointConfigurations.CreateCallBuilder
+oidc module configuration or null
+
+oidc(EndpointOidc) EndpointConfigurations.UpdateCallBuilder
+oidc module configuration or null
+
+oidc(Optional<EndpointOidc>) EndpointConfigurations.CreateCallBuilder
+oidc module configuration or null
+
+oidc(Optional<EndpointOidc>) EndpointConfigurations.UpdateCallBuilder
+oidc module configuration or null
+
+optionsPassthrough(boolean) EndpointOAuth.Builder
+Do not enforce authentication on HTTP OPTIONS requests.
+
+optionsPassthrough(boolean) EndpointOidc.Builder
+Do not enforce authentication on HTTP OPTIONS requests.
+
+optionsPassthrough(boolean) EndpointSamlMutate.Builder
+Do not enforce authentication on HTTP OPTIONS requests.
+
+optionsPassthrough(Optional<Boolean>) EndpointOAuth.Builder
+Do not enforce authentication on HTTP OPTIONS requests.
+
+optionsPassthrough(Optional<Boolean>) EndpointOidc.Builder
+Do not enforce authentication on HTTP OPTIONS requests.
+
+optionsPassthrough(Optional<Boolean>) EndpointSamlMutate.Builder
+Do not enforce authentication on HTTP OPTIONS requests.
+
+organizations(List<String>) EndpointOAuthGitHub.Builder
+a list of github org identifiers.
+
+organizations(Optional<List<String>>) EndpointOAuthGitHub.Builder
+a list of github org identifiers.
+
+
+P
+
+Page T extends Pageable > - Class in com.ngrok.definitions
+Wrapper class that holds a single page of a
Pageable response.
+Page(NgrokApiClient, T) Page
+Create a new page.
+
+Pageable com.ngrok.definitions
+Interface indicating a resource type that can have more than one page of responses.
+
+PATCH NgrokApiClient.HttpMethod
+HTTP PATCH
+
+pointcfgModule() Ngrok
+Creates a namespace object for PointcfgModule.
+
+POST NgrokApiClient.HttpMethod
+HTTP POST
+
+principals(List<String>) SshHostCertificates.CreateCallBuilder
+the list of principals included in the ssh host certificate.
+
+principals(List<String>) SshUserCertificates.CreateCallBuilder
+the list of principals included in the ssh user certificate.
+
+principals(Optional<List<String>>) SshHostCertificates.CreateCallBuilder
+the list of principals included in the ssh host certificate.
+
+principals(Optional<List<String>>) SshUserCertificates.CreateCallBuilder
+the list of principals included in the ssh user certificate.
+
+privateKeyType(String) ReservedDomainCertPolicy.Builder
+type of private key to use when requesting certificates.
+
+privateKeyType(String) SshCertificateAuthorities.CreateCallBuilder
+the type of private key to generate.
+
+privateKeyType(Optional<String>) ReservedDomainCertPolicy.Builder
+type of private key to use when requesting certificates.
+
+privateKeyType(Optional<String>) SshCertificateAuthorities.CreateCallBuilder
+the type of private key to generate.
+
+provider(EndpointOAuthProvider) EndpointOAuth.Builder
+an object which defines the identity provider to use for authentication and
+ configuration for who may access the endpoint
+
+provider(String) EndpointWebhookValidation.Builder
+a string indicating which webhook provider will be sending webhooks to this
+ endpoint.
+
+provider(Optional<EndpointOAuthProvider>) EndpointOAuth.Builder
+an object which defines the identity provider to use for authentication and
+ configuration for who may access the endpoint
+
+provider(Optional<String>) EndpointWebhookValidation.Builder
+a string indicating which webhook provider will be sending webhooks to this
+ endpoint.
+
+PUT NgrokApiClient.HttpMethod
+HTTP PUT
+
+
+R
+
+Ref com.ngrok.definitions
+A class encapsulating the
Ref resource.
+Ref(String, URI) Ref
+Creates a new instance of
Ref.
+region(String) ReservedAddrs.CreateCallBuilder
+reserve the address in this geographic ngrok datacenter.
+
+region(String) ReservedDomains.CreateCallBuilder
+reserve the domain in this geographic ngrok datacenter.
+
+region(Optional<String>) ReservedAddrs.CreateCallBuilder
+reserve the address in this geographic ngrok datacenter.
+
+region(Optional<String>) ReservedDomains.CreateCallBuilder
+reserve the domain in this geographic ngrok datacenter.
+
+remove(List<String>) EndpointRequestHeaders.Builder
+a list of header names that will be removed from the HTTP Request before being
+ sent to the upstream application server
+
+remove(List<String>) EndpointResponseHeaders.Builder
+a list of header names that will be removed from the HTTP Response returned to
+ the HTTP client
+
+remove(Optional<List<String>>) EndpointRequestHeaders.Builder
+a list of header names that will be removed from the HTTP Request before being
+ sent to the upstream application server
+
+remove(Optional<List<String>>) EndpointResponseHeaders.Builder
+a list of header names that will be removed from the HTTP Response returned to
+ the HTTP client
+
+replace(String) EndpointCircuitBreakerModule
+Creates a call builder for the Replace API operation.
+
+replace(String) EndpointCompressionModule
+Creates a call builder for the Replace API operation.
+
+replace(String) EndpointIpPolicyModule
+Creates a call builder for the Replace API operation.
+
+replace(String) EndpointLoggingModule
+Creates a call builder for the Replace API operation.
+
+replace(String) EndpointMutualTlsModule
+Creates a call builder for the Replace API operation.
+
+replace(String) EndpointOAuthModule
+Creates a call builder for the Replace API operation.
+
+replace(String) EndpointOidcModule
+Creates a call builder for the Replace API operation.
+
+replace(String) EndpointRequestHeadersModule
+Creates a call builder for the Replace API operation.
+
+replace(String) EndpointResponseHeadersModule
+Creates a call builder for the Replace API operation.
+
+replace(String) EndpointSamlModule
+Creates a call builder for the Replace API operation.
+
+replace(String) EndpointTlsTerminationModule
+Creates a call builder for the Replace API operation.
+
+replace(String) EndpointWebhookValidationModule
+Creates a call builder for the Replace API operation.
+
+requestHeaders() Ngrok.PointcfgModuleNamespace
+
+
+requestHeaders(EndpointRequestHeaders) EndpointConfigurations.CreateCallBuilder
+request headers module configuration or null
+
+requestHeaders(EndpointRequestHeaders) EndpointConfigurations.UpdateCallBuilder
+request headers module configuration or null
+
+requestHeaders(Optional<EndpointRequestHeaders>) EndpointConfigurations.CreateCallBuilder
+request headers module configuration or null
+
+requestHeaders(Optional<EndpointRequestHeaders>) EndpointConfigurations.UpdateCallBuilder
+request headers module configuration or null
+
+ReservedAddr com.ngrok.definitions
+
+
+ReservedAddr(String, URI, OffsetDateTime, String, String, String, String, Optional<Ref>) ReservedAddr
+
+
+ReservedAddrList com.ngrok.definitions
+
+
+ReservedAddrList(List<ReservedAddr>, URI, Optional<URI>) ReservedAddrList
+
+
+reservedAddrs() Ngrok
+Reserved Addresses are TCP addresses that can be used to listen for traffic.
+
+ReservedAddrs com.ngrok.services
+Reserved Addresses are TCP addresses that can be used to listen for traffic.
+
+ReservedAddrs(NgrokApiClient) ReservedAddrs
+Creates a new sub-client for ReservedAddrs.
+
+ReservedAddrs.CreateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Create API call.
+
+ReservedAddrs.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+ReservedAddrs.DeleteEndpointConfigCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent DeleteEndpointConfig API call.
+
+ReservedAddrs.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+ReservedAddrs.ListCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent List API call.
+
+ReservedAddrs.UpdateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Update API call.
+
+ReservedDomain com.ngrok.definitions
+
+
+ReservedDomain(String, URI, OffsetDateTime, String, String, String, String, Optional<String>, Optional<Ref>, Optional<Ref>, Optional<Ref>, Optional<ReservedDomainCertPolicy>, Optional<ReservedDomainCertStatus>, Optional<String>) ReservedDomain
+
+
+ReservedDomainCertJob com.ngrok.definitions
+
+
+ReservedDomainCertJob(Optional<String>, String, OffsetDateTime, Optional<OffsetDateTime>) ReservedDomainCertJob
+
+
+ReservedDomainCertPolicy com.ngrok.definitions
+
+
+ReservedDomainCertPolicy.Builder com.ngrok.definitions
+
+
+ReservedDomainCertStatus com.ngrok.definitions
+
+
+ReservedDomainCertStatus(Optional<OffsetDateTime>, Optional<ReservedDomainCertJob>) ReservedDomainCertStatus
+
+
+ReservedDomainList com.ngrok.definitions
+
+
+ReservedDomainList(List<ReservedDomain>, URI, Optional<URI>) ReservedDomainList
+
+
+reservedDomains() Ngrok
+Reserved Domains are hostnames that you can listen for traffic on.
+
+ReservedDomains com.ngrok.services
+Reserved Domains are hostnames that you can listen for traffic on.
+
+ReservedDomains(NgrokApiClient) ReservedDomains
+Creates a new sub-client for ReservedDomains.
+
+ReservedDomains.CreateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Create API call.
+
+ReservedDomains.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+ReservedDomains.DeleteCertificateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent DeleteCertificate API call.
+
+ReservedDomains.DeleteCertificateManagementPolicyCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent DeleteCertificateManagementPolicy API call.
+
+ReservedDomains.DeleteHttpEndpointConfigCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent DeleteHttpEndpointConfig API call.
+
+ReservedDomains.DeleteHttpsEndpointConfigCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent DeleteHttpsEndpointConfig API call.
+
+ReservedDomains.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+ReservedDomains.ListCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent List API call.
+
+ReservedDomains.UpdateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Update API call.
+
+responseHeaders() Ngrok.PointcfgModuleNamespace
+
+
+responseHeaders(EndpointResponseHeaders) EndpointConfigurations.CreateCallBuilder
+response headers module configuration or null
+
+responseHeaders(EndpointResponseHeaders) EndpointConfigurations.UpdateCallBuilder
+response headers module configuration or null
+
+responseHeaders(Optional<EndpointResponseHeaders>) EndpointConfigurations.CreateCallBuilder
+response headers module configuration or null
+
+responseHeaders(Optional<EndpointResponseHeaders>) EndpointConfigurations.UpdateCallBuilder
+response headers module configuration or null
+
+restart(String) TunnelSessions
+Issues a command instructing the ngrok agent to restart.
+
+role(AwsRole) AwsAuth.Builder
+A role for ngrok to assume on your behalf to deposit events into your AWS
+ account.
+
+role(Optional<AwsRole>) AwsAuth.Builder
+A role for ngrok to assume on your behalf to deposit events into your AWS
+ account.
+
+rollingWindow(long) EndpointCircuitBreaker.Builder
+Integer number of seconds in the statistical rolling window that metrics are
+ retained for.
+
+rollingWindow(Optional<Long>) EndpointCircuitBreaker.Builder
+Integer number of seconds in the statistical rolling window that metrics are
+ retained for.
+
+
+S
+
+saml() Ngrok.PointcfgModuleNamespace
+
+
+saml(EndpointSamlMutate) EndpointConfigurations.CreateCallBuilder
+saml module configuration or null
+
+saml(EndpointSamlMutate) EndpointConfigurations.UpdateCallBuilder
+saml module configuration or null
+
+saml(Optional<EndpointSamlMutate>) EndpointConfigurations.CreateCallBuilder
+saml module configuration or null
+
+saml(Optional<EndpointSamlMutate>) EndpointConfigurations.UpdateCallBuilder
+saml module configuration or null
+
+samplingRate(double) EventStreams.CreateCallBuilder
+The percentage of all events you would like to capture.
+
+samplingRate(double) EventStreams.UpdateCallBuilder
+The percentage of all events you would like to capture.
+
+samplingRate(Optional<Double>) EventStreams.CreateCallBuilder
+The percentage of all events you would like to capture.
+
+samplingRate(Optional<Double>) EventStreams.UpdateCallBuilder
+The percentage of all events you would like to capture.
+
+scopes(List<String>) EndpointOAuthFacebook.Builder
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+scopes(List<String>) EndpointOAuthGitHub.Builder
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+scopes(List<String>) EndpointOAuthGoogle.Builder
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+scopes(List<String>) EndpointOAuthMicrosoft.Builder
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+scopes(List<String>) EndpointOidc.Builder
+The set of scopes to request from the OIDC identity provider.
+
+scopes(Optional<List<String>>) EndpointOAuthFacebook.Builder
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+scopes(Optional<List<String>>) EndpointOAuthGitHub.Builder
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+scopes(Optional<List<String>>) EndpointOAuthGoogle.Builder
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+scopes(Optional<List<String>>) EndpointOAuthMicrosoft.Builder
+a list of provider-specific OAuth scopes with the permissions your OAuth app
+ would like to ask for.
+
+scopes(Optional<List<String>>) EndpointOidc.Builder
+The set of scopes to request from the OIDC identity provider.
+
+secret(String) EndpointWebhookValidation.Builder
+a string secret used to validate requests from the given provider.
+
+secret(Optional<String>) EndpointWebhookValidation.Builder
+a string secret used to validate requests from the given provider.
+
+sendRequest(NgrokApiClient.HttpMethod, String, Stream<Map.Entry<String, Optional<Object>>>, Stream<Map.Entry<String, Optional<Object>>>, Optional<Class<O>>) DefaultNgrokApiClient
+Sends a request to the ngrok API.
+
+sendRequest(NgrokApiClient.HttpMethod, String, Stream<Map.Entry<String, Optional<Object>>>, Stream<Map.Entry<String, Optional<Object>>>, Optional<Class<O>>) NgrokApiClient
+Sends a request to the ngrok API.
+
+sendRequest(URI, Class<O>) DefaultNgrokApiClient
+Sends a GET request directly to the specified URI.
+
+sendRequest(URI, Class<O>) NgrokApiClient
+Sends a GET request directly to the specified URI.
+
+sources(List<EventSourceReplace>) EventSubscriptions.CreateCallBuilder
+Sources containing the types for which this event subscription will trigger
+
+sources(List<EventSourceReplace>) EventSubscriptions.UpdateCallBuilder
+Sources containing the types for which this event subscription will trigger
+
+sources(Optional<List<EventSourceReplace>>) EventSubscriptions.CreateCallBuilder
+Sources containing the types for which this event subscription will trigger
+
+sources(Optional<List<EventSourceReplace>>) EventSubscriptions.UpdateCallBuilder
+Sources containing the types for which this event subscription will trigger
+
+sshCertificateAuthorities() Ngrok
+An SSH Certificate Authority is a pair of an SSH Certificate and its private
+ key that can be used to sign other SSH host and user certificates.
+
+SshCertificateAuthorities com.ngrok.services
+An SSH Certificate Authority is a pair of an SSH Certificate and its private
+ key that can be used to sign other SSH host and user certificates.
+
+SshCertificateAuthorities(NgrokApiClient) SshCertificateAuthorities
+Creates a new sub-client for SshCertificateAuthorities.
+
+SshCertificateAuthorities.CreateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Create API call.
+
+SshCertificateAuthorities.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+SshCertificateAuthorities.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+SshCertificateAuthorities.ListCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent List API call.
+
+SshCertificateAuthorities.UpdateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Update API call.
+
+SshCertificateAuthority com.ngrok.definitions
+
+
+SshCertificateAuthority(String, URI, OffsetDateTime, String, String, String, String) SshCertificateAuthority
+
+
+SshCertificateAuthorityList com.ngrok.definitions
+
+
+SshCertificateAuthorityList(List<SshCertificateAuthority>, URI, Optional<URI>) SshCertificateAuthorityList
+
+
+SshCredential com.ngrok.definitions
+
+
+SshCredential(String, URI, OffsetDateTime, String, String, String, List<String>) SshCredential
+
+
+SshCredentialList com.ngrok.definitions
+
+
+SshCredentialList(List<SshCredential>, URI, Optional<URI>) SshCredentialList
+
+
+sshCredentials() Ngrok
+SSH Credentials are SSH public keys that can be used to start SSH tunnels
+ via the ngrok SSH tunnel gateway.
+
+SshCredentials com.ngrok.services
+SSH Credentials are SSH public keys that can be used to start SSH tunnels
+ via the ngrok SSH tunnel gateway.
+
+SshCredentials(NgrokApiClient) SshCredentials
+Creates a new sub-client for SshCredentials.
+
+SshCredentials.CreateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Create API call.
+
+SshCredentials.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+SshCredentials.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+SshCredentials.ListCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent List API call.
+
+SshCredentials.UpdateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Update API call.
+
+SshHostCertificate com.ngrok.definitions
+
+
+SshHostCertificate(String, URI, OffsetDateTime, String, String, String, String, String, List<String>, OffsetDateTime, OffsetDateTime, String) SshHostCertificate
+
+
+SshHostCertificateList com.ngrok.definitions
+
+
+SshHostCertificateList(List<SshHostCertificate>, URI, Optional<URI>) SshHostCertificateList
+
+
+sshHostCertificates() Ngrok
+SSH Host Certificates along with the corresponding private key allows an SSH
+ server to assert its authenticity to connecting SSH clients who trust the
+ SSH Certificate Authority that was used to sign the certificate.
+
+SshHostCertificates com.ngrok.services
+SSH Host Certificates along with the corresponding private key allows an SSH
+ server to assert its authenticity to connecting SSH clients who trust the
+ SSH Certificate Authority that was used to sign the certificate.
+
+SshHostCertificates(NgrokApiClient) SshHostCertificates
+Creates a new sub-client for SshHostCertificates.
+
+SshHostCertificates.CreateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Create API call.
+
+SshHostCertificates.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+SshHostCertificates.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+SshHostCertificates.ListCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent List API call.
+
+SshHostCertificates.UpdateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Update API call.
+
+SshUserCertificate com.ngrok.definitions
+
+
+SshUserCertificate(String, URI, OffsetDateTime, String, String, String, String, String, List<String>, Map<String, String>, Map<String, String>, OffsetDateTime, OffsetDateTime, String) SshUserCertificate
+
+
+SshUserCertificateList com.ngrok.definitions
+
+
+SshUserCertificateList(List<SshUserCertificate>, URI, Optional<URI>) SshUserCertificateList
+
+
+sshUserCertificates() Ngrok
+SSH User Certificates are presented by SSH clients when connecting to an SSH
+ server to authenticate their connection.
+
+SshUserCertificates com.ngrok.services
+SSH User Certificates are presented by SSH clients when connecting to an SSH
+ server to authenticate their connection.
+
+SshUserCertificates(NgrokApiClient) SshUserCertificates
+Creates a new sub-client for SshUserCertificates.
+
+SshUserCertificates.CreateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Create API call.
+
+SshUserCertificates.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+SshUserCertificates.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+SshUserCertificates.ListCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent List API call.
+
+SshUserCertificates.UpdateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Update API call.
+
+stop(String) TunnelSessions
+Issues a command instructing the ngrok agent that started this tunnel session to
+ exit.
+
+streamArn(String) EventTargetKinesis.Builder
+An Amazon Resource Name specifying the Kinesis stream to deposit events into.
+
+streamArn(Optional<String>) EventTargetKinesis.Builder
+An Amazon Resource Name specifying the Kinesis stream to deposit events into.
+
+
+T
+
+target(EventTarget) EventDestinations.CreateCallBuilder
+An object that encapsulates where and how to send your events.
+
+target(EventTarget) EventDestinations.UpdateCallBuilder
+An object that encapsulates where and how to send your events.
+
+target(Optional<EventTarget>) EventDestinations.CreateCallBuilder
+An object that encapsulates where and how to send your events.
+
+target(Optional<EventTarget>) EventDestinations.UpdateCallBuilder
+An object that encapsulates where and how to send your events.
+
+teams(List<String>) EndpointOAuthGitHub.Builder
+a list of github teams identifiers.
+
+teams(Optional<List<String>>) EndpointOAuthGitHub.Builder
+a list of github teams identifiers.
+
+terminateAt(String) EndpointTlsTermination.Builder
+edge if the ngrok edge should terminate TLS traffic,
+ upstream if TLS traffic should be passed through to the upstream
+ ngrok agent / application server for termination.
+
+terminateAt(Optional<String>) EndpointTlsTermination.Builder
+edge if the ngrok edge should terminate TLS traffic,
+ upstream if TLS traffic should be passed through to the upstream
+ ngrok agent / application server for termination.
+
+TlsCertificate com.ngrok.definitions
+
+
+TlsCertificate(String, URI, OffsetDateTime, String, String, String, String, TlsCertificateSaNs, Optional<OffsetDateTime>, OffsetDateTime, OffsetDateTime, List<String>, List<String>, String, String, String, String, String, String, String, String) TlsCertificate
+
+
+TlsCertificateList com.ngrok.definitions
+
+
+TlsCertificateList(List<TlsCertificate>, URI, Optional<URI>) TlsCertificateList
+
+
+tlsCertificates() Ngrok
+TLS Certificates are pairs of x509 certificates and their matching private
+ key that can be used to terminate TLS traffic.
+
+TlsCertificates com.ngrok.services
+TLS Certificates are pairs of x509 certificates and their matching private
+ key that can be used to terminate TLS traffic.
+
+TlsCertificates(NgrokApiClient) TlsCertificates
+Creates a new sub-client for TlsCertificates.
+
+TlsCertificates.CreateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Create API call.
+
+TlsCertificates.DeleteCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Delete API call.
+
+TlsCertificates.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+TlsCertificates.ListCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent List API call.
+
+TlsCertificates.UpdateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Update API call.
+
+TlsCertificateSaNs com.ngrok.definitions
+
+
+TlsCertificateSaNs(List<String>, List<String>) TlsCertificateSaNs
+
+
+tlsTermination() Ngrok.PointcfgModuleNamespace
+
+
+tlsTermination(EndpointTlsTermination) EndpointConfigurations.CreateCallBuilder
+TLS termination module configuration or null
+
+tlsTermination(EndpointTlsTermination) EndpointConfigurations.UpdateCallBuilder
+TLS termination module configuration or null
+
+tlsTermination(Optional<EndpointTlsTermination>) EndpointConfigurations.CreateCallBuilder
+TLS termination module configuration or null
+
+tlsTermination(Optional<EndpointTlsTermination>) EndpointConfigurations.UpdateCallBuilder
+TLS termination module configuration or null
+
+toString() AbuseReport
+toString() AbuseReportHostname
+toString() AgentIngress
+toString() AgentIngressList
+toString() ApiKey
+toString() ApiKeyList
+toString() AwsAuth
+toString() AwsCredentials
+toString() AwsRole
+toString() CertificateAuthority
+toString() CertificateAuthorityList
+toString() Credential
+toString() CredentialList
+toString() EndpointCircuitBreaker
+toString() EndpointCompression
+toString() EndpointConfiguration
+toString() EndpointConfigurationList
+toString() EndpointIpPolicy
+toString() EndpointIpPolicyMutate
+toString() EndpointLogging
+toString() EndpointLoggingMutate
+toString() EndpointMutualTls
+toString() EndpointMutualTlsMutate
+toString() EndpointOAuth
+toString() EndpointOAuthFacebook
+toString() EndpointOAuthGitHub
+toString() EndpointOAuthGoogle
+toString() EndpointOAuthMicrosoft
+toString() EndpointOAuthProvider
+toString() EndpointOidc
+toString() EndpointRequestHeaders
+toString() EndpointResponseHeaders
+toString() EndpointSaml
+toString() EndpointSamlMutate
+toString() EndpointTlsTermination
+toString() EndpointWebhookValidation
+toString() EventDestination
+toString() EventDestinationList
+toString() EventSource
+toString() EventSourceList
+toString() EventSourceReplace
+toString() EventStream
+toString() EventStreamList
+toString() EventSubscription
+toString() EventSubscriptionList
+toString() EventTarget
+toString() EventTargetCloudwatchLogs
+toString() EventTargetFirehose
+toString() EventTargetKinesis
+toString() IpPolicy
+toString() IpPolicyList
+toString() IpPolicyRule
+toString() IpPolicyRuleList
+toString() IpRestriction
+toString() IpRestrictionList
+toString() Ref
+toString() ReservedAddr
+toString() ReservedAddrList
+toString() ReservedDomain
+toString() ReservedDomainCertJob
+toString() ReservedDomainCertPolicy
+toString() ReservedDomainCertStatus
+toString() ReservedDomainList
+toString() SshCertificateAuthority
+toString() SshCertificateAuthorityList
+toString() SshCredential
+toString() SshCredentialList
+toString() SshHostCertificate
+toString() SshHostCertificateList
+toString() SshUserCertificate
+toString() SshUserCertificateList
+toString() TlsCertificate
+toString() TlsCertificateList
+toString() TlsCertificateSaNs
+toString() Tunnel
+toString() TunnelList
+toString() TunnelSession
+toString() TunnelSessionList
+trippedDuration(Duration) EndpointCircuitBreaker.Builder
+Integer number of seconds after which the circuit is tripped to wait before
+ re-evaluating upstream health
+
+trippedDuration(Optional<Duration>) EndpointCircuitBreaker.Builder
+Integer number of seconds after which the circuit is tripped to wait before
+ re-evaluating upstream health
+
+Tunnel com.ngrok.definitions
+A class encapsulating the
Tunnel resource.
+Tunnel(String, URI, OffsetDateTime, String, String, String, Ref) Tunnel
+Creates a new instance of
Tunnel.
+TunnelList com.ngrok.definitions
+
+
+TunnelList(List<Tunnel>, URI, Optional<URI>) TunnelList
+
+
+tunnels() Ngrok
+Tunnels provide endpoints to access services exposed by a running ngrok
+ agent tunnel session or an SSH reverse tunnel session.
+
+Tunnels com.ngrok.services
+Tunnels provide endpoints to access services exposed by a running ngrok
+ agent tunnel session or an SSH reverse tunnel session.
+
+Tunnels(NgrokApiClient) Tunnels
+Creates a new sub-client for Tunnels.
+
+Tunnels.ListCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent List API call.
+
+TunnelSession com.ngrok.definitions
+
+
+TunnelSession(String, Ref, String, String, String, String, String, OffsetDateTime, String, URI) TunnelSession
+
+
+TunnelSessionList com.ngrok.definitions
+
+
+TunnelSessionList(List<TunnelSession>, URI, Optional<URI>) TunnelSessionList
+
+
+tunnelSessions() Ngrok
+Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
+ sessions that are running and connected to the ngrok service.
+
+TunnelSessions com.ngrok.services
+Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
+ sessions that are running and connected to the ngrok service.
+
+TunnelSessions(NgrokApiClient) TunnelSessions
+Creates a new sub-client for TunnelSessions.
+
+TunnelSessions.GetCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Get API call.
+
+TunnelSessions.ListCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent List API call.
+
+TunnelSessions.RestartCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Restart API call.
+
+TunnelSessions.StopCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Stop API call.
+
+TunnelSessions.UpdateCallBuilder com.ngrok.services
+A builder object encapsulating state for an unsent Update API call.
+
+type(String) EventSourceReplace.Builder
+Type of event for which an event subscription will trigger
+
+type(String) EndpointConfigurations.CreateCallBuilder
+they type of traffic this endpoint configuration can be applied to.
+
+type(String) EventSources.CreateCallBuilder
+Type of event for which an event subscription will trigger
+
+type(Optional<String>) EventSourceReplace.Builder
+Type of event for which an event subscription will trigger
+
+type(Optional<String>) EndpointConfigurations.CreateCallBuilder
+they type of traffic this endpoint configuration can be applied to.
+
+type(Optional<String>) EventSources.CreateCallBuilder
+Type of event for which an event subscription will trigger
+
+
+U
+
+update(String) AgentIngresses
+Update attributes of an Agent Ingress by ID.
+
+update(String) ApiKeys
+Update attributes of an API key by ID.
+
+update(String) CertificateAuthorities
+
+
+update(String) Credentials
+
+
+update(String) EndpointConfigurations
+Updates an endpoint configuration.
+
+update(String) EventDestinations
+Update attributes of an Event Destination.
+
+update(String) EventStreams
+Update attributes of an Event Stream by ID.
+
+update(String) EventSubscriptions
+Update an Event Subscription.
+
+update(String) IpPolicies
+
+
+update(String) IpPolicyRules
+
+
+update(String) IpRestrictions
+
+
+update(String) ReservedAddrs
+Update the attributes of a reserved address.
+
+update(String) ReservedDomains
+Update the attributes of a reserved domain.
+
+update(String) SshCertificateAuthorities
+
+
+update(String) SshCredentials
+
+
+update(String) SshHostCertificates
+
+
+update(String) SshUserCertificates
+
+
+update(String) TlsCertificates
+
+
+update(String) TunnelSessions
+Issues a command instructing the ngrok agent to update itself to the latest
+ version.
+
+update(String, String) EventSources
+
+
+
+V
+
+validAfter(OffsetDateTime) SshHostCertificates.CreateCallBuilder
+The time when the host certificate becomes valid, in RFC 3339 format.
+
+validAfter(OffsetDateTime) SshUserCertificates.CreateCallBuilder
+The time when the user certificate becomes valid, in RFC 3339 format.
+
+validAfter(Optional<OffsetDateTime>) SshHostCertificates.CreateCallBuilder
+The time when the host certificate becomes valid, in RFC 3339 format.
+
+validAfter(Optional<OffsetDateTime>) SshUserCertificates.CreateCallBuilder
+The time when the user certificate becomes valid, in RFC 3339 format.
+
+validUntil(OffsetDateTime) SshHostCertificates.CreateCallBuilder
+The time when this host certificate becomes invalid, in RFC 3339 format.
+
+validUntil(OffsetDateTime) SshUserCertificates.CreateCallBuilder
+The time when this host certificate becomes invalid, in RFC 3339 format.
+
+validUntil(Optional<OffsetDateTime>) SshHostCertificates.CreateCallBuilder
+The time when this host certificate becomes invalid, in RFC 3339 format.
+
+validUntil(Optional<OffsetDateTime>) SshUserCertificates.CreateCallBuilder
+The time when this host certificate becomes invalid, in RFC 3339 format.
+
+valueOf(String) NgrokApiClient.HttpMethod
+Returns the enum constant of this type with the specified name.
+
+values() NgrokApiClient.HttpMethod
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+
+Version com.ngrok
+Client version information
+
+volumeThreshold(long) EndpointCircuitBreaker.Builder
+Integer number of requests in a rolling window that will trip the circuit.
+
+volumeThreshold(Optional<Long>) EndpointCircuitBreaker.Builder
+Integer number of requests in a rolling window that will trip the circuit.
+
+
+W
+
+webhookValidation() Ngrok.PointcfgModuleNamespace
+
+
+webhookValidation(EndpointWebhookValidation) EndpointConfigurations.CreateCallBuilder
+webhook validation module configuration or null
+
+webhookValidation(EndpointWebhookValidation) EndpointConfigurations.UpdateCallBuilder
+webhook validation module configuration or null
+
+webhookValidation(Optional<EndpointWebhookValidation>) EndpointConfigurations.CreateCallBuilder
+webhook validation module configuration or null
+
+webhookValidation(Optional<EndpointWebhookValidation>) EndpointConfigurations.UpdateCallBuilder
+webhook validation module configuration or null
+
+
+A B C D E F G H I K L M N O P R S T U V W All Classes | All Packages | Constant Field Values | Serialized Form
+
+
+
Overview (ngrok Java API client 0.2.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/docs/jquery-ui.overrides.css b/docs/jquery-ui.overrides.css
new file mode 100644
index 0000000..f89acb6
--- /dev/null
+++ b/docs/jquery-ui.overrides.css
@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+.ui-state-active,
+.ui-widget-content .ui-state-active,
+.ui-widget-header .ui-state-active,
+a.ui-button:active,
+.ui-button:active,
+.ui-button.ui-state-active:hover {
+ /* Overrides the color of selection used in jQuery UI */
+ background: #F8981D;
+}
diff --git a/docs/member-search-index.js b/docs/member-search-index.js
new file mode 100644
index 0000000..9e342bb
--- /dev/null
+++ b/docs/member-search-index.js
@@ -0,0 +1 @@
+memberSearchIndex = [{"p":"com.ngrok.definitions","c":"AbuseReport","l":"AbuseReport(String, URI, OffsetDateTime, List, String, String, List)","u":"%3Cinit%3E(java.lang.String,java.net.URI,java.time.OffsetDateTime,java.util.List,java.lang.String,java.lang.String,java.util.List)"},{"p":"com.ngrok.definitions","c":"AbuseReportHostname","l":"AbuseReportHostname(String, String)","u":"%3Cinit%3E(java.lang.String,java.lang.String)"},{"p":"com.ngrok","c":"Ngrok","l":"abuseReports()"},{"p":"com.ngrok.services","c":"AbuseReports","l":"AbuseReports(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.services","c":"Credentials.CreateCallBuilder","l":"acl(List)","u":"acl(java.util.List)"},{"p":"com.ngrok.services","c":"Credentials.UpdateCallBuilder","l":"acl(List)","u":"acl(java.util.List)"},{"p":"com.ngrok.services","c":"SshCredentials.CreateCallBuilder","l":"acl(List)","u":"acl(java.util.List)"},{"p":"com.ngrok.services","c":"SshCredentials.UpdateCallBuilder","l":"acl(List)","u":"acl(java.util.List)"},{"p":"com.ngrok.services","c":"Credentials.CreateCallBuilder","l":"acl(Optional>)","u":"acl(java.util.Optional)"},{"p":"com.ngrok.services","c":"Credentials.UpdateCallBuilder","l":"acl(Optional>)","u":"acl(java.util.Optional)"},{"p":"com.ngrok.services","c":"SshCredentials.CreateCallBuilder","l":"acl(Optional>)","u":"acl(java.util.Optional)"},{"p":"com.ngrok.services","c":"SshCredentials.UpdateCallBuilder","l":"acl(Optional>)","u":"acl(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointRequestHeaders.Builder","l":"add(Map)","u":"add(java.util.Map)"},{"p":"com.ngrok.definitions","c":"EndpointResponseHeaders.Builder","l":"add(Map)","u":"add(java.util.Map)"},{"p":"com.ngrok.definitions","c":"EndpointRequestHeaders.Builder","l":"add(Optional>)","u":"add(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointResponseHeaders.Builder","l":"add(Optional>)","u":"add(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"AgentIngress","l":"AgentIngress(String, URI, String, String, String, List, List, String)","u":"%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)"},{"p":"com.ngrok","c":"Ngrok","l":"agentIngresses()"},{"p":"com.ngrok.services","c":"AgentIngresses","l":"AgentIngresses(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.definitions","c":"AgentIngressList","l":"AgentIngressList(List, URI, Optional)","u":"%3Cinit%3E(java.util.List,java.net.URI,java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate.Builder","l":"allowIdpInitiated(boolean)"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate.Builder","l":"allowIdpInitiated(Optional)","u":"allowIdpInitiated(java.util.Optional)"},{"p":"com.ngrok","c":"Version","l":"API_VERSION"},{"p":"com.ngrok.definitions","c":"ApiKey","l":"ApiKey(String, URI, String, String, OffsetDateTime, Optional)","u":"%3Cinit%3E(java.lang.String,java.net.URI,java.lang.String,java.lang.String,java.time.OffsetDateTime,java.util.Optional)"},{"p":"com.ngrok.definitions","c":"ApiKeyList","l":"ApiKeyList(List, URI, Optional)","u":"%3Cinit%3E(java.util.List,java.net.URI,java.util.Optional)"},{"p":"com.ngrok","c":"Ngrok","l":"apiKeys()"},{"p":"com.ngrok.services","c":"ApiKeys","l":"ApiKeys(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.definitions","c":"EventTargetCloudwatchLogs.Builder","l":"auth(AwsAuth)","u":"auth(com.ngrok.definitions.AwsAuth)"},{"p":"com.ngrok.definitions","c":"EventTargetFirehose.Builder","l":"auth(AwsAuth)","u":"auth(com.ngrok.definitions.AwsAuth)"},{"p":"com.ngrok.definitions","c":"EventTargetKinesis.Builder","l":"auth(AwsAuth)","u":"auth(com.ngrok.definitions.AwsAuth)"},{"p":"com.ngrok.definitions","c":"EventTargetCloudwatchLogs.Builder","l":"auth(Optional)","u":"auth(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EventTargetFirehose.Builder","l":"auth(Optional)","u":"auth(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EventTargetKinesis.Builder","l":"auth(Optional)","u":"auth(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOAuth.Builder","l":"authCheckInterval(long)"},{"p":"com.ngrok.definitions","c":"EndpointOAuth.Builder","l":"authCheckInterval(Optional)","u":"authCheckInterval(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"ReservedDomainCertPolicy.Builder","l":"authority(Optional)","u":"authority(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"ReservedDomainCertPolicy.Builder","l":"authority(String)","u":"authority(java.lang.String)"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate.Builder","l":"authorizedGroups(List)","u":"authorizedGroups(java.util.List)"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate.Builder","l":"authorizedGroups(Optional>)","u":"authorizedGroups(java.util.Optional)"},{"p":"com.ngrok","c":"DefaultNgrokApiClient.Builder","l":"baseUri(Optional)","u":"baseUri(java.util.Optional)"},{"p":"com.ngrok","c":"DefaultNgrokApiClient.Builder","l":"baseUri(URI)","u":"baseUri(java.net.URI)"},{"p":"com.ngrok.services","c":"AgentIngresses.ListCallBuilder","l":"beforeId(Optional)","u":"beforeId(java.util.Optional)"},{"p":"com.ngrok.services","c":"ApiKeys.ListCallBuilder","l":"beforeId(Optional)","u":"beforeId(java.util.Optional)"},{"p":"com.ngrok.services","c":"CertificateAuthorities.ListCallBuilder","l":"beforeId(Optional)","u":"beforeId(java.util.Optional)"},{"p":"com.ngrok.services","c":"Credentials.ListCallBuilder","l":"beforeId(Optional)","u":"beforeId(java.util.Optional)"},{"p":"com.ngrok.services","c":"EndpointConfigurations.ListCallBuilder","l":"beforeId(Optional)","u":"beforeId(java.util.Optional)"},{"p":"com.ngrok.services","c":"EventDestinations.ListCallBuilder","l":"beforeId(Optional)","u":"beforeId(java.util.Optional)"},{"p":"com.ngrok.services","c":"EventStreams.ListCallBuilder","l":"beforeId(Optional)","u":"beforeId(java.util.Optional)"},{"p":"com.ngrok.services","c":"EventSubscriptions.ListCallBuilder","l":"beforeId(Optional)","u":"beforeId(java.util.Optional)"},{"p":"com.ngrok.services","c":"IpPolicies.ListCallBuilder","l":"beforeId(Optional)","u":"beforeId(java.util.Optional)"},{"p":"com.ngrok.services","c":"IpPolicyRules.ListCallBuilder","l":"beforeId(Optional)","u":"beforeId(java.util.Optional)"},{"p":"com.ngrok.services","c":"IpRestrictions.ListCallBuilder","l":"beforeId(Optional)","u":"beforeId(java.util.Optional)"},{"p":"com.ngrok.services","c":"ReservedAddrs.ListCallBuilder","l":"beforeId(Optional)","u":"beforeId(java.util.Optional)"},{"p":"com.ngrok.services","c":"ReservedDomains.ListCallBuilder","l":"beforeId(Optional)","u":"beforeId(java.util.Optional)"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities.ListCallBuilder","l":"beforeId(Optional)","u":"beforeId(java.util.Optional)"},{"p":"com.ngrok.services","c":"SshCredentials.ListCallBuilder","l":"beforeId(Optional)","u":"beforeId(java.util.Optional)"},{"p":"com.ngrok.services","c":"SshHostCertificates.ListCallBuilder","l":"beforeId(Optional)","u":"beforeId(java.util.Optional)"},{"p":"com.ngrok.services","c":"SshUserCertificates.ListCallBuilder","l":"beforeId(Optional)","u":"beforeId(java.util.Optional)"},{"p":"com.ngrok.services","c":"TlsCertificates.ListCallBuilder","l":"beforeId(Optional)","u":"beforeId(java.util.Optional)"},{"p":"com.ngrok.services","c":"Tunnels.ListCallBuilder","l":"beforeId(Optional)","u":"beforeId(java.util.Optional)"},{"p":"com.ngrok.services","c":"TunnelSessions.ListCallBuilder","l":"beforeId(Optional)","u":"beforeId(java.util.Optional)"},{"p":"com.ngrok.services","c":"AgentIngresses.ListCallBuilder","l":"beforeId(String)","u":"beforeId(java.lang.String)"},{"p":"com.ngrok.services","c":"ApiKeys.ListCallBuilder","l":"beforeId(String)","u":"beforeId(java.lang.String)"},{"p":"com.ngrok.services","c":"CertificateAuthorities.ListCallBuilder","l":"beforeId(String)","u":"beforeId(java.lang.String)"},{"p":"com.ngrok.services","c":"Credentials.ListCallBuilder","l":"beforeId(String)","u":"beforeId(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointConfigurations.ListCallBuilder","l":"beforeId(String)","u":"beforeId(java.lang.String)"},{"p":"com.ngrok.services","c":"EventDestinations.ListCallBuilder","l":"beforeId(String)","u":"beforeId(java.lang.String)"},{"p":"com.ngrok.services","c":"EventStreams.ListCallBuilder","l":"beforeId(String)","u":"beforeId(java.lang.String)"},{"p":"com.ngrok.services","c":"EventSubscriptions.ListCallBuilder","l":"beforeId(String)","u":"beforeId(java.lang.String)"},{"p":"com.ngrok.services","c":"IpPolicies.ListCallBuilder","l":"beforeId(String)","u":"beforeId(java.lang.String)"},{"p":"com.ngrok.services","c":"IpPolicyRules.ListCallBuilder","l":"beforeId(String)","u":"beforeId(java.lang.String)"},{"p":"com.ngrok.services","c":"IpRestrictions.ListCallBuilder","l":"beforeId(String)","u":"beforeId(java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedAddrs.ListCallBuilder","l":"beforeId(String)","u":"beforeId(java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedDomains.ListCallBuilder","l":"beforeId(String)","u":"beforeId(java.lang.String)"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities.ListCallBuilder","l":"beforeId(String)","u":"beforeId(java.lang.String)"},{"p":"com.ngrok.services","c":"SshCredentials.ListCallBuilder","l":"beforeId(String)","u":"beforeId(java.lang.String)"},{"p":"com.ngrok.services","c":"SshHostCertificates.ListCallBuilder","l":"beforeId(String)","u":"beforeId(java.lang.String)"},{"p":"com.ngrok.services","c":"SshUserCertificates.ListCallBuilder","l":"beforeId(String)","u":"beforeId(java.lang.String)"},{"p":"com.ngrok.services","c":"TlsCertificates.ListCallBuilder","l":"beforeId(String)","u":"beforeId(java.lang.String)"},{"p":"com.ngrok.services","c":"Tunnels.ListCallBuilder","l":"beforeId(String)","u":"beforeId(java.lang.String)"},{"p":"com.ngrok.services","c":"TunnelSessions.ListCallBuilder","l":"beforeId(String)","u":"beforeId(java.lang.String)"},{"p":"com.ngrok.services","c":"AbuseReports.CreateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"AbuseReports.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"AgentIngresses.CreateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"AgentIngresses.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"AgentIngresses.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"AgentIngresses.ListCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"AgentIngresses.UpdateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"ApiKeys.CreateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"ApiKeys.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"ApiKeys.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"ApiKeys.ListCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"ApiKeys.UpdateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"CertificateAuthorities.CreateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"CertificateAuthorities.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"CertificateAuthorities.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"CertificateAuthorities.ListCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"CertificateAuthorities.UpdateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"Credentials.CreateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"Credentials.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"Credentials.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"Credentials.ListCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"Credentials.UpdateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointCircuitBreakerModule.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointCircuitBreakerModule.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointCircuitBreakerModule.ReplaceCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointCompressionModule.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointCompressionModule.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointCompressionModule.ReplaceCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointConfigurations.CreateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointConfigurations.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointConfigurations.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointConfigurations.ListCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointConfigurations.UpdateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointIpPolicyModule.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointIpPolicyModule.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointIpPolicyModule.ReplaceCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointLoggingModule.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointLoggingModule.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointLoggingModule.ReplaceCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointMutualTlsModule.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointMutualTlsModule.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointMutualTlsModule.ReplaceCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointOAuthModule.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointOAuthModule.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointOAuthModule.ReplaceCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointOidcModule.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointOidcModule.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointOidcModule.ReplaceCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointRequestHeadersModule.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointRequestHeadersModule.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointRequestHeadersModule.ReplaceCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointResponseHeadersModule.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointResponseHeadersModule.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointResponseHeadersModule.ReplaceCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointSamlModule.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointSamlModule.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointSamlModule.ReplaceCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointTlsTerminationModule.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointTlsTerminationModule.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointTlsTerminationModule.ReplaceCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointWebhookValidationModule.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointWebhookValidationModule.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EndpointWebhookValidationModule.ReplaceCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EventDestinations.CreateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EventDestinations.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EventDestinations.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EventDestinations.ListCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EventDestinations.UpdateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EventSources.CreateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EventSources.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EventSources.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EventSources.ListCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EventSources.UpdateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EventStreams.CreateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EventStreams.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EventStreams.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EventStreams.ListCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EventStreams.UpdateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EventSubscriptions.CreateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EventSubscriptions.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EventSubscriptions.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EventSubscriptions.ListCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"EventSubscriptions.UpdateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"IpPolicies.CreateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"IpPolicies.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"IpPolicies.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"IpPolicies.ListCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"IpPolicies.UpdateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"IpPolicyRules.CreateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"IpPolicyRules.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"IpPolicyRules.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"IpPolicyRules.ListCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"IpPolicyRules.UpdateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"IpRestrictions.CreateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"IpRestrictions.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"IpRestrictions.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"IpRestrictions.ListCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"IpRestrictions.UpdateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"ReservedAddrs.CreateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"ReservedAddrs.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"ReservedAddrs.DeleteEndpointConfigCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"ReservedAddrs.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"ReservedAddrs.ListCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"ReservedAddrs.UpdateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"ReservedDomains.CreateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"ReservedDomains.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"ReservedDomains.DeleteCertificateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"ReservedDomains.DeleteCertificateManagementPolicyCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"ReservedDomains.DeleteHttpEndpointConfigCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"ReservedDomains.DeleteHttpsEndpointConfigCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"ReservedDomains.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"ReservedDomains.ListCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"ReservedDomains.UpdateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities.CreateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities.ListCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities.UpdateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"SshCredentials.CreateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"SshCredentials.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"SshCredentials.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"SshCredentials.ListCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"SshCredentials.UpdateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"SshHostCertificates.CreateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"SshHostCertificates.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"SshHostCertificates.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"SshHostCertificates.ListCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"SshHostCertificates.UpdateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"SshUserCertificates.CreateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"SshUserCertificates.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"SshUserCertificates.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"SshUserCertificates.ListCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"SshUserCertificates.UpdateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"TlsCertificates.CreateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"TlsCertificates.DeleteCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"TlsCertificates.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"TlsCertificates.ListCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"TlsCertificates.UpdateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"Tunnels.ListCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"TunnelSessions.GetCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"TunnelSessions.ListCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"TunnelSessions.RestartCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"TunnelSessions.StopCallBuilder","l":"blockingCall()"},{"p":"com.ngrok.services","c":"TunnelSessions.UpdateCallBuilder","l":"blockingCall()"},{"p":"com.ngrok","c":"DefaultNgrokApiClient.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"AwsAuth.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"AwsCredentials.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"AwsRole.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EndpointCircuitBreaker.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EndpointCompression.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EndpointIpPolicyMutate.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EndpointLoggingMutate.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EndpointMutualTlsMutate.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EndpointOAuth.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthFacebook.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGitHub.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGoogle.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthMicrosoft.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthProvider.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EndpointOidc.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EndpointRequestHeaders.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EndpointResponseHeaders.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EndpointTlsTermination.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EndpointWebhookValidation.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EventSourceReplace.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EventTarget.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EventTargetCloudwatchLogs.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EventTargetFirehose.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"EventTargetKinesis.Builder","l":"build()"},{"p":"com.ngrok.definitions","c":"ReservedDomainCertPolicy.Builder","l":"build()"},{"p":"com.ngrok.services","c":"AbuseReports.CreateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"AbuseReports.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"AgentIngresses.CreateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"AgentIngresses.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"AgentIngresses.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"AgentIngresses.ListCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"AgentIngresses.UpdateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"ApiKeys.CreateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"ApiKeys.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"ApiKeys.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"ApiKeys.ListCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"ApiKeys.UpdateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"CertificateAuthorities.CreateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"CertificateAuthorities.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"CertificateAuthorities.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"CertificateAuthorities.ListCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"CertificateAuthorities.UpdateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"Credentials.CreateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"Credentials.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"Credentials.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"Credentials.ListCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"Credentials.UpdateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointCircuitBreakerModule.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointCircuitBreakerModule.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointCircuitBreakerModule.ReplaceCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointCompressionModule.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointCompressionModule.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointCompressionModule.ReplaceCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointConfigurations.CreateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointConfigurations.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointConfigurations.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointConfigurations.ListCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointConfigurations.UpdateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointIpPolicyModule.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointIpPolicyModule.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointIpPolicyModule.ReplaceCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointLoggingModule.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointLoggingModule.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointLoggingModule.ReplaceCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointMutualTlsModule.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointMutualTlsModule.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointMutualTlsModule.ReplaceCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointOAuthModule.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointOAuthModule.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointOAuthModule.ReplaceCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointOidcModule.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointOidcModule.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointOidcModule.ReplaceCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointRequestHeadersModule.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointRequestHeadersModule.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointRequestHeadersModule.ReplaceCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointResponseHeadersModule.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointResponseHeadersModule.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointResponseHeadersModule.ReplaceCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointSamlModule.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointSamlModule.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointSamlModule.ReplaceCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointTlsTerminationModule.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointTlsTerminationModule.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointTlsTerminationModule.ReplaceCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointWebhookValidationModule.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointWebhookValidationModule.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EndpointWebhookValidationModule.ReplaceCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EventDestinations.CreateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EventDestinations.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EventDestinations.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EventDestinations.ListCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EventDestinations.UpdateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EventSources.CreateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EventSources.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EventSources.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EventSources.ListCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EventSources.UpdateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EventStreams.CreateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EventStreams.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EventStreams.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EventStreams.ListCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EventStreams.UpdateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EventSubscriptions.CreateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EventSubscriptions.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EventSubscriptions.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EventSubscriptions.ListCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"EventSubscriptions.UpdateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"IpPolicies.CreateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"IpPolicies.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"IpPolicies.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"IpPolicies.ListCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"IpPolicies.UpdateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"IpPolicyRules.CreateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"IpPolicyRules.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"IpPolicyRules.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"IpPolicyRules.ListCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"IpPolicyRules.UpdateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"IpRestrictions.CreateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"IpRestrictions.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"IpRestrictions.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"IpRestrictions.ListCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"IpRestrictions.UpdateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"ReservedAddrs.CreateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"ReservedAddrs.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"ReservedAddrs.DeleteEndpointConfigCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"ReservedAddrs.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"ReservedAddrs.ListCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"ReservedAddrs.UpdateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"ReservedDomains.CreateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"ReservedDomains.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"ReservedDomains.DeleteCertificateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"ReservedDomains.DeleteCertificateManagementPolicyCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"ReservedDomains.DeleteHttpEndpointConfigCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"ReservedDomains.DeleteHttpsEndpointConfigCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"ReservedDomains.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"ReservedDomains.ListCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"ReservedDomains.UpdateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities.CreateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities.ListCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities.UpdateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"SshCredentials.CreateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"SshCredentials.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"SshCredentials.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"SshCredentials.ListCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"SshCredentials.UpdateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"SshHostCertificates.CreateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"SshHostCertificates.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"SshHostCertificates.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"SshHostCertificates.ListCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"SshHostCertificates.UpdateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"SshUserCertificates.CreateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"SshUserCertificates.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"SshUserCertificates.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"SshUserCertificates.ListCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"SshUserCertificates.UpdateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"TlsCertificates.CreateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"TlsCertificates.DeleteCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"TlsCertificates.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"TlsCertificates.ListCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"TlsCertificates.UpdateCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"Tunnels.ListCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"TunnelSessions.GetCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"TunnelSessions.ListCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"TunnelSessions.RestartCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"TunnelSessions.StopCallBuilder","l":"call()"},{"p":"com.ngrok.services","c":"TunnelSessions.UpdateCallBuilder","l":"call()"},{"p":"com.ngrok","c":"Ngrok","l":"certificateAuthorities()"},{"p":"com.ngrok.services","c":"CertificateAuthorities","l":"CertificateAuthorities(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.definitions","c":"CertificateAuthority","l":"CertificateAuthority(String, URI, OffsetDateTime, String, String, String, String, OffsetDateTime, OffsetDateTime, List, List)","u":"%3Cinit%3E(java.lang.String,java.net.URI,java.time.OffsetDateTime,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.time.OffsetDateTime,java.time.OffsetDateTime,java.util.List,java.util.List)"},{"p":"com.ngrok.definitions","c":"EndpointMutualTlsMutate.Builder","l":"certificateAuthorityIds(List)","u":"certificateAuthorityIds(java.util.List)"},{"p":"com.ngrok.definitions","c":"EndpointMutualTlsMutate.Builder","l":"certificateAuthorityIds(Optional>)","u":"certificateAuthorityIds(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"CertificateAuthorityList","l":"CertificateAuthorityList(List, URI, Optional)","u":"%3Cinit%3E(java.util.List,java.net.URI,java.util.Optional)"},{"p":"com.ngrok.services","c":"ReservedDomains.CreateCallBuilder","l":"certificateId(Optional)","u":"certificateId(java.util.Optional)"},{"p":"com.ngrok.services","c":"ReservedDomains.UpdateCallBuilder","l":"certificateId(Optional)","u":"certificateId(java.util.Optional)"},{"p":"com.ngrok.services","c":"ReservedDomains.CreateCallBuilder","l":"certificateId(String)","u":"certificateId(java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedDomains.UpdateCallBuilder","l":"certificateId(String)","u":"certificateId(java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedDomains.CreateCallBuilder","l":"certificateManagementPolicy(Optional)","u":"certificateManagementPolicy(java.util.Optional)"},{"p":"com.ngrok.services","c":"ReservedDomains.UpdateCallBuilder","l":"certificateManagementPolicy(Optional)","u":"certificateManagementPolicy(java.util.Optional)"},{"p":"com.ngrok.services","c":"ReservedDomains.CreateCallBuilder","l":"certificateManagementPolicy(ReservedDomainCertPolicy)","u":"certificateManagementPolicy(com.ngrok.definitions.ReservedDomainCertPolicy)"},{"p":"com.ngrok.services","c":"ReservedDomains.UpdateCallBuilder","l":"certificateManagementPolicy(ReservedDomainCertPolicy)","u":"certificateManagementPolicy(com.ngrok.definitions.ReservedDomainCertPolicy)"},{"p":"com.ngrok.services","c":"IpPolicyRules.UpdateCallBuilder","l":"cidr(Optional)","u":"cidr(java.util.Optional)"},{"p":"com.ngrok.services","c":"IpPolicyRules.UpdateCallBuilder","l":"cidr(String)","u":"cidr(java.lang.String)"},{"p":"com.ngrok","c":"Ngrok.PointcfgModuleNamespace","l":"circuitBreaker()"},{"p":"com.ngrok.services","c":"EndpointConfigurations.CreateCallBuilder","l":"circuitBreaker(EndpointCircuitBreaker)","u":"circuitBreaker(com.ngrok.definitions.EndpointCircuitBreaker)"},{"p":"com.ngrok.services","c":"EndpointConfigurations.UpdateCallBuilder","l":"circuitBreaker(EndpointCircuitBreaker)","u":"circuitBreaker(com.ngrok.definitions.EndpointCircuitBreaker)"},{"p":"com.ngrok.services","c":"EndpointConfigurations.CreateCallBuilder","l":"circuitBreaker(Optional)","u":"circuitBreaker(java.util.Optional)"},{"p":"com.ngrok.services","c":"EndpointConfigurations.UpdateCallBuilder","l":"circuitBreaker(Optional)","u":"circuitBreaker(java.util.Optional)"},{"p":"com.ngrok","c":"Version","l":"CLIENT_VERSION"},{"p":"com.ngrok.definitions","c":"EndpointOAuthFacebook.Builder","l":"clientId(Optional)","u":"clientId(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGitHub.Builder","l":"clientId(Optional)","u":"clientId(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGoogle.Builder","l":"clientId(Optional)","u":"clientId(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthMicrosoft.Builder","l":"clientId(Optional)","u":"clientId(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOidc.Builder","l":"clientId(Optional)","u":"clientId(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthFacebook.Builder","l":"clientId(String)","u":"clientId(java.lang.String)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGitHub.Builder","l":"clientId(String)","u":"clientId(java.lang.String)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGoogle.Builder","l":"clientId(String)","u":"clientId(java.lang.String)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthMicrosoft.Builder","l":"clientId(String)","u":"clientId(java.lang.String)"},{"p":"com.ngrok.definitions","c":"EndpointOidc.Builder","l":"clientId(String)","u":"clientId(java.lang.String)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthFacebook.Builder","l":"clientSecret(Optional)","u":"clientSecret(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGitHub.Builder","l":"clientSecret(Optional)","u":"clientSecret(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGoogle.Builder","l":"clientSecret(Optional)","u":"clientSecret(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthMicrosoft.Builder","l":"clientSecret(Optional)","u":"clientSecret(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOidc.Builder","l":"clientSecret(Optional)","u":"clientSecret(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthFacebook.Builder","l":"clientSecret(String)","u":"clientSecret(java.lang.String)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGitHub.Builder","l":"clientSecret(String)","u":"clientSecret(java.lang.String)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGoogle.Builder","l":"clientSecret(String)","u":"clientSecret(java.lang.String)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthMicrosoft.Builder","l":"clientSecret(String)","u":"clientSecret(java.lang.String)"},{"p":"com.ngrok.definitions","c":"EndpointOidc.Builder","l":"clientSecret(String)","u":"clientSecret(java.lang.String)"},{"p":"com.ngrok.definitions","c":"EventTarget.Builder","l":"cloudwatchLogs(EventTargetCloudwatchLogs)","u":"cloudwatchLogs(com.ngrok.definitions.EventTargetCloudwatchLogs)"},{"p":"com.ngrok.definitions","c":"EventTarget.Builder","l":"cloudwatchLogs(Optional)","u":"cloudwatchLogs(java.util.Optional)"},{"p":"com.ngrok","c":"Ngrok.PointcfgModuleNamespace","l":"compression()"},{"p":"com.ngrok.services","c":"EndpointConfigurations.CreateCallBuilder","l":"compression(EndpointCompression)","u":"compression(com.ngrok.definitions.EndpointCompression)"},{"p":"com.ngrok.services","c":"EndpointConfigurations.UpdateCallBuilder","l":"compression(EndpointCompression)","u":"compression(com.ngrok.definitions.EndpointCompression)"},{"p":"com.ngrok.services","c":"EndpointConfigurations.CreateCallBuilder","l":"compression(Optional)","u":"compression(java.util.Optional)"},{"p":"com.ngrok.services","c":"EndpointConfigurations.UpdateCallBuilder","l":"compression(Optional)","u":"compression(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOAuth.Builder","l":"cookiePrefix(Optional)","u":"cookiePrefix(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOidc.Builder","l":"cookiePrefix(Optional)","u":"cookiePrefix(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate.Builder","l":"cookiePrefix(Optional)","u":"cookiePrefix(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOAuth.Builder","l":"cookiePrefix(String)","u":"cookiePrefix(java.lang.String)"},{"p":"com.ngrok.definitions","c":"EndpointOidc.Builder","l":"cookiePrefix(String)","u":"cookiePrefix(java.lang.String)"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate.Builder","l":"cookiePrefix(String)","u":"cookiePrefix(java.lang.String)"},{"p":"com.ngrok.services","c":"ApiKeys","l":"create()"},{"p":"com.ngrok.services","c":"Credentials","l":"create()"},{"p":"com.ngrok.services","c":"EndpointConfigurations","l":"create()"},{"p":"com.ngrok.services","c":"EventDestinations","l":"create()"},{"p":"com.ngrok.services","c":"EventStreams","l":"create()"},{"p":"com.ngrok.services","c":"EventSubscriptions","l":"create()"},{"p":"com.ngrok.services","c":"ReservedAddrs","l":"create()"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities","l":"create()"},{"p":"com.ngrok.services","c":"AbuseReports","l":"create(List)","u":"create(java.util.List)"},{"p":"com.ngrok.services","c":"AgentIngresses","l":"create(String)","u":"create(java.lang.String)"},{"p":"com.ngrok.services","c":"CertificateAuthorities","l":"create(String)","u":"create(java.lang.String)"},{"p":"com.ngrok.services","c":"EventSources","l":"create(String)","u":"create(java.lang.String)"},{"p":"com.ngrok.services","c":"IpPolicies","l":"create(String)","u":"create(java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedDomains","l":"create(String)","u":"create(java.lang.String)"},{"p":"com.ngrok.services","c":"SshCredentials","l":"create(String)","u":"create(java.lang.String)"},{"p":"com.ngrok.services","c":"IpRestrictions","l":"create(String, List)","u":"create(java.lang.String,java.util.List)"},{"p":"com.ngrok.services","c":"IpPolicyRules","l":"create(String, String)","u":"create(java.lang.String,java.lang.String)"},{"p":"com.ngrok.services","c":"SshHostCertificates","l":"create(String, String)","u":"create(java.lang.String,java.lang.String)"},{"p":"com.ngrok.services","c":"SshUserCertificates","l":"create(String, String)","u":"create(java.lang.String,java.lang.String)"},{"p":"com.ngrok.services","c":"TlsCertificates","l":"create(String, String)","u":"create(java.lang.String,java.lang.String)"},{"p":"com.ngrok","c":"Ngrok","l":"createDefault()"},{"p":"com.ngrok","c":"Ngrok","l":"createDefault(String)","u":"createDefault(java.lang.String)"},{"p":"com.ngrok.definitions","c":"Credential","l":"Credential(String, URI, OffsetDateTime, String, String, Optional, List)","u":"%3Cinit%3E(java.lang.String,java.net.URI,java.time.OffsetDateTime,java.lang.String,java.lang.String,java.util.Optional,java.util.List)"},{"p":"com.ngrok.definitions","c":"CredentialList","l":"CredentialList(List, URI, Optional)","u":"%3Cinit%3E(java.util.List,java.net.URI,java.util.Optional)"},{"p":"com.ngrok","c":"Ngrok","l":"credentials()"},{"p":"com.ngrok.services","c":"Credentials","l":"Credentials(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.definitions","c":"AwsAuth.Builder","l":"creds(AwsCredentials)","u":"creds(com.ngrok.definitions.AwsCredentials)"},{"p":"com.ngrok.definitions","c":"AwsAuth.Builder","l":"creds(Optional)","u":"creds(java.util.Optional)"},{"p":"com.ngrok.services","c":"SshUserCertificates.CreateCallBuilder","l":"criticalOptions(Map)","u":"criticalOptions(java.util.Map)"},{"p":"com.ngrok.services","c":"SshUserCertificates.CreateCallBuilder","l":"criticalOptions(Optional>)","u":"criticalOptions(java.util.Optional)"},{"p":"com.ngrok","c":"NgrokApiClient","l":"DEFAULT_BASE_URI"},{"p":"com.ngrok","c":"NgrokApiClient.HttpMethod","l":"DELETE"},{"p":"com.ngrok.services","c":"AgentIngresses","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"ApiKeys","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"CertificateAuthorities","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"Credentials","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointCircuitBreakerModule","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointCompressionModule","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointConfigurations","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointIpPolicyModule","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointLoggingModule","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointMutualTlsModule","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointOAuthModule","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointOidcModule","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointRequestHeadersModule","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointResponseHeadersModule","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointSamlModule","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointTlsTerminationModule","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointWebhookValidationModule","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"EventDestinations","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"EventStreams","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"EventSubscriptions","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"IpPolicies","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"IpPolicyRules","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"IpRestrictions","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedAddrs","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedDomains","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"SshCredentials","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"SshHostCertificates","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"SshUserCertificates","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"TlsCertificates","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"com.ngrok.services","c":"EventSources","l":"delete(String, String)","u":"delete(java.lang.String,java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedDomains","l":"deleteCertificate(String)","u":"deleteCertificate(java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedDomains","l":"deleteCertificateManagementPolicy(String)","u":"deleteCertificateManagementPolicy(java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedAddrs","l":"deleteEndpointConfig(String)","u":"deleteEndpointConfig(java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedDomains","l":"deleteHttpEndpointConfig(String)","u":"deleteHttpEndpointConfig(java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedDomains","l":"deleteHttpsEndpointConfig(String)","u":"deleteHttpsEndpointConfig(java.lang.String)"},{"p":"com.ngrok.definitions","c":"EventTargetFirehose.Builder","l":"deliveryStreamArn(Optional)","u":"deliveryStreamArn(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EventTargetFirehose.Builder","l":"deliveryStreamArn(String)","u":"deliveryStreamArn(java.lang.String)"},{"p":"com.ngrok.services","c":"AgentIngresses.CreateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"AgentIngresses.UpdateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"ApiKeys.CreateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"ApiKeys.UpdateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"CertificateAuthorities.CreateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"CertificateAuthorities.UpdateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"Credentials.CreateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"Credentials.UpdateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"EndpointConfigurations.CreateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"EndpointConfigurations.UpdateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"EventDestinations.CreateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"EventDestinations.UpdateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"EventStreams.CreateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"EventStreams.UpdateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"EventSubscriptions.CreateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"EventSubscriptions.UpdateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"IpPolicies.CreateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"IpPolicies.UpdateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"IpPolicyRules.CreateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"IpPolicyRules.UpdateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"IpRestrictions.CreateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"IpRestrictions.UpdateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"ReservedAddrs.CreateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"ReservedAddrs.UpdateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"ReservedDomains.CreateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"ReservedDomains.UpdateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities.CreateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities.UpdateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"SshCredentials.CreateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"SshCredentials.UpdateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"SshHostCertificates.CreateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"SshHostCertificates.UpdateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"SshUserCertificates.CreateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"SshUserCertificates.UpdateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"TlsCertificates.CreateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"TlsCertificates.UpdateCallBuilder","l":"description(Optional)","u":"description(java.util.Optional)"},{"p":"com.ngrok.services","c":"AgentIngresses.CreateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"AgentIngresses.UpdateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"ApiKeys.CreateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"ApiKeys.UpdateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"CertificateAuthorities.CreateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"CertificateAuthorities.UpdateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"Credentials.CreateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"Credentials.UpdateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointConfigurations.CreateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointConfigurations.UpdateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"EventDestinations.CreateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"EventDestinations.UpdateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"EventStreams.CreateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"EventStreams.UpdateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"EventSubscriptions.CreateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"EventSubscriptions.UpdateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"IpPolicies.CreateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"IpPolicies.UpdateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"IpPolicyRules.CreateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"IpPolicyRules.UpdateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"IpRestrictions.CreateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"IpRestrictions.UpdateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedAddrs.CreateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedAddrs.UpdateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedDomains.CreateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedDomains.UpdateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities.CreateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities.UpdateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"SshCredentials.CreateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"SshCredentials.UpdateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"SshHostCertificates.CreateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"SshHostCertificates.UpdateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"SshUserCertificates.CreateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"SshUserCertificates.UpdateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"TlsCertificates.CreateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"TlsCertificates.UpdateCallBuilder","l":"description(String)","u":"description(java.lang.String)"},{"p":"com.ngrok.services","c":"EventStreams.CreateCallBuilder","l":"destinationIds(List)","u":"destinationIds(java.util.List)"},{"p":"com.ngrok.services","c":"EventStreams.UpdateCallBuilder","l":"destinationIds(List)","u":"destinationIds(java.util.List)"},{"p":"com.ngrok.services","c":"EventSubscriptions.CreateCallBuilder","l":"destinationIds(List)","u":"destinationIds(java.util.List)"},{"p":"com.ngrok.services","c":"EventSubscriptions.UpdateCallBuilder","l":"destinationIds(List)","u":"destinationIds(java.util.List)"},{"p":"com.ngrok.services","c":"EventStreams.CreateCallBuilder","l":"destinationIds(Optional>)","u":"destinationIds(java.util.Optional)"},{"p":"com.ngrok.services","c":"EventStreams.UpdateCallBuilder","l":"destinationIds(Optional>)","u":"destinationIds(java.util.Optional)"},{"p":"com.ngrok.services","c":"EventSubscriptions.CreateCallBuilder","l":"destinationIds(Optional>)","u":"destinationIds(java.util.Optional)"},{"p":"com.ngrok.services","c":"EventSubscriptions.UpdateCallBuilder","l":"destinationIds(Optional>)","u":"destinationIds(java.util.Optional)"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities.CreateCallBuilder","l":"ellipticCurve(Optional)","u":"ellipticCurve(java.util.Optional)"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities.CreateCallBuilder","l":"ellipticCurve(String)","u":"ellipticCurve(java.lang.String)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthFacebook.Builder","l":"emailAddresses(List)","u":"emailAddresses(java.util.List)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGitHub.Builder","l":"emailAddresses(List)","u":"emailAddresses(java.util.List)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGoogle.Builder","l":"emailAddresses(List)","u":"emailAddresses(java.util.List)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthMicrosoft.Builder","l":"emailAddresses(List)","u":"emailAddresses(java.util.List)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthFacebook.Builder","l":"emailAddresses(Optional>)","u":"emailAddresses(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGitHub.Builder","l":"emailAddresses(Optional>)","u":"emailAddresses(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGoogle.Builder","l":"emailAddresses(Optional>)","u":"emailAddresses(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthMicrosoft.Builder","l":"emailAddresses(Optional>)","u":"emailAddresses(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthFacebook.Builder","l":"emailDomains(List)","u":"emailDomains(java.util.List)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGitHub.Builder","l":"emailDomains(List)","u":"emailDomains(java.util.List)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGoogle.Builder","l":"emailDomains(List)","u":"emailDomains(java.util.List)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthMicrosoft.Builder","l":"emailDomains(List)","u":"emailDomains(java.util.List)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthFacebook.Builder","l":"emailDomains(Optional>)","u":"emailDomains(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGitHub.Builder","l":"emailDomains(Optional>)","u":"emailDomains(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGoogle.Builder","l":"emailDomains(Optional>)","u":"emailDomains(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthMicrosoft.Builder","l":"emailDomains(Optional>)","u":"emailDomains(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointCircuitBreaker.Builder","l":"enabled(boolean)"},{"p":"com.ngrok.definitions","c":"EndpointCompression.Builder","l":"enabled(boolean)"},{"p":"com.ngrok.definitions","c":"EndpointIpPolicyMutate.Builder","l":"enabled(boolean)"},{"p":"com.ngrok.definitions","c":"EndpointLoggingMutate.Builder","l":"enabled(boolean)"},{"p":"com.ngrok.definitions","c":"EndpointMutualTlsMutate.Builder","l":"enabled(boolean)"},{"p":"com.ngrok.definitions","c":"EndpointOAuth.Builder","l":"enabled(boolean)"},{"p":"com.ngrok.definitions","c":"EndpointOidc.Builder","l":"enabled(boolean)"},{"p":"com.ngrok.definitions","c":"EndpointRequestHeaders.Builder","l":"enabled(boolean)"},{"p":"com.ngrok.definitions","c":"EndpointResponseHeaders.Builder","l":"enabled(boolean)"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate.Builder","l":"enabled(boolean)"},{"p":"com.ngrok.definitions","c":"EndpointTlsTermination.Builder","l":"enabled(boolean)"},{"p":"com.ngrok.definitions","c":"EndpointWebhookValidation.Builder","l":"enabled(boolean)"},{"p":"com.ngrok.definitions","c":"EndpointCircuitBreaker.Builder","l":"enabled(Optional)","u":"enabled(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointCompression.Builder","l":"enabled(Optional)","u":"enabled(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointIpPolicyMutate.Builder","l":"enabled(Optional)","u":"enabled(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointLoggingMutate.Builder","l":"enabled(Optional)","u":"enabled(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointMutualTlsMutate.Builder","l":"enabled(Optional)","u":"enabled(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOAuth.Builder","l":"enabled(Optional)","u":"enabled(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOidc.Builder","l":"enabled(Optional)","u":"enabled(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointRequestHeaders.Builder","l":"enabled(Optional)","u":"enabled(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointResponseHeaders.Builder","l":"enabled(Optional)","u":"enabled(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate.Builder","l":"enabled(Optional)","u":"enabled(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointTlsTermination.Builder","l":"enabled(Optional)","u":"enabled(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointWebhookValidation.Builder","l":"enabled(Optional)","u":"enabled(java.util.Optional)"},{"p":"com.ngrok.services","c":"EndpointCircuitBreakerModule","l":"EndpointCircuitBreakerModule(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.services","c":"EndpointCompressionModule","l":"EndpointCompressionModule(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.definitions","c":"EndpointConfiguration","l":"EndpointConfiguration(String, String, String, String, OffsetDateTime, URI, Optional, Optional, Optional, Optional, Optional, Optional, Optional, Optional, Optional, Optional, Optional, Optional)","u":"%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.time.OffsetDateTime,java.net.URI,java.util.Optional,java.util.Optional,java.util.Optional,java.util.Optional,java.util.Optional,java.util.Optional,java.util.Optional,java.util.Optional,java.util.Optional,java.util.Optional,java.util.Optional,java.util.Optional)"},{"p":"com.ngrok.services","c":"ReservedAddrs.CreateCallBuilder","l":"endpointConfigurationId(Optional)","u":"endpointConfigurationId(java.util.Optional)"},{"p":"com.ngrok.services","c":"ReservedAddrs.UpdateCallBuilder","l":"endpointConfigurationId(Optional)","u":"endpointConfigurationId(java.util.Optional)"},{"p":"com.ngrok.services","c":"ReservedAddrs.CreateCallBuilder","l":"endpointConfigurationId(String)","u":"endpointConfigurationId(java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedAddrs.UpdateCallBuilder","l":"endpointConfigurationId(String)","u":"endpointConfigurationId(java.lang.String)"},{"p":"com.ngrok.definitions","c":"EndpointConfigurationList","l":"EndpointConfigurationList(List, URI, Optional)","u":"%3Cinit%3E(java.util.List,java.net.URI,java.util.Optional)"},{"p":"com.ngrok","c":"Ngrok","l":"endpointConfigurations()"},{"p":"com.ngrok.services","c":"EndpointConfigurations","l":"EndpointConfigurations(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.definitions","c":"EndpointIpPolicy","l":"EndpointIpPolicy(Optional, List[)","u":"%3Cinit%3E(java.util.Optional,java.util.List)"},{"p":"com.ngrok.services","c":"EndpointIpPolicyModule","l":"EndpointIpPolicyModule(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.definitions","c":"EndpointLogging","l":"EndpointLogging(Optional], List[)","u":"%3Cinit%3E(java.util.Optional,java.util.List)"},{"p":"com.ngrok.services","c":"EndpointLoggingModule","l":"EndpointLoggingModule(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.definitions","c":"EndpointMutualTls","l":"EndpointMutualTls(Optional], List[)","u":"%3Cinit%3E(java.util.Optional,java.util.List)"},{"p":"com.ngrok.services","c":"EndpointMutualTlsModule","l":"EndpointMutualTlsModule(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.services","c":"EndpointOAuthModule","l":"EndpointOAuthModule(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.services","c":"EndpointOidcModule","l":"EndpointOidcModule(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.services","c":"EndpointRequestHeadersModule","l":"EndpointRequestHeadersModule(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.services","c":"EndpointResponseHeadersModule","l":"EndpointResponseHeadersModule(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.definitions","c":"EndpointSaml","l":"EndpointSaml(Optional], Boolean, String, Long, Duration, String, Boolean, Optional, List, String, URI, URI, String, URI, String)","u":"%3Cinit%3E(java.util.Optional,java.lang.Boolean,java.lang.String,java.lang.Long,java.time.Duration,java.lang.String,java.lang.Boolean,java.util.Optional,java.util.List,java.lang.String,java.net.URI,java.net.URI,java.lang.String,java.net.URI,java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointSamlModule","l":"EndpointSamlModule(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.services","c":"EndpointTlsTerminationModule","l":"EndpointTlsTerminationModule(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.services","c":"EndpointWebhookValidationModule","l":"EndpointWebhookValidationModule(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.services","c":"IpRestrictions.CreateCallBuilder","l":"enforced(boolean)"},{"p":"com.ngrok.services","c":"IpRestrictions.UpdateCallBuilder","l":"enforced(boolean)"},{"p":"com.ngrok.services","c":"IpRestrictions.CreateCallBuilder","l":"enforced(Optional)","u":"enforced(java.util.Optional)"},{"p":"com.ngrok.services","c":"IpRestrictions.UpdateCallBuilder","l":"enforced(Optional)","u":"enforced(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"AbuseReport","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"AbuseReportHostname","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"AgentIngress","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"AgentIngressList","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"ApiKey","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"ApiKeyList","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"AwsAuth","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"AwsCredentials","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"AwsRole","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"CertificateAuthority","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"CertificateAuthorityList","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"Credential","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"CredentialList","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointCircuitBreaker","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointCompression","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointConfiguration","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointConfigurationList","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointIpPolicy","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointIpPolicyMutate","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointLogging","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointLoggingMutate","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointMutualTls","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointMutualTlsMutate","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointOAuth","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthFacebook","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGitHub","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGoogle","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthMicrosoft","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthProvider","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointOidc","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointRequestHeaders","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointResponseHeaders","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointSaml","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointTlsTermination","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointWebhookValidation","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EventDestination","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EventDestinationList","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EventSource","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EventSourceList","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EventSourceReplace","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EventStream","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EventStreamList","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EventSubscription","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EventSubscriptionList","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EventTarget","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EventTargetCloudwatchLogs","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EventTargetFirehose","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EventTargetKinesis","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"IpPolicy","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"IpPolicyList","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"IpPolicyRule","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"IpPolicyRuleList","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"IpRestriction","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"IpRestrictionList","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"Ref","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"ReservedAddr","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"ReservedAddrList","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"ReservedDomain","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"ReservedDomainCertJob","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"ReservedDomainCertPolicy","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"ReservedDomainCertStatus","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"ReservedDomainList","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"SshCertificateAuthority","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"SshCertificateAuthorityList","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"SshCredential","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"SshCredentialList","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"SshHostCertificate","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"SshHostCertificateList","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"SshUserCertificate","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"SshUserCertificateList","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"TlsCertificateList","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"TlsCertificateSaNs","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"Tunnel","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"TunnelList","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"TunnelSession","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"TunnelSessionList","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"com.ngrok.definitions","c":"EndpointCircuitBreaker.Builder","l":"errorThresholdPercentage(double)"},{"p":"com.ngrok.definitions","c":"EndpointCircuitBreaker.Builder","l":"errorThresholdPercentage(Optional)","u":"errorThresholdPercentage(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EventDestination","l":"EventDestination(String, String, OffsetDateTime, String, String, EventTarget, URI)","u":"%3Cinit%3E(java.lang.String,java.lang.String,java.time.OffsetDateTime,java.lang.String,java.lang.String,com.ngrok.definitions.EventTarget,java.net.URI)"},{"p":"com.ngrok.definitions","c":"EventDestinationList","l":"EventDestinationList(List, URI, Optional)","u":"%3Cinit%3E(java.util.List,java.net.URI,java.util.Optional)"},{"p":"com.ngrok","c":"Ngrok","l":"eventDestinations()"},{"p":"com.ngrok.services","c":"EventDestinations","l":"EventDestinations(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.definitions","c":"EventSource","l":"EventSource(String, URI)","u":"%3Cinit%3E(java.lang.String,java.net.URI)"},{"p":"com.ngrok.definitions","c":"EventSourceList","l":"EventSourceList(List, URI)","u":"%3Cinit%3E(java.util.List,java.net.URI)"},{"p":"com.ngrok","c":"Ngrok","l":"eventSources()"},{"p":"com.ngrok.services","c":"EventSources","l":"EventSources(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.definitions","c":"EventStream","l":"EventStream(String, URI, OffsetDateTime, String, String, List, String, List, Double)","u":"%3Cinit%3E(java.lang.String,java.net.URI,java.time.OffsetDateTime,java.lang.String,java.lang.String,java.util.List,java.lang.String,java.util.List,java.lang.Double)"},{"p":"com.ngrok.definitions","c":"EndpointLoggingMutate.Builder","l":"eventStreamIds(List)","u":"eventStreamIds(java.util.List)"},{"p":"com.ngrok.definitions","c":"EndpointLoggingMutate.Builder","l":"eventStreamIds(Optional>)","u":"eventStreamIds(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EventStreamList","l":"EventStreamList(List, URI, Optional)","u":"%3Cinit%3E(java.util.List,java.net.URI,java.util.Optional)"},{"p":"com.ngrok","c":"Ngrok","l":"eventStreams()"},{"p":"com.ngrok.services","c":"EventStreams","l":"EventStreams(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.definitions","c":"EventSubscription","l":"EventSubscription(String, URI, OffsetDateTime, String, String, List, List[)","u":"%3Cinit%3E(java.lang.String,java.net.URI,java.time.OffsetDateTime,java.lang.String,java.lang.String,java.util.List,java.util.List)"},{"p":"com.ngrok.definitions","c":"EventSubscriptionList","l":"EventSubscriptionList(List], URI, Optional)","u":"%3Cinit%3E(java.util.List,java.net.URI,java.util.Optional)"},{"p":"com.ngrok","c":"Ngrok","l":"eventSubscriptions()"},{"p":"com.ngrok.services","c":"EventSubscriptions","l":"EventSubscriptions(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.services","c":"EventStreams.CreateCallBuilder","l":"eventType(Optional)","u":"eventType(java.util.Optional)"},{"p":"com.ngrok.services","c":"EventStreams.CreateCallBuilder","l":"eventType(String)","u":"eventType(java.lang.String)"},{"p":"com.ngrok.services","c":"SshUserCertificates.CreateCallBuilder","l":"extensions(Map)","u":"extensions(java.util.Map)"},{"p":"com.ngrok.services","c":"SshUserCertificates.CreateCallBuilder","l":"extensions(Optional>)","u":"extensions(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthProvider.Builder","l":"facebook(EndpointOAuthFacebook)","u":"facebook(com.ngrok.definitions.EndpointOAuthFacebook)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthProvider.Builder","l":"facebook(Optional)","u":"facebook(java.util.Optional)"},{"p":"com.ngrok.services","c":"EventStreams.CreateCallBuilder","l":"fields(List)","u":"fields(java.util.List)"},{"p":"com.ngrok.services","c":"EventStreams.UpdateCallBuilder","l":"fields(List)","u":"fields(java.util.List)"},{"p":"com.ngrok.services","c":"EventStreams.CreateCallBuilder","l":"fields(Optional>)","u":"fields(java.util.Optional)"},{"p":"com.ngrok.services","c":"EventStreams.UpdateCallBuilder","l":"fields(Optional>)","u":"fields(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EventTarget.Builder","l":"firehose(EventTargetFirehose)","u":"firehose(com.ngrok.definitions.EventTargetFirehose)"},{"p":"com.ngrok.definitions","c":"EventTarget.Builder","l":"firehose(Optional)","u":"firehose(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate.Builder","l":"forceAuthn(boolean)"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate.Builder","l":"forceAuthn(Optional)","u":"forceAuthn(java.util.Optional)"},{"p":"com.ngrok.services","c":"EventDestinations.CreateCallBuilder","l":"format(Optional)","u":"format(java.util.Optional)"},{"p":"com.ngrok.services","c":"EventDestinations.UpdateCallBuilder","l":"format(Optional)","u":"format(java.util.Optional)"},{"p":"com.ngrok.services","c":"EventDestinations.CreateCallBuilder","l":"format(String)","u":"format(java.lang.String)"},{"p":"com.ngrok.services","c":"EventDestinations.UpdateCallBuilder","l":"format(String)","u":"format(java.lang.String)"},{"p":"com.ngrok","c":"NgrokApiClient.HttpMethod","l":"GET"},{"p":"com.ngrok.services","c":"AbuseReports","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"AgentIngresses","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"ApiKeys","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"CertificateAuthorities","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"Credentials","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointCircuitBreakerModule","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointCompressionModule","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointConfigurations","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointIpPolicyModule","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointLoggingModule","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointMutualTlsModule","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointOAuthModule","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointOidcModule","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointRequestHeadersModule","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointResponseHeadersModule","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointSamlModule","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointTlsTerminationModule","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"EndpointWebhookValidationModule","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"EventDestinations","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"EventStreams","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"EventSubscriptions","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"IpPolicies","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"IpPolicyRules","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"IpRestrictions","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedAddrs","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedDomains","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"SshCredentials","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"SshHostCertificates","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"SshUserCertificates","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"TlsCertificates","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"TunnelSessions","l":"get(String)","u":"get(java.lang.String)"},{"p":"com.ngrok.services","c":"EventSources","l":"get(String, String)","u":"get(java.lang.String,java.lang.String)"},{"p":"com.ngrok.definitions","c":"Credential","l":"getAcl()"},{"p":"com.ngrok.definitions","c":"SshCredential","l":"getAcl()"},{"p":"com.ngrok.definitions","c":"ReservedDomain","l":"getAcmeChallengeCnameTarget()"},{"p":"com.ngrok.definitions","c":"IpPolicy","l":"getAction()"},{"p":"com.ngrok.definitions","c":"EndpointRequestHeaders","l":"getAdd()"},{"p":"com.ngrok.definitions","c":"EndpointResponseHeaders","l":"getAdd()"},{"p":"com.ngrok.definitions","c":"ReservedAddr","l":"getAddr()"},{"p":"com.ngrok.definitions","c":"TunnelSession","l":"getAgentVersion()"},{"p":"com.ngrok.definitions","c":"EndpointSaml","l":"getAllowIdpInitiated()"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate","l":"getAllowIdpInitiated()"},{"p":"com.ngrok.definitions","c":"EndpointSaml","l":"getAssertionConsumerServiceUrl()"},{"p":"com.ngrok.definitions","c":"EventTargetCloudwatchLogs","l":"getAuth()"},{"p":"com.ngrok.definitions","c":"EventTargetFirehose","l":"getAuth()"},{"p":"com.ngrok.definitions","c":"EventTargetKinesis","l":"getAuth()"},{"p":"com.ngrok.definitions","c":"EndpointOAuth","l":"getAuthCheckInterval()"},{"p":"com.ngrok.definitions","c":"ReservedDomainCertPolicy","l":"getAuthority()"},{"p":"com.ngrok.definitions","c":"EndpointSaml","l":"getAuthorizedGroups()"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate","l":"getAuthorizedGroups()"},{"p":"com.ngrok.definitions","c":"AwsCredentials","l":"getAwsAccessKeyId()"},{"p":"com.ngrok.definitions","c":"AwsCredentials","l":"getAwsSecretAccessKey()"},{"p":"com.ngrok.definitions","c":"CertificateAuthority","l":"getCaPem()"},{"p":"com.ngrok.definitions","c":"ReservedDomain","l":"getCertificate()"},{"p":"com.ngrok.definitions","c":"SshHostCertificate","l":"getCertificate()"},{"p":"com.ngrok.definitions","c":"SshUserCertificate","l":"getCertificate()"},{"p":"com.ngrok.definitions","c":"CertificateAuthorityList","l":"getCertificateAuthorities()"},{"p":"com.ngrok.definitions","c":"EndpointMutualTls","l":"getCertificateAuthorities()"},{"p":"com.ngrok.definitions","c":"EndpointMutualTlsMutate","l":"getCertificateAuthorityIds()"},{"p":"com.ngrok.definitions","c":"ReservedDomain","l":"getCertificateManagementPolicy()"},{"p":"com.ngrok.definitions","c":"ReservedDomain","l":"getCertificateManagementStatus()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"getCertificatePem()"},{"p":"com.ngrok.definitions","c":"IpPolicyRule","l":"getCidr()"},{"p":"com.ngrok.definitions","c":"EndpointConfiguration","l":"getCircuitBreaker()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthFacebook","l":"getClientId()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGitHub","l":"getClientId()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGoogle","l":"getClientId()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthMicrosoft","l":"getClientId()"},{"p":"com.ngrok.definitions","c":"EndpointOidc","l":"getClientId()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthFacebook","l":"getClientSecret()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGitHub","l":"getClientSecret()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGoogle","l":"getClientSecret()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthMicrosoft","l":"getClientSecret()"},{"p":"com.ngrok.definitions","c":"EndpointOidc","l":"getClientSecret()"},{"p":"com.ngrok.definitions","c":"EventTarget","l":"getCloudwatchLogs()"},{"p":"com.ngrok.definitions","c":"ReservedDomain","l":"getCnameTarget()"},{"p":"com.ngrok.definitions","c":"EndpointConfiguration","l":"getCompression()"},{"p":"com.ngrok.definitions","c":"EndpointOAuth","l":"getCookiePrefix()"},{"p":"com.ngrok.definitions","c":"EndpointOidc","l":"getCookiePrefix()"},{"p":"com.ngrok.definitions","c":"EndpointSaml","l":"getCookiePrefix()"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate","l":"getCookiePrefix()"},{"p":"com.ngrok.definitions","c":"AbuseReport","l":"getCreatedAt()"},{"p":"com.ngrok.definitions","c":"AgentIngress","l":"getCreatedAt()"},{"p":"com.ngrok.definitions","c":"ApiKey","l":"getCreatedAt()"},{"p":"com.ngrok.definitions","c":"CertificateAuthority","l":"getCreatedAt()"},{"p":"com.ngrok.definitions","c":"Credential","l":"getCreatedAt()"},{"p":"com.ngrok.definitions","c":"EndpointConfiguration","l":"getCreatedAt()"},{"p":"com.ngrok.definitions","c":"EventDestination","l":"getCreatedAt()"},{"p":"com.ngrok.definitions","c":"EventStream","l":"getCreatedAt()"},{"p":"com.ngrok.definitions","c":"EventSubscription","l":"getCreatedAt()"},{"p":"com.ngrok.definitions","c":"IpPolicy","l":"getCreatedAt()"},{"p":"com.ngrok.definitions","c":"IpPolicyRule","l":"getCreatedAt()"},{"p":"com.ngrok.definitions","c":"IpRestriction","l":"getCreatedAt()"},{"p":"com.ngrok.definitions","c":"ReservedAddr","l":"getCreatedAt()"},{"p":"com.ngrok.definitions","c":"ReservedDomain","l":"getCreatedAt()"},{"p":"com.ngrok.definitions","c":"SshCertificateAuthority","l":"getCreatedAt()"},{"p":"com.ngrok.definitions","c":"SshCredential","l":"getCreatedAt()"},{"p":"com.ngrok.definitions","c":"SshHostCertificate","l":"getCreatedAt()"},{"p":"com.ngrok.definitions","c":"SshUserCertificate","l":"getCreatedAt()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"getCreatedAt()"},{"p":"com.ngrok.definitions","c":"TunnelSession","l":"getCredential()"},{"p":"com.ngrok.definitions","c":"CredentialList","l":"getCredentials()"},{"p":"com.ngrok.definitions","c":"AwsAuth","l":"getCreds()"},{"p":"com.ngrok.definitions","c":"SshUserCertificate","l":"getCriticalOptions()"},{"p":"com.ngrok.definitions","c":"EventTargetFirehose","l":"getDeliveryStreamArn()"},{"p":"com.ngrok.definitions","c":"AgentIngress","l":"getDescription()"},{"p":"com.ngrok.definitions","c":"ApiKey","l":"getDescription()"},{"p":"com.ngrok.definitions","c":"CertificateAuthority","l":"getDescription()"},{"p":"com.ngrok.definitions","c":"Credential","l":"getDescription()"},{"p":"com.ngrok.definitions","c":"EndpointConfiguration","l":"getDescription()"},{"p":"com.ngrok.definitions","c":"EventDestination","l":"getDescription()"},{"p":"com.ngrok.definitions","c":"EventStream","l":"getDescription()"},{"p":"com.ngrok.definitions","c":"EventSubscription","l":"getDescription()"},{"p":"com.ngrok.definitions","c":"IpPolicy","l":"getDescription()"},{"p":"com.ngrok.definitions","c":"IpPolicyRule","l":"getDescription()"},{"p":"com.ngrok.definitions","c":"IpRestriction","l":"getDescription()"},{"p":"com.ngrok.definitions","c":"ReservedAddr","l":"getDescription()"},{"p":"com.ngrok.definitions","c":"ReservedDomain","l":"getDescription()"},{"p":"com.ngrok.definitions","c":"SshCertificateAuthority","l":"getDescription()"},{"p":"com.ngrok.definitions","c":"SshCredential","l":"getDescription()"},{"p":"com.ngrok.definitions","c":"SshHostCertificate","l":"getDescription()"},{"p":"com.ngrok.definitions","c":"SshUserCertificate","l":"getDescription()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"getDescription()"},{"p":"com.ngrok.definitions","c":"EventStream","l":"getDestinationIds()"},{"p":"com.ngrok.definitions","c":"EventSubscription","l":"getDestinations()"},{"p":"com.ngrok.definitions","c":"NgrokApiError","l":"getDetails()"},{"p":"com.ngrok.definitions","c":"TlsCertificateSaNs","l":"getDnsNames()"},{"p":"com.ngrok.definitions","c":"AgentIngress","l":"getDomain()"},{"p":"com.ngrok.definitions","c":"ReservedDomain","l":"getDomain()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthFacebook","l":"getEmailAddresses()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGitHub","l":"getEmailAddresses()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGoogle","l":"getEmailAddresses()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthMicrosoft","l":"getEmailAddresses()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthFacebook","l":"getEmailDomains()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGitHub","l":"getEmailDomains()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGoogle","l":"getEmailDomains()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthMicrosoft","l":"getEmailDomains()"},{"p":"com.ngrok.definitions","c":"EndpointCircuitBreaker","l":"getEnabled()"},{"p":"com.ngrok.definitions","c":"EndpointCompression","l":"getEnabled()"},{"p":"com.ngrok.definitions","c":"EndpointIpPolicy","l":"getEnabled()"},{"p":"com.ngrok.definitions","c":"EndpointIpPolicyMutate","l":"getEnabled()"},{"p":"com.ngrok.definitions","c":"EndpointLogging","l":"getEnabled()"},{"p":"com.ngrok.definitions","c":"EndpointLoggingMutate","l":"getEnabled()"},{"p":"com.ngrok.definitions","c":"EndpointMutualTls","l":"getEnabled()"},{"p":"com.ngrok.definitions","c":"EndpointMutualTlsMutate","l":"getEnabled()"},{"p":"com.ngrok.definitions","c":"EndpointOAuth","l":"getEnabled()"},{"p":"com.ngrok.definitions","c":"EndpointOidc","l":"getEnabled()"},{"p":"com.ngrok.definitions","c":"EndpointRequestHeaders","l":"getEnabled()"},{"p":"com.ngrok.definitions","c":"EndpointResponseHeaders","l":"getEnabled()"},{"p":"com.ngrok.definitions","c":"EndpointSaml","l":"getEnabled()"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate","l":"getEnabled()"},{"p":"com.ngrok.definitions","c":"EndpointTlsTermination","l":"getEnabled()"},{"p":"com.ngrok.definitions","c":"EndpointWebhookValidation","l":"getEnabled()"},{"p":"com.ngrok.definitions","c":"ReservedAddr","l":"getEndpointConfiguration()"},{"p":"com.ngrok.definitions","c":"EndpointConfigurationList","l":"getEndpointConfigurations()"},{"p":"com.ngrok.definitions","c":"IpRestriction","l":"getEnforced()"},{"p":"com.ngrok.definitions","c":"EndpointSaml","l":"getEntityId()"},{"p":"com.ngrok.definitions","c":"NgrokApiError","l":"getErrorCode()"},{"p":"com.ngrok.definitions","c":"ReservedDomainCertJob","l":"getErrorCode()"},{"p":"com.ngrok.definitions","c":"EndpointCircuitBreaker","l":"getErrorThresholdPercentage()"},{"p":"com.ngrok.definitions","c":"EventDestinationList","l":"getEventDestinations()"},{"p":"com.ngrok.definitions","c":"EndpointLoggingMutate","l":"getEventStreamIds()"},{"p":"com.ngrok.definitions","c":"EndpointLogging","l":"getEventStreams()"},{"p":"com.ngrok.definitions","c":"EventStreamList","l":"getEventStreams()"},{"p":"com.ngrok.definitions","c":"EventSubscriptionList","l":"getEventSubscriptions()"},{"p":"com.ngrok.definitions","c":"EventStream","l":"getEventType()"},{"p":"com.ngrok.definitions","c":"CertificateAuthority","l":"getExtendedKeyUsages()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"getExtendedKeyUsages()"},{"p":"com.ngrok.definitions","c":"SshUserCertificate","l":"getExtensions()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthProvider","l":"getFacebook()"},{"p":"com.ngrok.definitions","c":"EventStream","l":"getFields()"},{"p":"com.ngrok.definitions","c":"EventTarget","l":"getFirehose()"},{"p":"com.ngrok.definitions","c":"EndpointSaml","l":"getForceAuthn()"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate","l":"getForceAuthn()"},{"p":"com.ngrok.definitions","c":"EventDestination","l":"getFormat()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthProvider","l":"getGithub()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthProvider","l":"getGoogle()"},{"p":"com.ngrok.definitions","c":"AbuseReportHostname","l":"getHostname()"},{"p":"com.ngrok.definitions","c":"AbuseReport","l":"getHostnames()"},{"p":"com.ngrok.definitions","c":"ReservedDomain","l":"getHttpEndpointConfiguration()"},{"p":"com.ngrok.definitions","c":"ReservedDomain","l":"getHttpsEndpointConfiguration()"},{"p":"com.ngrok.definitions","c":"NgrokApiError","l":"getHttpStatusCode()"},{"p":"com.ngrok.definitions","c":"AbuseReport","l":"getId()"},{"p":"com.ngrok.definitions","c":"AgentIngress","l":"getId()"},{"p":"com.ngrok.definitions","c":"ApiKey","l":"getId()"},{"p":"com.ngrok.definitions","c":"CertificateAuthority","l":"getId()"},{"p":"com.ngrok.definitions","c":"Credential","l":"getId()"},{"p":"com.ngrok.definitions","c":"EndpointConfiguration","l":"getId()"},{"p":"com.ngrok.definitions","c":"EventDestination","l":"getId()"},{"p":"com.ngrok.definitions","c":"EventStream","l":"getId()"},{"p":"com.ngrok.definitions","c":"EventSubscription","l":"getId()"},{"p":"com.ngrok.definitions","c":"IpPolicy","l":"getId()"},{"p":"com.ngrok.definitions","c":"IpPolicyRule","l":"getId()"},{"p":"com.ngrok.definitions","c":"IpRestriction","l":"getId()"},{"p":"com.ngrok.definitions","c":"Ref","l":"getId()"},{"p":"com.ngrok.definitions","c":"ReservedAddr","l":"getId()"},{"p":"com.ngrok.definitions","c":"ReservedDomain","l":"getId()"},{"p":"com.ngrok.definitions","c":"SshCertificateAuthority","l":"getId()"},{"p":"com.ngrok.definitions","c":"SshCredential","l":"getId()"},{"p":"com.ngrok.definitions","c":"SshHostCertificate","l":"getId()"},{"p":"com.ngrok.definitions","c":"SshUserCertificate","l":"getId()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"getId()"},{"p":"com.ngrok.definitions","c":"Tunnel","l":"getId()"},{"p":"com.ngrok.definitions","c":"TunnelSession","l":"getId()"},{"p":"com.ngrok.definitions","c":"EndpointSaml","l":"getIdpMetadata()"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate","l":"getIdpMetadata()"},{"p":"com.ngrok.definitions","c":"EndpointOAuth","l":"getInactivityTimeout()"},{"p":"com.ngrok.definitions","c":"EndpointOidc","l":"getInactivityTimeout()"},{"p":"com.ngrok.definitions","c":"EndpointSaml","l":"getInactivityTimeout()"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate","l":"getInactivityTimeout()"},{"p":"com.ngrok.definitions","c":"AgentIngressList","l":"getIngresses()"},{"p":"com.ngrok.definitions","c":"TunnelSession","l":"getIp()"},{"p":"com.ngrok.definitions","c":"EndpointIpPolicy","l":"getIpPolicies()"},{"p":"com.ngrok.definitions","c":"IpPolicyList","l":"getIpPolicies()"},{"p":"com.ngrok.definitions","c":"IpRestriction","l":"getIpPolicies()"},{"p":"com.ngrok.definitions","c":"EndpointConfiguration","l":"getIpPolicy()"},{"p":"com.ngrok.definitions","c":"IpPolicyRule","l":"getIpPolicy()"},{"p":"com.ngrok.definitions","c":"EndpointIpPolicyMutate","l":"getIpPolicyIds()"},{"p":"com.ngrok.definitions","c":"IpPolicyRuleList","l":"getIpPolicyRules()"},{"p":"com.ngrok.definitions","c":"IpRestrictionList","l":"getIpRestrictions()"},{"p":"com.ngrok.definitions","c":"TlsCertificateSaNs","l":"getIps()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"getIssuedAt()"},{"p":"com.ngrok.definitions","c":"EndpointOidc","l":"getIssuer()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"getIssuerCommonName()"},{"p":"com.ngrok.definitions","c":"ApiKeyList","l":"getKeys()"},{"p":"com.ngrok.definitions","c":"SshCertificateAuthority","l":"getKeyType()"},{"p":"com.ngrok.definitions","c":"SshHostCertificate","l":"getKeyType()"},{"p":"com.ngrok.definitions","c":"SshUserCertificate","l":"getKeyType()"},{"p":"com.ngrok.definitions","c":"CertificateAuthority","l":"getKeyUsages()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"getKeyUsages()"},{"p":"com.ngrok.definitions","c":"EventTarget","l":"getKinesis()"},{"p":"com.ngrok.definitions","c":"EndpointConfiguration","l":"getLogging()"},{"p":"com.ngrok.definitions","c":"EventTargetCloudwatchLogs","l":"getLogGroupArn()"},{"p":"com.ngrok.definitions","c":"EndpointOAuth","l":"getMaximumDuration()"},{"p":"com.ngrok.definitions","c":"EndpointOidc","l":"getMaximumDuration()"},{"p":"com.ngrok.definitions","c":"EndpointSaml","l":"getMaximumDuration()"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate","l":"getMaximumDuration()"},{"p":"com.ngrok.definitions","c":"AbuseReport","l":"getMetadata()"},{"p":"com.ngrok.definitions","c":"AgentIngress","l":"getMetadata()"},{"p":"com.ngrok.definitions","c":"ApiKey","l":"getMetadata()"},{"p":"com.ngrok.definitions","c":"CertificateAuthority","l":"getMetadata()"},{"p":"com.ngrok.definitions","c":"Credential","l":"getMetadata()"},{"p":"com.ngrok.definitions","c":"EndpointConfiguration","l":"getMetadata()"},{"p":"com.ngrok.definitions","c":"EventDestination","l":"getMetadata()"},{"p":"com.ngrok.definitions","c":"EventStream","l":"getMetadata()"},{"p":"com.ngrok.definitions","c":"EventSubscription","l":"getMetadata()"},{"p":"com.ngrok.definitions","c":"IpPolicy","l":"getMetadata()"},{"p":"com.ngrok.definitions","c":"IpPolicyRule","l":"getMetadata()"},{"p":"com.ngrok.definitions","c":"IpRestriction","l":"getMetadata()"},{"p":"com.ngrok.definitions","c":"ReservedAddr","l":"getMetadata()"},{"p":"com.ngrok.definitions","c":"ReservedDomain","l":"getMetadata()"},{"p":"com.ngrok.definitions","c":"SshCertificateAuthority","l":"getMetadata()"},{"p":"com.ngrok.definitions","c":"SshCredential","l":"getMetadata()"},{"p":"com.ngrok.definitions","c":"SshHostCertificate","l":"getMetadata()"},{"p":"com.ngrok.definitions","c":"SshUserCertificate","l":"getMetadata()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"getMetadata()"},{"p":"com.ngrok.definitions","c":"Tunnel","l":"getMetadata()"},{"p":"com.ngrok.definitions","c":"TunnelSession","l":"getMetadata()"},{"p":"com.ngrok.definitions","c":"EndpointSaml","l":"getMetadataUrl()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthProvider","l":"getMicrosoft()"},{"p":"com.ngrok.definitions","c":"EndpointTlsTermination","l":"getMinVersion()"},{"p":"com.ngrok.definitions","c":"ReservedDomainCertJob","l":"getMsg()"},{"p":"com.ngrok.definitions","c":"EndpointConfiguration","l":"getMutualTls()"},{"p":"com.ngrok.definitions","c":"EndpointSaml","l":"getNameidFormat()"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate","l":"getNameidFormat()"},{"p":"com.ngrok.definitions","c":"AgentIngressList","l":"getNextPageUri()"},{"p":"com.ngrok.definitions","c":"ApiKeyList","l":"getNextPageUri()"},{"p":"com.ngrok.definitions","c":"CertificateAuthorityList","l":"getNextPageUri()"},{"p":"com.ngrok.definitions","c":"CredentialList","l":"getNextPageUri()"},{"p":"com.ngrok.definitions","c":"EndpointConfigurationList","l":"getNextPageUri()"},{"p":"com.ngrok.definitions","c":"EventDestinationList","l":"getNextPageUri()"},{"p":"com.ngrok.definitions","c":"EventStreamList","l":"getNextPageUri()"},{"p":"com.ngrok.definitions","c":"EventSubscriptionList","l":"getNextPageUri()"},{"p":"com.ngrok.definitions","c":"IpPolicyList","l":"getNextPageUri()"},{"p":"com.ngrok.definitions","c":"IpPolicyRuleList","l":"getNextPageUri()"},{"p":"com.ngrok.definitions","c":"IpRestrictionList","l":"getNextPageUri()"},{"p":"com.ngrok.definitions","c":"Pageable","l":"getNextPageUri()"},{"p":"com.ngrok.definitions","c":"ReservedAddrList","l":"getNextPageUri()"},{"p":"com.ngrok.definitions","c":"ReservedDomainList","l":"getNextPageUri()"},{"p":"com.ngrok.definitions","c":"SshCertificateAuthorityList","l":"getNextPageUri()"},{"p":"com.ngrok.definitions","c":"SshCredentialList","l":"getNextPageUri()"},{"p":"com.ngrok.definitions","c":"SshHostCertificateList","l":"getNextPageUri()"},{"p":"com.ngrok.definitions","c":"SshUserCertificateList","l":"getNextPageUri()"},{"p":"com.ngrok.definitions","c":"TlsCertificateList","l":"getNextPageUri()"},{"p":"com.ngrok.definitions","c":"TunnelList","l":"getNextPageUri()"},{"p":"com.ngrok.definitions","c":"TunnelSessionList","l":"getNextPageUri()"},{"p":"com.ngrok.definitions","c":"CertificateAuthority","l":"getNotAfter()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"getNotAfter()"},{"p":"com.ngrok.definitions","c":"CertificateAuthority","l":"getNotBefore()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"getNotBefore()"},{"p":"com.ngrok.definitions","c":"AgentIngress","l":"getNsTargets()"},{"p":"com.ngrok.definitions","c":"EndpointCircuitBreaker","l":"getNumBuckets()"},{"p":"com.ngrok.definitions","c":"EndpointConfiguration","l":"getOauth()"},{"p":"com.ngrok.definitions","c":"EndpointConfiguration","l":"getOidc()"},{"p":"com.ngrok.definitions","c":"EndpointOAuth","l":"getOptionsPassthrough()"},{"p":"com.ngrok.definitions","c":"EndpointOidc","l":"getOptionsPassthrough()"},{"p":"com.ngrok.definitions","c":"EndpointSaml","l":"getOptionsPassthrough()"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate","l":"getOptionsPassthrough()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGitHub","l":"getOrganizations()"},{"p":"com.ngrok.definitions","c":"TunnelSession","l":"getOs()"},{"p":"com.ngrok.definitions","c":"Page","l":"getPage()"},{"p":"com.ngrok.definitions","c":"SshHostCertificate","l":"getPrincipals()"},{"p":"com.ngrok.definitions","c":"SshUserCertificate","l":"getPrincipals()"},{"p":"com.ngrok.definitions","c":"ReservedDomainCertPolicy","l":"getPrivateKeyType()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"getPrivateKeyType()"},{"p":"com.ngrok.definitions","c":"Tunnel","l":"getProto()"},{"p":"com.ngrok.definitions","c":"EndpointOAuth","l":"getProvider()"},{"p":"com.ngrok.definitions","c":"EndpointWebhookValidation","l":"getProvider()"},{"p":"com.ngrok.definitions","c":"ReservedDomainCertStatus","l":"getProvisioningJob()"},{"p":"com.ngrok.definitions","c":"SshCertificateAuthority","l":"getPublicKey()"},{"p":"com.ngrok.definitions","c":"SshCredential","l":"getPublicKey()"},{"p":"com.ngrok.definitions","c":"SshHostCertificate","l":"getPublicKey()"},{"p":"com.ngrok.definitions","c":"SshUserCertificate","l":"getPublicKey()"},{"p":"com.ngrok.definitions","c":"Tunnel","l":"getPublicUrl()"},{"p":"com.ngrok.definitions","c":"ReservedAddr","l":"getRegion()"},{"p":"com.ngrok.definitions","c":"ReservedDomain","l":"getRegion()"},{"p":"com.ngrok.definitions","c":"Tunnel","l":"getRegion()"},{"p":"com.ngrok.definitions","c":"TunnelSession","l":"getRegion()"},{"p":"com.ngrok.definitions","c":"AgentIngress","l":"getRegionDomains()"},{"p":"com.ngrok.definitions","c":"EndpointRequestHeaders","l":"getRemove()"},{"p":"com.ngrok.definitions","c":"EndpointResponseHeaders","l":"getRemove()"},{"p":"com.ngrok.definitions","c":"ReservedDomainCertStatus","l":"getRenewsAt()"},{"p":"com.ngrok.definitions","c":"EndpointConfiguration","l":"getRequestHeaders()"},{"p":"com.ngrok.definitions","c":"EndpointSaml","l":"getRequestSigningCertificatePem()"},{"p":"com.ngrok.definitions","c":"ReservedAddrList","l":"getReservedAddrs()"},{"p":"com.ngrok.definitions","c":"ReservedDomainList","l":"getReservedDomains()"},{"p":"com.ngrok.definitions","c":"EndpointConfiguration","l":"getResponseHeaders()"},{"p":"com.ngrok.definitions","c":"ReservedDomainCertJob","l":"getRetriesAt()"},{"p":"com.ngrok.definitions","c":"AwsAuth","l":"getRole()"},{"p":"com.ngrok.definitions","c":"AwsRole","l":"getRoleArn()"},{"p":"com.ngrok.definitions","c":"EndpointCircuitBreaker","l":"getRollingWindow()"},{"p":"com.ngrok.definitions","c":"EndpointConfiguration","l":"getSaml()"},{"p":"com.ngrok.definitions","c":"EventStream","l":"getSamplingRate()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthFacebook","l":"getScopes()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGitHub","l":"getScopes()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGoogle","l":"getScopes()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthMicrosoft","l":"getScopes()"},{"p":"com.ngrok.definitions","c":"EndpointOidc","l":"getScopes()"},{"p":"com.ngrok.definitions","c":"EndpointWebhookValidation","l":"getSecret()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"getSerialNumber()"},{"p":"com.ngrok.definitions","c":"EndpointSaml","l":"getSingleLogoutUrl()"},{"p":"com.ngrok.definitions","c":"EventSourceList","l":"getSources()"},{"p":"com.ngrok.definitions","c":"EventSubscription","l":"getSources()"},{"p":"com.ngrok.definitions","c":"SshCertificateAuthorityList","l":"getSshCertificateAuthorities()"},{"p":"com.ngrok.definitions","c":"SshHostCertificate","l":"getSshCertificateAuthorityId()"},{"p":"com.ngrok.definitions","c":"SshUserCertificate","l":"getSshCertificateAuthorityId()"},{"p":"com.ngrok.definitions","c":"SshCredentialList","l":"getSshCredentials()"},{"p":"com.ngrok.definitions","c":"SshHostCertificateList","l":"getSshHostCertificates()"},{"p":"com.ngrok.definitions","c":"SshUserCertificateList","l":"getSshUserCertificates()"},{"p":"com.ngrok.definitions","c":"ReservedDomainCertJob","l":"getStartedAt()"},{"p":"com.ngrok.definitions","c":"Tunnel","l":"getStartedAt()"},{"p":"com.ngrok.definitions","c":"TunnelSession","l":"getStartedAt()"},{"p":"com.ngrok.definitions","c":"AbuseReport","l":"getStatus()"},{"p":"com.ngrok.definitions","c":"AbuseReportHostname","l":"getStatus()"},{"p":"com.ngrok.definitions","c":"EventTargetKinesis","l":"getStreamArn()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"getSubjectAlternativeNames()"},{"p":"com.ngrok.definitions","c":"CertificateAuthority","l":"getSubjectCommonName()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"getSubjectCommonName()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"getSubjectCountry()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"getSubjectLocality()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"getSubjectOrganization()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"getSubjectOrganizationalUnit()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"getSubjectProvince()"},{"p":"com.ngrok.definitions","c":"EventDestination","l":"getTarget()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGitHub","l":"getTeams()"},{"p":"com.ngrok.definitions","c":"EndpointTlsTermination","l":"getTerminateAt()"},{"p":"com.ngrok.definitions","c":"TlsCertificateList","l":"getTlsCertificates()"},{"p":"com.ngrok.definitions","c":"EndpointConfiguration","l":"getTlsTermination()"},{"p":"com.ngrok.definitions","c":"ApiKey","l":"getToken()"},{"p":"com.ngrok.definitions","c":"Credential","l":"getToken()"},{"p":"com.ngrok.definitions","c":"TunnelSession","l":"getTransport()"},{"p":"com.ngrok.definitions","c":"EndpointCircuitBreaker","l":"getTrippedDuration()"},{"p":"com.ngrok.definitions","c":"TunnelList","l":"getTunnels()"},{"p":"com.ngrok.definitions","c":"Tunnel","l":"getTunnelSession()"},{"p":"com.ngrok.definitions","c":"TunnelSessionList","l":"getTunnelSessions()"},{"p":"com.ngrok.definitions","c":"EndpointConfiguration","l":"getType()"},{"p":"com.ngrok.definitions","c":"EventSource","l":"getType()"},{"p":"com.ngrok.definitions","c":"EventSourceReplace","l":"getType()"},{"p":"com.ngrok.definitions","c":"IpRestriction","l":"getType()"},{"p":"com.ngrok.definitions","c":"AbuseReport","l":"getUri()"},{"p":"com.ngrok.definitions","c":"AgentIngress","l":"getUri()"},{"p":"com.ngrok.definitions","c":"AgentIngressList","l":"getUri()"},{"p":"com.ngrok.definitions","c":"ApiKey","l":"getUri()"},{"p":"com.ngrok.definitions","c":"ApiKeyList","l":"getUri()"},{"p":"com.ngrok.definitions","c":"CertificateAuthority","l":"getUri()"},{"p":"com.ngrok.definitions","c":"CertificateAuthorityList","l":"getUri()"},{"p":"com.ngrok.definitions","c":"Credential","l":"getUri()"},{"p":"com.ngrok.definitions","c":"CredentialList","l":"getUri()"},{"p":"com.ngrok.definitions","c":"EndpointConfiguration","l":"getUri()"},{"p":"com.ngrok.definitions","c":"EndpointConfigurationList","l":"getUri()"},{"p":"com.ngrok.definitions","c":"EventDestination","l":"getUri()"},{"p":"com.ngrok.definitions","c":"EventDestinationList","l":"getUri()"},{"p":"com.ngrok.definitions","c":"EventSource","l":"getUri()"},{"p":"com.ngrok.definitions","c":"EventSourceList","l":"getUri()"},{"p":"com.ngrok.definitions","c":"EventStream","l":"getUri()"},{"p":"com.ngrok.definitions","c":"EventStreamList","l":"getUri()"},{"p":"com.ngrok.definitions","c":"EventSubscription","l":"getUri()"},{"p":"com.ngrok.definitions","c":"EventSubscriptionList","l":"getUri()"},{"p":"com.ngrok.definitions","c":"IpPolicy","l":"getUri()"},{"p":"com.ngrok.definitions","c":"IpPolicyList","l":"getUri()"},{"p":"com.ngrok.definitions","c":"IpPolicyRule","l":"getUri()"},{"p":"com.ngrok.definitions","c":"IpPolicyRuleList","l":"getUri()"},{"p":"com.ngrok.definitions","c":"IpRestriction","l":"getUri()"},{"p":"com.ngrok.definitions","c":"IpRestrictionList","l":"getUri()"},{"p":"com.ngrok.definitions","c":"Ref","l":"getUri()"},{"p":"com.ngrok.definitions","c":"ReservedAddr","l":"getUri()"},{"p":"com.ngrok.definitions","c":"ReservedAddrList","l":"getUri()"},{"p":"com.ngrok.definitions","c":"ReservedDomain","l":"getUri()"},{"p":"com.ngrok.definitions","c":"ReservedDomainList","l":"getUri()"},{"p":"com.ngrok.definitions","c":"SshCertificateAuthority","l":"getUri()"},{"p":"com.ngrok.definitions","c":"SshCertificateAuthorityList","l":"getUri()"},{"p":"com.ngrok.definitions","c":"SshCredential","l":"getUri()"},{"p":"com.ngrok.definitions","c":"SshCredentialList","l":"getUri()"},{"p":"com.ngrok.definitions","c":"SshHostCertificate","l":"getUri()"},{"p":"com.ngrok.definitions","c":"SshHostCertificateList","l":"getUri()"},{"p":"com.ngrok.definitions","c":"SshUserCertificate","l":"getUri()"},{"p":"com.ngrok.definitions","c":"SshUserCertificateList","l":"getUri()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"getUri()"},{"p":"com.ngrok.definitions","c":"TlsCertificateList","l":"getUri()"},{"p":"com.ngrok.definitions","c":"TunnelList","l":"getUri()"},{"p":"com.ngrok.definitions","c":"TunnelSession","l":"getUri()"},{"p":"com.ngrok.definitions","c":"TunnelSessionList","l":"getUri()"},{"p":"com.ngrok.definitions","c":"AbuseReport","l":"getUrls()"},{"p":"com.ngrok.definitions","c":"SshHostCertificate","l":"getValidAfter()"},{"p":"com.ngrok.definitions","c":"SshUserCertificate","l":"getValidAfter()"},{"p":"com.ngrok.definitions","c":"SshHostCertificate","l":"getValidUntil()"},{"p":"com.ngrok.definitions","c":"SshUserCertificate","l":"getValidUntil()"},{"p":"com.ngrok.definitions","c":"EndpointCircuitBreaker","l":"getVolumeThreshold()"},{"p":"com.ngrok.definitions","c":"EndpointConfiguration","l":"getWebhookValidation()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthProvider.Builder","l":"github(EndpointOAuthGitHub)","u":"github(com.ngrok.definitions.EndpointOAuthGitHub)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthProvider.Builder","l":"github(Optional)","u":"github(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthProvider.Builder","l":"google(EndpointOAuthGoogle)","u":"google(com.ngrok.definitions.EndpointOAuthGoogle)"},{"p":"com.ngrok.definitions","c":"EndpointOAuthProvider.Builder","l":"google(Optional)","u":"google(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"AbuseReport","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"AbuseReportHostname","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"AgentIngress","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"AgentIngressList","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"ApiKey","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"ApiKeyList","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"AwsAuth","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"AwsCredentials","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"AwsRole","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"CertificateAuthority","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"CertificateAuthorityList","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"Credential","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"CredentialList","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointCircuitBreaker","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointCompression","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointConfiguration","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointConfigurationList","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointIpPolicy","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointIpPolicyMutate","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointLogging","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointLoggingMutate","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointMutualTls","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointMutualTlsMutate","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointOAuth","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthFacebook","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGitHub","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthGoogle","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthMicrosoft","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointOAuthProvider","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointOidc","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointRequestHeaders","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointResponseHeaders","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointSaml","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointTlsTermination","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EndpointWebhookValidation","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EventDestination","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EventDestinationList","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EventSource","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EventSourceList","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EventSourceReplace","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EventStream","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EventStreamList","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EventSubscription","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EventSubscriptionList","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EventTarget","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EventTargetCloudwatchLogs","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EventTargetFirehose","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"EventTargetKinesis","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"IpPolicy","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"IpPolicyList","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"IpPolicyRule","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"IpPolicyRuleList","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"IpRestriction","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"IpRestrictionList","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"Ref","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"ReservedAddr","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"ReservedAddrList","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"ReservedDomain","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"ReservedDomainCertJob","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"ReservedDomainCertPolicy","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"ReservedDomainCertStatus","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"ReservedDomainList","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"SshCertificateAuthority","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"SshCertificateAuthorityList","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"SshCredential","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"SshCredentialList","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"SshHostCertificate","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"SshHostCertificateList","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"SshUserCertificate","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"SshUserCertificateList","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"TlsCertificate","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"TlsCertificateList","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"TlsCertificateSaNs","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"Tunnel","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"TunnelList","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"TunnelSession","l":"hashCode()"},{"p":"com.ngrok.definitions","c":"TunnelSessionList","l":"hashCode()"},{"p":"com.ngrok","c":"DefaultNgrokApiClient.Builder","l":"httpClient(Optional)","u":"httpClient(java.util.Optional)"},{"p":"com.ngrok","c":"DefaultNgrokApiClient.Builder","l":"httpClient(WebClient)","u":"httpClient(com.linecorp.armeria.client.WebClient)"},{"p":"com.ngrok.services","c":"ReservedDomains.CreateCallBuilder","l":"httpEndpointConfigurationId(Optional)","u":"httpEndpointConfigurationId(java.util.Optional)"},{"p":"com.ngrok.services","c":"ReservedDomains.UpdateCallBuilder","l":"httpEndpointConfigurationId(Optional)","u":"httpEndpointConfigurationId(java.util.Optional)"},{"p":"com.ngrok.services","c":"ReservedDomains.CreateCallBuilder","l":"httpEndpointConfigurationId(String)","u":"httpEndpointConfigurationId(java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedDomains.UpdateCallBuilder","l":"httpEndpointConfigurationId(String)","u":"httpEndpointConfigurationId(java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedDomains.CreateCallBuilder","l":"httpsEndpointConfigurationId(Optional)","u":"httpsEndpointConfigurationId(java.util.Optional)"},{"p":"com.ngrok.services","c":"ReservedDomains.UpdateCallBuilder","l":"httpsEndpointConfigurationId(Optional)","u":"httpsEndpointConfigurationId(java.util.Optional)"},{"p":"com.ngrok.services","c":"ReservedDomains.CreateCallBuilder","l":"httpsEndpointConfigurationId(String)","u":"httpsEndpointConfigurationId(java.lang.String)"},{"p":"com.ngrok.services","c":"ReservedDomains.UpdateCallBuilder","l":"httpsEndpointConfigurationId(String)","u":"httpsEndpointConfigurationId(java.lang.String)"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate.Builder","l":"idpMetadata(Optional)","u":"idpMetadata(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate.Builder","l":"idpMetadata(String)","u":"idpMetadata(java.lang.String)"},{"p":"com.ngrok.definitions","c":"EndpointOAuth.Builder","l":"inactivityTimeout(long)"},{"p":"com.ngrok.definitions","c":"EndpointOidc.Builder","l":"inactivityTimeout(long)"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate.Builder","l":"inactivityTimeout(long)"},{"p":"com.ngrok.definitions","c":"EndpointOAuth.Builder","l":"inactivityTimeout(Optional)","u":"inactivityTimeout(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOidc.Builder","l":"inactivityTimeout(Optional)","u":"inactivityTimeout(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointSamlMutate.Builder","l":"inactivityTimeout(Optional)","u":"inactivityTimeout(java.util.Optional)"},{"p":"com.ngrok","c":"Ngrok","l":"ipPolicies()"},{"p":"com.ngrok.services","c":"IpPolicies","l":"IpPolicies(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok","c":"Ngrok.PointcfgModuleNamespace","l":"ipPolicy()"},{"p":"com.ngrok.services","c":"EndpointConfigurations.CreateCallBuilder","l":"ipPolicy(EndpointIpPolicyMutate)","u":"ipPolicy(com.ngrok.definitions.EndpointIpPolicyMutate)"},{"p":"com.ngrok.services","c":"EndpointConfigurations.UpdateCallBuilder","l":"ipPolicy(EndpointIpPolicyMutate)","u":"ipPolicy(com.ngrok.definitions.EndpointIpPolicyMutate)"},{"p":"com.ngrok.services","c":"EndpointConfigurations.CreateCallBuilder","l":"ipPolicy(Optional)","u":"ipPolicy(java.util.Optional)"},{"p":"com.ngrok.services","c":"EndpointConfigurations.UpdateCallBuilder","l":"ipPolicy(Optional)","u":"ipPolicy(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"IpPolicy","l":"IpPolicy(String, URI, OffsetDateTime, String, String, String)","u":"%3Cinit%3E(java.lang.String,java.net.URI,java.time.OffsetDateTime,java.lang.String,java.lang.String,java.lang.String)"},{"p":"com.ngrok.definitions","c":"EndpointIpPolicyMutate.Builder","l":"ipPolicyIds(List)","u":"ipPolicyIds(java.util.List)"},{"p":"com.ngrok.services","c":"IpRestrictions.UpdateCallBuilder","l":"ipPolicyIds(List)","u":"ipPolicyIds(java.util.List)"},{"p":"com.ngrok.definitions","c":"EndpointIpPolicyMutate.Builder","l":"ipPolicyIds(Optional>)","u":"ipPolicyIds(java.util.Optional)"},{"p":"com.ngrok.services","c":"IpRestrictions.UpdateCallBuilder","l":"ipPolicyIds(Optional>)","u":"ipPolicyIds(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"IpPolicyList","l":"IpPolicyList(List, URI, Optional)","u":"%3Cinit%3E(java.util.List,java.net.URI,java.util.Optional)"},{"p":"com.ngrok.definitions","c":"IpPolicyRule","l":"IpPolicyRule(String, URI, OffsetDateTime, String, String, String, Ref)","u":"%3Cinit%3E(java.lang.String,java.net.URI,java.time.OffsetDateTime,java.lang.String,java.lang.String,java.lang.String,com.ngrok.definitions.Ref)"},{"p":"com.ngrok.definitions","c":"IpPolicyRuleList","l":"IpPolicyRuleList(List, URI, Optional)","u":"%3Cinit%3E(java.util.List,java.net.URI,java.util.Optional)"},{"p":"com.ngrok","c":"Ngrok","l":"ipPolicyRules()"},{"p":"com.ngrok.services","c":"IpPolicyRules","l":"IpPolicyRules(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.definitions","c":"IpRestriction","l":"IpRestriction(String, URI, OffsetDateTime, String, String, Boolean, String, List[)","u":"%3Cinit%3E(java.lang.String,java.net.URI,java.time.OffsetDateTime,java.lang.String,java.lang.String,java.lang.Boolean,java.lang.String,java.util.List)"},{"p":"com.ngrok.definitions","c":"IpRestrictionList","l":"IpRestrictionList(List], URI, Optional)","u":"%3Cinit%3E(java.util.List,java.net.URI,java.util.Optional)"},{"p":"com.ngrok","c":"Ngrok","l":"ipRestrictions()"},{"p":"com.ngrok.services","c":"IpRestrictions","l":"IpRestrictions(NgrokApiClient)","u":"%3Cinit%3E(com.ngrok.NgrokApiClient)"},{"p":"com.ngrok.definitions","c":"NgrokApiError","l":"isErrorCode(String...)","u":"isErrorCode(java.lang.String...)"},{"p":"com.ngrok.definitions","c":"EndpointOidc.Builder","l":"issuer(Optional)","u":"issuer(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EndpointOidc.Builder","l":"issuer(String)","u":"issuer(java.lang.String)"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities.CreateCallBuilder","l":"keySize(long)"},{"p":"com.ngrok.services","c":"SshCertificateAuthorities.CreateCallBuilder","l":"keySize(Optional)","u":"keySize(java.util.Optional)"},{"p":"com.ngrok.definitions","c":"EventTarget.Builder","l":"kinesis(EventTargetKinesis)","u":"kinesis(com.ngrok.definitions.EventTargetKinesis)"},{"p":"com.ngrok.definitions","c":"EventTarget.Builder","l":"kinesis(Optional)","u":"kinesis(java.util.Optional)"},{"p":"com.ngrok.services","c":"AgentIngresses.ListCallBuilder","l":"limit(Optional)","u":"limit(java.util.Optional)"},{"p":"com.ngrok.services","c":"ApiKeys.ListCallBuilder","l":"limit(Optional)","u":"limit(java.util.Optional)"},{"p":"com.ngrok.services","c":"CertificateAuthorities.ListCallBuilder","l":"limit(Optional)","u":"limit(java.util.Optional)"},{"p":"com.ngrok.services","c":"Credentials.ListCallBuilder","l":"limit(Optional)","u":"limit(java.util.Optional)"},{"p":"com.ngrok.services","c":"EndpointConfigurations.ListCallBuilder","l":"limit(Optional)","u":"limit(java.util.Optional)"},{"p":"com.ngrok.services","c":"EventDestinations.ListCallBuilder","l":"limit(Optional)","u":"limit(java.util.Optional)"},{"p":"com.ngrok.services","c":"EventStreams.ListCallBuilder","l":"limit(Optional)","u":"limit(java.util.Optional)"},{"p":"com.ngrok.services","c":"EventSubscriptions.ListCallBuilder","l":"limit(Optional)","u":"limit(java.util.Optional)"},{"p":"com.ngrok.services","c":"IpPolicies.ListCallBuilder","l":"limit(Optional)","u":"limit(java.util.Optional)"},{"p":"com.ngrok.services","c":"IpPolicyRules.ListCallBuilder","l":"limit(Optional)","u":"limit(java.util.Optional)"},{"p":"com.ngrok.services","c":"IpRestrictions.ListCallBuilder","l":"limit(Optional