Index
All Classes|All Packages|Constant Field Values|Serialized Form
A
- AbuseReport - Class in com.ngrok.definitions
-
A class encapsulating the
AbuseReportresource. - AbuseReport(String, URI, OffsetDateTime, List<URI>, String, String, List<AbuseReportHostname>) - Constructor for class com.ngrok.definitions.AbuseReport
-
Creates a new instance of
AbuseReport. - AbuseReportHostname - Class in com.ngrok.definitions
-
A class encapsulating the
AbuseReportHostnameresource. - AbuseReportHostname(String, String) - Constructor for class com.ngrok.definitions.AbuseReportHostname
-
Creates a new instance of
AbuseReportHostname. - abuseReports() - Method in class com.ngrok.Ngrok
-
Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.
- AbuseReports - Class in 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) - Constructor for class com.ngrok.services.AbuseReports
-
Creates a new sub-client for AbuseReports.
- AbuseReports.CreateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Create API call.
- AbuseReports.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- acl(List<String>) - Method in class com.ngrok.services.Credentials.CreateCallBuilder
-
optional list of ACL rules.
- acl(List<String>) - Method in class com.ngrok.services.Credentials.UpdateCallBuilder
-
optional list of ACL rules.
- acl(List<String>) - Method in class com.ngrok.services.SshCredentials.CreateCallBuilder
-
optional list of ACL rules.
- acl(List<String>) - Method in class com.ngrok.services.SshCredentials.UpdateCallBuilder
-
optional list of ACL rules.
- acl(Optional<List<String>>) - Method in class com.ngrok.services.Credentials.CreateCallBuilder
-
optional list of ACL rules.
- acl(Optional<List<String>>) - Method in class com.ngrok.services.Credentials.UpdateCallBuilder
-
optional list of ACL rules.
- acl(Optional<List<String>>) - Method in class com.ngrok.services.SshCredentials.CreateCallBuilder
-
optional list of ACL rules.
- acl(Optional<List<String>>) - Method in class com.ngrok.services.SshCredentials.UpdateCallBuilder
-
optional list of ACL rules.
- add(Map<String, String>) - Method in class com.ngrok.definitions.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>) - Method in class com.ngrok.definitions.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>>) - Method in class com.ngrok.definitions.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>>) - Method in class com.ngrok.definitions.EndpointResponseHeaders.Builder
-
a map of header key to header value that will be injected into the HTTP Response returned to the HTTP client
- AgentIngress - Class in com.ngrok.definitions
-
A class encapsulating the
AgentIngressresource. - AgentIngress(String, URI, String, String, String, List<String>, List<String>, String) - Constructor for class com.ngrok.definitions.AgentIngress
-
Creates a new instance of
AgentIngress. - agentIngresses() - Method in class com.ngrok.Ngrok
-
Creates a service client for AgentIngresses.
- AgentIngresses - Class in com.ngrok.services
-
An API client for
AgentIngresses. - AgentIngresses(NgrokApiClient) - Constructor for class com.ngrok.services.AgentIngresses
-
Creates a new sub-client for AgentIngresses.
- AgentIngresses.CreateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Create API call.
- AgentIngresses.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- AgentIngresses.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- AgentIngresses.ListCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent List API call.
- AgentIngresses.UpdateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Update API call.
- AgentIngressList - Class in com.ngrok.definitions
-
A class encapsulating the
AgentIngressListresource. - AgentIngressList(List<AgentIngress>, URI, Optional<URI>) - Constructor for class com.ngrok.definitions.AgentIngressList
-
Creates a new instance of
AgentIngressList. - allowIdpInitiated(boolean) - Method in class com.ngrok.definitions.EndpointSamlMutate.Builder
-
If true, the IdP may initiate a login directly (e.g.
- allowIdpInitiated(Optional<Boolean>) - Method in class com.ngrok.definitions.EndpointSamlMutate.Builder
-
If true, the IdP may initiate a login directly (e.g.
- API_VERSION - Static variable in class com.ngrok.Version
-
The ngrok API version in use
- ApiKey - Class in com.ngrok.definitions
-
A class encapsulating the
ApiKeyresource. - ApiKey(String, URI, String, String, OffsetDateTime, Optional<String>) - Constructor for class com.ngrok.definitions.ApiKey
-
Creates a new instance of
ApiKey. - ApiKeyList - Class in com.ngrok.definitions
-
A class encapsulating the
ApiKeyListresource. - ApiKeyList(List<ApiKey>, URI, Optional<URI>) - Constructor for class com.ngrok.definitions.ApiKeyList
-
Creates a new instance of
ApiKeyList. - apiKeys() - Method in class com.ngrok.Ngrok
-
API Keys are used to authenticate to the ngrok API.
- ApiKeys - Class in com.ngrok.services
-
API Keys are used to authenticate to the ngrok API.
- ApiKeys(NgrokApiClient) - Constructor for class com.ngrok.services.ApiKeys
-
Creates a new sub-client for ApiKeys.
- ApiKeys.CreateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Create API call.
- ApiKeys.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- ApiKeys.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- ApiKeys.ListCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent List API call.
- ApiKeys.UpdateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Update API call.
- auth(AwsAuth) - Method in class com.ngrok.definitions.EventTargetCloudwatchLogs.Builder
-
Configuration for how to authenticate into your AWS account.
- auth(AwsAuth) - Method in class com.ngrok.definitions.EventTargetFirehose.Builder
-
Configuration for how to authenticate into your AWS account.
- auth(AwsAuth) - Method in class com.ngrok.definitions.EventTargetKinesis.Builder
-
Configuration for how to authenticate into your AWS account.
- auth(Optional<AwsAuth>) - Method in class com.ngrok.definitions.EventTargetCloudwatchLogs.Builder
-
Configuration for how to authenticate into your AWS account.
- auth(Optional<AwsAuth>) - Method in class com.ngrok.definitions.EventTargetFirehose.Builder
-
Configuration for how to authenticate into your AWS account.
- auth(Optional<AwsAuth>) - Method in class com.ngrok.definitions.EventTargetKinesis.Builder
-
Configuration for how to authenticate into your AWS account.
- authCheckInterval(long) - Method in class com.ngrok.definitions.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>) - Method in class com.ngrok.definitions.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) - Method in class com.ngrok.definitions.ReservedDomainCertPolicy.Builder
-
certificate authority to request certificates from.
- authority(Optional<String>) - Method in class com.ngrok.definitions.ReservedDomainCertPolicy.Builder
-
certificate authority to request certificates from.
- authorizedGroups(List<String>) - Method in class com.ngrok.definitions.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>>) - Method in class com.ngrok.definitions.EndpointSamlMutate.Builder
-
If present, only users who are a member of one of the listed groups may access the target endpoint.
- AwsAuth - Class in com.ngrok.definitions
-
A class encapsulating the
AwsAuthresource. - AwsAuth.Builder - Class in com.ngrok.definitions
-
Builder class for
AwsAuth. - AwsCredentials - Class in com.ngrok.definitions
-
A class encapsulating the
AwsCredentialsresource. - AwsCredentials.Builder - Class in com.ngrok.definitions
-
Builder class for
AwsCredentials. - AwsRole - Class in com.ngrok.definitions
-
A class encapsulating the
AwsRoleresource. - AwsRole.Builder - Class in com.ngrok.definitions
-
Builder class for
AwsRole.
B
- baseUri(URI) - Method in class com.ngrok.DefaultNgrokApiClient.Builder
-
Sets the API base URI.
- baseUri(Optional<URI>) - Method in class com.ngrok.DefaultNgrokApiClient.Builder
-
Sets the API base URI.
- beforeId(String) - Method in class com.ngrok.services.AgentIngresses.ListCallBuilder
-
Sets the
before_idparameter. - beforeId(String) - Method in class com.ngrok.services.ApiKeys.ListCallBuilder
-
Sets the
before_idparameter. - beforeId(String) - Method in class com.ngrok.services.CertificateAuthorities.ListCallBuilder
-
Sets the
before_idparameter. - beforeId(String) - Method in class com.ngrok.services.Credentials.ListCallBuilder
-
Sets the
before_idparameter. - beforeId(String) - Method in class com.ngrok.services.EndpointConfigurations.ListCallBuilder
-
Sets the
before_idparameter. - beforeId(String) - Method in class com.ngrok.services.EventDestinations.ListCallBuilder
-
Sets the
before_idparameter. - beforeId(String) - Method in class com.ngrok.services.EventStreams.ListCallBuilder
-
Sets the
before_idparameter. - beforeId(String) - Method in class com.ngrok.services.EventSubscriptions.ListCallBuilder
-
Sets the
before_idparameter. - beforeId(String) - Method in class com.ngrok.services.IpPolicies.ListCallBuilder
-
Sets the
before_idparameter. - beforeId(String) - Method in class com.ngrok.services.IpPolicyRules.ListCallBuilder
-
Sets the
before_idparameter. - beforeId(String) - Method in class com.ngrok.services.IpRestrictions.ListCallBuilder
-
Sets the
before_idparameter. - beforeId(String) - Method in class com.ngrok.services.ReservedAddrs.ListCallBuilder
-
Sets the
before_idparameter. - beforeId(String) - Method in class com.ngrok.services.ReservedDomains.ListCallBuilder
-
Sets the
before_idparameter. - beforeId(String) - Method in class com.ngrok.services.SshCertificateAuthorities.ListCallBuilder
-
Sets the
before_idparameter. - beforeId(String) - Method in class com.ngrok.services.SshCredentials.ListCallBuilder
-
Sets the
before_idparameter. - beforeId(String) - Method in class com.ngrok.services.SshHostCertificates.ListCallBuilder
-
Sets the
before_idparameter. - beforeId(String) - Method in class com.ngrok.services.SshUserCertificates.ListCallBuilder
-
Sets the
before_idparameter. - beforeId(String) - Method in class com.ngrok.services.TlsCertificates.ListCallBuilder
-
Sets the
before_idparameter. - beforeId(String) - Method in class com.ngrok.services.Tunnels.ListCallBuilder
-
Sets the
before_idparameter. - beforeId(String) - Method in class com.ngrok.services.TunnelSessions.ListCallBuilder
-
Sets the
before_idparameter. - beforeId(Optional<String>) - Method in class com.ngrok.services.AgentIngresses.ListCallBuilder
-
Sets (or unsets) the
before_idparameter. - beforeId(Optional<String>) - Method in class com.ngrok.services.ApiKeys.ListCallBuilder
-
Sets (or unsets) the
before_idparameter. - beforeId(Optional<String>) - Method in class com.ngrok.services.CertificateAuthorities.ListCallBuilder
-
Sets (or unsets) the
before_idparameter. - beforeId(Optional<String>) - Method in class com.ngrok.services.Credentials.ListCallBuilder
-
Sets (or unsets) the
before_idparameter. - beforeId(Optional<String>) - Method in class com.ngrok.services.EndpointConfigurations.ListCallBuilder
-
Sets (or unsets) the
before_idparameter. - beforeId(Optional<String>) - Method in class com.ngrok.services.EventDestinations.ListCallBuilder
-
Sets (or unsets) the
before_idparameter. - beforeId(Optional<String>) - Method in class com.ngrok.services.EventStreams.ListCallBuilder
-
Sets (or unsets) the
before_idparameter. - beforeId(Optional<String>) - Method in class com.ngrok.services.EventSubscriptions.ListCallBuilder
-
Sets (or unsets) the
before_idparameter. - beforeId(Optional<String>) - Method in class com.ngrok.services.IpPolicies.ListCallBuilder
-
Sets (or unsets) the
before_idparameter. - beforeId(Optional<String>) - Method in class com.ngrok.services.IpPolicyRules.ListCallBuilder
-
Sets (or unsets) the
before_idparameter. - beforeId(Optional<String>) - Method in class com.ngrok.services.IpRestrictions.ListCallBuilder
-
Sets (or unsets) the
before_idparameter. - beforeId(Optional<String>) - Method in class com.ngrok.services.ReservedAddrs.ListCallBuilder
-
Sets (or unsets) the
before_idparameter. - beforeId(Optional<String>) - Method in class com.ngrok.services.ReservedDomains.ListCallBuilder
-
Sets (or unsets) the
before_idparameter. - beforeId(Optional<String>) - Method in class com.ngrok.services.SshCertificateAuthorities.ListCallBuilder
-
Sets (or unsets) the
before_idparameter. - beforeId(Optional<String>) - Method in class com.ngrok.services.SshCredentials.ListCallBuilder
-
Sets (or unsets) the
before_idparameter. - beforeId(Optional<String>) - Method in class com.ngrok.services.SshHostCertificates.ListCallBuilder
-
Sets (or unsets) the
before_idparameter. - beforeId(Optional<String>) - Method in class com.ngrok.services.SshUserCertificates.ListCallBuilder
-
Sets (or unsets) the
before_idparameter. - beforeId(Optional<String>) - Method in class com.ngrok.services.TlsCertificates.ListCallBuilder
-
Sets (or unsets) the
before_idparameter. - beforeId(Optional<String>) - Method in class com.ngrok.services.Tunnels.ListCallBuilder
-
Sets (or unsets) the
before_idparameter. - beforeId(Optional<String>) - Method in class com.ngrok.services.TunnelSessions.ListCallBuilder
-
Sets (or unsets) the
before_idparameter. - blockingCall() - Method in class com.ngrok.services.AbuseReports.CreateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.AbuseReports.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.AgentIngresses.CreateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.AgentIngresses.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.AgentIngresses.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.AgentIngresses.ListCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.AgentIngresses.UpdateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.ApiKeys.CreateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.ApiKeys.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.ApiKeys.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.ApiKeys.ListCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.ApiKeys.UpdateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.CertificateAuthorities.CreateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.CertificateAuthorities.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.CertificateAuthorities.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.CertificateAuthorities.ListCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.CertificateAuthorities.UpdateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.Credentials.CreateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.Credentials.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.Credentials.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.Credentials.ListCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.Credentials.UpdateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointCircuitBreakerModule.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointCircuitBreakerModule.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointCircuitBreakerModule.ReplaceCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointCompressionModule.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointCompressionModule.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointCompressionModule.ReplaceCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointConfigurations.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointConfigurations.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointConfigurations.ListCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointIpPolicyModule.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointIpPolicyModule.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointIpPolicyModule.ReplaceCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointLoggingModule.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointLoggingModule.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointLoggingModule.ReplaceCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointMutualTlsModule.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointMutualTlsModule.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointMutualTlsModule.ReplaceCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointOAuthModule.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointOAuthModule.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointOAuthModule.ReplaceCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointOidcModule.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointOidcModule.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointOidcModule.ReplaceCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointRequestHeadersModule.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointRequestHeadersModule.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointRequestHeadersModule.ReplaceCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointResponseHeadersModule.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointResponseHeadersModule.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointResponseHeadersModule.ReplaceCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointSamlModule.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointSamlModule.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointSamlModule.ReplaceCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointTlsTerminationModule.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointTlsTerminationModule.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointTlsTerminationModule.ReplaceCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointWebhookValidationModule.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointWebhookValidationModule.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EndpointWebhookValidationModule.ReplaceCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EventDestinations.CreateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EventDestinations.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EventDestinations.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EventDestinations.ListCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EventDestinations.UpdateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EventSources.CreateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EventSources.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EventSources.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EventSources.ListCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EventSources.UpdateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EventStreams.CreateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EventStreams.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EventStreams.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EventStreams.ListCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EventStreams.UpdateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EventSubscriptions.CreateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EventSubscriptions.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EventSubscriptions.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EventSubscriptions.ListCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.EventSubscriptions.UpdateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.IpPolicies.CreateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.IpPolicies.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.IpPolicies.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.IpPolicies.ListCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.IpPolicies.UpdateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.IpPolicyRules.CreateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.IpPolicyRules.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.IpPolicyRules.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.IpPolicyRules.ListCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.IpPolicyRules.UpdateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.IpRestrictions.CreateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.IpRestrictions.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.IpRestrictions.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.IpRestrictions.ListCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.IpRestrictions.UpdateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.ReservedAddrs.CreateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.ReservedAddrs.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.ReservedAddrs.DeleteEndpointConfigCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.ReservedAddrs.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.ReservedAddrs.ListCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.ReservedAddrs.UpdateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.ReservedDomains.CreateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.ReservedDomains.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.ReservedDomains.DeleteCertificateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.ReservedDomains.DeleteCertificateManagementPolicyCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.ReservedDomains.DeleteHttpEndpointConfigCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.ReservedDomains.DeleteHttpsEndpointConfigCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.ReservedDomains.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.ReservedDomains.ListCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.ReservedDomains.UpdateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.SshCertificateAuthorities.CreateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.SshCertificateAuthorities.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.SshCertificateAuthorities.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.SshCertificateAuthorities.ListCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.SshCertificateAuthorities.UpdateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.SshCredentials.CreateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.SshCredentials.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.SshCredentials.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.SshCredentials.ListCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.SshCredentials.UpdateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.SshHostCertificates.CreateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.SshHostCertificates.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.SshHostCertificates.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.SshHostCertificates.ListCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.SshHostCertificates.UpdateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.SshUserCertificates.CreateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.SshUserCertificates.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.SshUserCertificates.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.SshUserCertificates.ListCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.SshUserCertificates.UpdateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.TlsCertificates.CreateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.TlsCertificates.DeleteCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.TlsCertificates.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.TlsCertificates.ListCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.TlsCertificates.UpdateCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.Tunnels.ListCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.TunnelSessions.GetCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.TunnelSessions.ListCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.TunnelSessions.RestartCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.TunnelSessions.StopCallBuilder
-
Initiates the API call and blocks until it returns.
- blockingCall() - Method in class com.ngrok.services.TunnelSessions.UpdateCallBuilder
-
Initiates the API call and blocks until it returns.
- build() - Method in class com.ngrok.DefaultNgrokApiClient.Builder
-
Builds the ngrok API client instance.
- build() - Method in class com.ngrok.definitions.AwsAuth.Builder
-
Constructs the
AwsAuthinstance. - build() - Method in class com.ngrok.definitions.AwsCredentials.Builder
-
Constructs the
AwsCredentialsinstance. - build() - Method in class com.ngrok.definitions.AwsRole.Builder
-
Constructs the
AwsRoleinstance. - build() - Method in class com.ngrok.definitions.EndpointCircuitBreaker.Builder
-
Constructs the
EndpointCircuitBreakerinstance. - build() - Method in class com.ngrok.definitions.EndpointCompression.Builder
-
Constructs the
EndpointCompressioninstance. - build() - Method in class com.ngrok.definitions.EndpointIpPolicyMutate.Builder
-
Constructs the
EndpointIpPolicyMutateinstance. - build() - Method in class com.ngrok.definitions.EndpointLoggingMutate.Builder
-
Constructs the
EndpointLoggingMutateinstance. - build() - Method in class com.ngrok.definitions.EndpointMutualTlsMutate.Builder
-
Constructs the
EndpointMutualTlsMutateinstance. - build() - Method in class com.ngrok.definitions.EndpointOAuth.Builder
-
Constructs the
EndpointOAuthinstance. - build() - Method in class com.ngrok.definitions.EndpointOAuthFacebook.Builder
-
Constructs the
EndpointOAuthFacebookinstance. - build() - Method in class com.ngrok.definitions.EndpointOAuthGitHub.Builder
-
Constructs the
EndpointOAuthGitHubinstance. - build() - Method in class com.ngrok.definitions.EndpointOAuthGoogle.Builder
-
Constructs the
EndpointOAuthGoogleinstance. - build() - Method in class com.ngrok.definitions.EndpointOAuthMicrosoft.Builder
-
Constructs the
EndpointOAuthMicrosoftinstance. - build() - Method in class com.ngrok.definitions.EndpointOAuthProvider.Builder
-
Constructs the
EndpointOAuthProviderinstance. - build() - Method in class com.ngrok.definitions.EndpointOidc.Builder
-
Constructs the
EndpointOidcinstance. - build() - Method in class com.ngrok.definitions.EndpointRequestHeaders.Builder
-
Constructs the
EndpointRequestHeadersinstance. - build() - Method in class com.ngrok.definitions.EndpointResponseHeaders.Builder
-
Constructs the
EndpointResponseHeadersinstance. - build() - Method in class com.ngrok.definitions.EndpointSamlMutate.Builder
-
Constructs the
EndpointSamlMutateinstance. - build() - Method in class com.ngrok.definitions.EndpointTlsTermination.Builder
-
Constructs the
EndpointTlsTerminationinstance. - build() - Method in class com.ngrok.definitions.EndpointWebhookValidation.Builder
-
Constructs the
EndpointWebhookValidationinstance. - build() - Method in class com.ngrok.definitions.EventSourceReplace.Builder
-
Constructs the
EventSourceReplaceinstance. - build() - Method in class com.ngrok.definitions.EventTarget.Builder
-
Constructs the
EventTargetinstance. - build() - Method in class com.ngrok.definitions.EventTargetCloudwatchLogs.Builder
-
Constructs the
EventTargetCloudwatchLogsinstance. - build() - Method in class com.ngrok.definitions.EventTargetFirehose.Builder
-
Constructs the
EventTargetFirehoseinstance. - build() - Method in class com.ngrok.definitions.EventTargetKinesis.Builder
-
Constructs the
EventTargetKinesisinstance. - build() - Method in class com.ngrok.definitions.ReservedDomainCertPolicy.Builder
-
Constructs the
ReservedDomainCertPolicyinstance.
C
- call() - Method in class com.ngrok.services.AbuseReports.CreateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.AbuseReports.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.AgentIngresses.CreateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.AgentIngresses.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.AgentIngresses.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.AgentIngresses.ListCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.AgentIngresses.UpdateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.ApiKeys.CreateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.ApiKeys.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.ApiKeys.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.ApiKeys.ListCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.ApiKeys.UpdateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.CertificateAuthorities.CreateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.CertificateAuthorities.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.CertificateAuthorities.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.CertificateAuthorities.ListCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.CertificateAuthorities.UpdateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.Credentials.CreateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.Credentials.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.Credentials.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.Credentials.ListCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.Credentials.UpdateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointCircuitBreakerModule.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointCircuitBreakerModule.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointCircuitBreakerModule.ReplaceCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointCompressionModule.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointCompressionModule.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointCompressionModule.ReplaceCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointConfigurations.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointConfigurations.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointConfigurations.ListCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointIpPolicyModule.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointIpPolicyModule.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointIpPolicyModule.ReplaceCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointLoggingModule.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointLoggingModule.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointLoggingModule.ReplaceCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointMutualTlsModule.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointMutualTlsModule.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointMutualTlsModule.ReplaceCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointOAuthModule.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointOAuthModule.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointOAuthModule.ReplaceCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointOidcModule.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointOidcModule.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointOidcModule.ReplaceCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointRequestHeadersModule.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointRequestHeadersModule.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointRequestHeadersModule.ReplaceCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointResponseHeadersModule.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointResponseHeadersModule.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointResponseHeadersModule.ReplaceCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointSamlModule.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointSamlModule.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointSamlModule.ReplaceCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointTlsTerminationModule.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointTlsTerminationModule.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointTlsTerminationModule.ReplaceCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointWebhookValidationModule.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointWebhookValidationModule.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EndpointWebhookValidationModule.ReplaceCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EventDestinations.CreateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EventDestinations.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EventDestinations.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EventDestinations.ListCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EventDestinations.UpdateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EventSources.CreateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EventSources.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EventSources.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EventSources.ListCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EventSources.UpdateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EventStreams.CreateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EventStreams.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EventStreams.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EventStreams.ListCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EventStreams.UpdateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EventSubscriptions.CreateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EventSubscriptions.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EventSubscriptions.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EventSubscriptions.ListCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.EventSubscriptions.UpdateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.IpPolicies.CreateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.IpPolicies.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.IpPolicies.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.IpPolicies.ListCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.IpPolicies.UpdateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.IpPolicyRules.CreateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.IpPolicyRules.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.IpPolicyRules.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.IpPolicyRules.ListCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.IpPolicyRules.UpdateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.IpRestrictions.CreateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.IpRestrictions.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.IpRestrictions.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.IpRestrictions.ListCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.IpRestrictions.UpdateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.ReservedAddrs.CreateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.ReservedAddrs.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.ReservedAddrs.DeleteEndpointConfigCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.ReservedAddrs.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.ReservedAddrs.ListCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.ReservedAddrs.UpdateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.ReservedDomains.CreateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.ReservedDomains.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.ReservedDomains.DeleteCertificateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.ReservedDomains.DeleteCertificateManagementPolicyCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.ReservedDomains.DeleteHttpEndpointConfigCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.ReservedDomains.DeleteHttpsEndpointConfigCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.ReservedDomains.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.ReservedDomains.ListCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.ReservedDomains.UpdateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.SshCertificateAuthorities.CreateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.SshCertificateAuthorities.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.SshCertificateAuthorities.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.SshCertificateAuthorities.ListCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.SshCertificateAuthorities.UpdateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.SshCredentials.CreateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.SshCredentials.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.SshCredentials.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.SshCredentials.ListCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.SshCredentials.UpdateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.SshHostCertificates.CreateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.SshHostCertificates.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.SshHostCertificates.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.SshHostCertificates.ListCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.SshHostCertificates.UpdateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.SshUserCertificates.CreateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.SshUserCertificates.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.SshUserCertificates.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.SshUserCertificates.ListCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.SshUserCertificates.UpdateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.TlsCertificates.CreateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.TlsCertificates.DeleteCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.TlsCertificates.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.TlsCertificates.ListCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.TlsCertificates.UpdateCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.Tunnels.ListCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.TunnelSessions.GetCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.TunnelSessions.ListCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.TunnelSessions.RestartCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.TunnelSessions.StopCallBuilder
-
Initiates the API call asynchronously.
- call() - Method in class com.ngrok.services.TunnelSessions.UpdateCallBuilder
-
Initiates the API call asynchronously.
- certificateAuthorities() - Method in class com.ngrok.Ngrok
-
Certificate Authorities are x509 certificates that are used to sign other x509 certificates.
- CertificateAuthorities - Class in com.ngrok.services
-
Certificate Authorities are x509 certificates that are used to sign other x509 certificates.
- CertificateAuthorities(NgrokApiClient) - Constructor for class com.ngrok.services.CertificateAuthorities
-
Creates a new sub-client for CertificateAuthorities.
- CertificateAuthorities.CreateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Create API call.
- CertificateAuthorities.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- CertificateAuthorities.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- CertificateAuthorities.ListCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent List API call.
- CertificateAuthorities.UpdateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Update API call.
- CertificateAuthority - Class in com.ngrok.definitions
-
A class encapsulating the
CertificateAuthorityresource. - CertificateAuthority(String, URI, OffsetDateTime, String, String, String, String, OffsetDateTime, OffsetDateTime, List<String>, List<String>) - Constructor for class com.ngrok.definitions.CertificateAuthority
-
Creates a new instance of
CertificateAuthority. - certificateAuthorityIds(List<String>) - Method in class com.ngrok.definitions.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>>) - Method in class com.ngrok.definitions.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 - Class in com.ngrok.definitions
-
A class encapsulating the
CertificateAuthorityListresource. - CertificateAuthorityList(List<CertificateAuthority>, URI, Optional<URI>) - Constructor for class com.ngrok.definitions.CertificateAuthorityList
-
Creates a new instance of
CertificateAuthorityList. - certificateId(String) - Method in class com.ngrok.services.ReservedDomains.CreateCallBuilder
-
ID of a user-uploaded TLS certificate to use for connections to targeting this domain.
- certificateId(String) - Method in class com.ngrok.services.ReservedDomains.UpdateCallBuilder
-
ID of a user-uploaded TLS certificate to use for connections to targeting this domain.
- certificateId(Optional<String>) - Method in class com.ngrok.services.ReservedDomains.CreateCallBuilder
-
ID of a user-uploaded TLS certificate to use for connections to targeting this domain.
- certificateId(Optional<String>) - Method in class com.ngrok.services.ReservedDomains.UpdateCallBuilder
-
ID of a user-uploaded TLS certificate to use for connections to targeting this domain.
- certificateManagementPolicy(ReservedDomainCertPolicy) - Method in class com.ngrok.services.ReservedDomains.CreateCallBuilder
-
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled.
- certificateManagementPolicy(ReservedDomainCertPolicy) - Method in class com.ngrok.services.ReservedDomains.UpdateCallBuilder
-
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled.
- certificateManagementPolicy(Optional<ReservedDomainCertPolicy>) - Method in class com.ngrok.services.ReservedDomains.CreateCallBuilder
-
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled.
- certificateManagementPolicy(Optional<ReservedDomainCertPolicy>) - Method in class com.ngrok.services.ReservedDomains.UpdateCallBuilder
-
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled.
- cidr(String) - Method in class com.ngrok.services.IpPolicyRules.UpdateCallBuilder
-
an IP or IP range specified in CIDR notation.
- cidr(Optional<String>) - Method in class com.ngrok.services.IpPolicyRules.UpdateCallBuilder
-
an IP or IP range specified in CIDR notation.
- circuitBreaker() - Method in class com.ngrok.Ngrok.PointcfgModuleNamespace
-
Creates a service client for
EndpointCircuitBreakerModule. - circuitBreaker(EndpointCircuitBreaker) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
circuit breaker module configuration or
null - circuitBreaker(EndpointCircuitBreaker) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
circuit breaker module configuration or
null - circuitBreaker(Optional<EndpointCircuitBreaker>) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
circuit breaker module configuration or
null - circuitBreaker(Optional<EndpointCircuitBreaker>) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
circuit breaker module configuration or
null - CLIENT_VERSION - Static variable in class com.ngrok.Version
-
This API client's version string
- clientId(String) - Method in class com.ngrok.definitions.EndpointOAuthFacebook.Builder
-
the OAuth app client ID.
- clientId(String) - Method in class com.ngrok.definitions.EndpointOAuthGitHub.Builder
-
the OAuth app client ID.
- clientId(String) - Method in class com.ngrok.definitions.EndpointOAuthGoogle.Builder
-
the OAuth app client ID.
- clientId(String) - Method in class com.ngrok.definitions.EndpointOAuthMicrosoft.Builder
-
the OAuth app client ID.
- clientId(String) - Method in class com.ngrok.definitions.EndpointOidc.Builder
-
The OIDC app's client ID and OIDC audience.
- clientId(Optional<String>) - Method in class com.ngrok.definitions.EndpointOAuthFacebook.Builder
-
the OAuth app client ID.
- clientId(Optional<String>) - Method in class com.ngrok.definitions.EndpointOAuthGitHub.Builder
-
the OAuth app client ID.
- clientId(Optional<String>) - Method in class com.ngrok.definitions.EndpointOAuthGoogle.Builder
-
the OAuth app client ID.
- clientId(Optional<String>) - Method in class com.ngrok.definitions.EndpointOAuthMicrosoft.Builder
-
the OAuth app client ID.
- clientId(Optional<String>) - Method in class com.ngrok.definitions.EndpointOidc.Builder
-
The OIDC app's client ID and OIDC audience.
- clientSecret(String) - Method in class com.ngrok.definitions.EndpointOAuthFacebook.Builder
-
the OAuth app client secret.
- clientSecret(String) - Method in class com.ngrok.definitions.EndpointOAuthGitHub.Builder
-
the OAuth app client secret.
- clientSecret(String) - Method in class com.ngrok.definitions.EndpointOAuthGoogle.Builder
-
the OAuth app client secret.
- clientSecret(String) - Method in class com.ngrok.definitions.EndpointOAuthMicrosoft.Builder
-
the OAuth app client secret.
- clientSecret(String) - Method in class com.ngrok.definitions.EndpointOidc.Builder
-
The OIDC app's client secret.
- clientSecret(Optional<String>) - Method in class com.ngrok.definitions.EndpointOAuthFacebook.Builder
-
the OAuth app client secret.
- clientSecret(Optional<String>) - Method in class com.ngrok.definitions.EndpointOAuthGitHub.Builder
-
the OAuth app client secret.
- clientSecret(Optional<String>) - Method in class com.ngrok.definitions.EndpointOAuthGoogle.Builder
-
the OAuth app client secret.
- clientSecret(Optional<String>) - Method in class com.ngrok.definitions.EndpointOAuthMicrosoft.Builder
-
the OAuth app client secret.
- clientSecret(Optional<String>) - Method in class com.ngrok.definitions.EndpointOidc.Builder
-
The OIDC app's client secret.
- cloudwatchLogs(EventTargetCloudwatchLogs) - Method in class com.ngrok.definitions.EventTarget.Builder
-
Configuration used to send events to Amazon CloudWatch Logs.
- cloudwatchLogs(Optional<EventTargetCloudwatchLogs>) - Method in class com.ngrok.definitions.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() - Method in class com.ngrok.Ngrok.PointcfgModuleNamespace
-
Creates a service client for
EndpointCompressionModule. - compression(EndpointCompression) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
compression module configuration or
null - compression(EndpointCompression) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
compression module configuration or
null - compression(Optional<EndpointCompression>) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
compression module configuration or
null - compression(Optional<EndpointCompression>) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
compression module configuration or
null - cookiePrefix(String) - Method in class com.ngrok.definitions.EndpointOAuth.Builder
-
the prefix of the session cookie that ngrok sets on the http client to cache authentication.
- cookiePrefix(String) - Method in class com.ngrok.definitions.EndpointOidc.Builder
-
the prefix of the session cookie that ngrok sets on the http client to cache authentication.
- cookiePrefix(String) - Method in class com.ngrok.definitions.EndpointSamlMutate.Builder
-
the prefix of the session cookie that ngrok sets on the http client to cache authentication.
- cookiePrefix(Optional<String>) - Method in class com.ngrok.definitions.EndpointOAuth.Builder
-
the prefix of the session cookie that ngrok sets on the http client to cache authentication.
- cookiePrefix(Optional<String>) - Method in class com.ngrok.definitions.EndpointOidc.Builder
-
the prefix of the session cookie that ngrok sets on the http client to cache authentication.
- cookiePrefix(Optional<String>) - Method in class com.ngrok.definitions.EndpointSamlMutate.Builder
-
the prefix of the session cookie that ngrok sets on the http client to cache authentication.
- create() - Method in class com.ngrok.services.ApiKeys
-
Create a new API key.
- create() - Method in class com.ngrok.services.Credentials
-
Create a new tunnel authtoken credential.
- create() - Method in class com.ngrok.services.EndpointConfigurations
-
Create a new endpoint configuration See also https://ngrok.com/docs/api#api-endpoint-configurations-create.
- create() - Method in class com.ngrok.services.EventDestinations
-
Create a new Event Destination.
- create() - Method in class com.ngrok.services.EventStreams
-
Create a new Event Stream.
- create() - Method in class com.ngrok.services.EventSubscriptions
-
Create an Event Subscription.
- create() - Method in class com.ngrok.services.ReservedAddrs
-
Create a new reserved address.
- create() - Method in class com.ngrok.services.SshCertificateAuthorities
-
Create a new SSH Certificate Authority See also https://ngrok.com/docs/api#api-ssh-certificate-authorities-create.
- create(String) - Method in class com.ngrok.services.AgentIngresses
-
Create a new Agent Ingress.
- create(String) - Method in class com.ngrok.services.CertificateAuthorities
-
Upload a new Certificate Authority See also https://ngrok.com/docs/api#api-certificate-authorities-create.
- create(String) - Method in class com.ngrok.services.EventSources
-
Add an additional type for which this event subscription will trigger See also https://ngrok.com/docs/api#api-event-sources-create.
- create(String) - Method in class com.ngrok.services.IpPolicies
-
Create a new IP policy.
- create(String) - Method in class com.ngrok.services.ReservedDomains
-
Create a new reserved domain.
- create(String) - Method in class com.ngrok.services.SshCredentials
-
Create a new ssh_credential from an uploaded public SSH key.
- create(String, String) - Method in class com.ngrok.services.IpPolicyRules
-
Create a new IP policy rule attached to an IP Policy.
- create(String, String) - Method in class com.ngrok.services.SshHostCertificates
-
Create a new SSH Host Certificate See also https://ngrok.com/docs/api#api-ssh-host-certificates-create.
- create(String, String) - Method in class com.ngrok.services.SshUserCertificates
-
Create a new SSH User Certificate See also https://ngrok.com/docs/api#api-ssh-user-certificates-create.
- create(String, String) - Method in class com.ngrok.services.TlsCertificates
-
Upload a new TLS certificate See also https://ngrok.com/docs/api#api-tls-certificates-create.
- create(String, List<String>) - Method in class com.ngrok.services.IpRestrictions
-
Create a new IP restriction See also https://ngrok.com/docs/api#api-ip-restrictions-create.
- create(List<URI>) - Method in class com.ngrok.services.AbuseReports
-
Creates a new abuse report which will be reviewed by our system and abuse response team.
- createDefault() - Static method in class com.ngrok.Ngrok
-
Creates a new ngrok API instance using the default API client.
- createDefault(String) - Static method in class com.ngrok.Ngrok
-
Creates a new ngrok API instance using the default API client.
- Credential - Class in com.ngrok.definitions
-
A class encapsulating the
Credentialresource. - Credential(String, URI, OffsetDateTime, String, String, Optional<String>, List<String>) - Constructor for class com.ngrok.definitions.Credential
-
Creates a new instance of
Credential. - CredentialList - Class in com.ngrok.definitions
-
A class encapsulating the
CredentialListresource. - CredentialList(List<Credential>, URI, Optional<URI>) - Constructor for class com.ngrok.definitions.CredentialList
-
Creates a new instance of
CredentialList. - credentials() - Method in class com.ngrok.Ngrok
-
Tunnel Credentials are ngrok agent authtokens.
- Credentials - Class in com.ngrok.services
-
Tunnel Credentials are ngrok agent authtokens.
- Credentials(NgrokApiClient) - Constructor for class com.ngrok.services.Credentials
-
Creates a new sub-client for Credentials.
- Credentials.CreateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Create API call.
- Credentials.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- Credentials.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- Credentials.ListCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent List API call.
- Credentials.UpdateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Update API call.
- creds(AwsCredentials) - Method in class com.ngrok.definitions.AwsAuth.Builder
-
Credentials to your AWS account if you prefer ngrok to sign in with long-term access keys.
- creds(Optional<AwsCredentials>) - Method in class com.ngrok.definitions.AwsAuth.Builder
-
Credentials to your AWS account if you prefer ngrok to sign in with long-term access keys.
- criticalOptions(Map<String, String>) - Method in class com.ngrok.services.SshUserCertificates.CreateCallBuilder
-
A map of critical options included in the certificate.
- criticalOptions(Optional<Map<String, String>>) - Method in class com.ngrok.services.SshUserCertificates.CreateCallBuilder
-
A map of critical options included in the certificate.
D
- DEFAULT_BASE_URI - Static variable in interface com.ngrok.NgrokApiClient
-
The default base URI for the public ngrok API server
- DefaultNgrokApiClient - Class in com.ngrok
-
Default implementation of
NgrokApiClientbased on the Armeria HTTP client. - DefaultNgrokApiClient.Builder - Class in com.ngrok
-
Builder class for the default API client.
- delete(String) - Method in class com.ngrok.services.AgentIngresses
-
Delete an Agent Ingress by ID See also https://ngrok.com/docs/api#api-agent-ingresses-delete.
- delete(String) - Method in class com.ngrok.services.ApiKeys
-
Delete an API key by ID See also https://ngrok.com/docs/api#api-api-keys-delete.
- delete(String) - Method in class com.ngrok.services.CertificateAuthorities
-
Delete a Certificate Authority See also https://ngrok.com/docs/api#api-certificate-authorities-delete.
- delete(String) - Method in class com.ngrok.services.Credentials
-
Delete a tunnel authtoken credential by ID See also https://ngrok.com/docs/api#api-credentials-delete.
- delete(String) - Method in class com.ngrok.services.EndpointCircuitBreakerModule
-
Creates a call builder for the Delete API operation.
- delete(String) - Method in class com.ngrok.services.EndpointCompressionModule
-
Creates a call builder for the Delete API operation.
- delete(String) - Method in class com.ngrok.services.EndpointConfigurations
-
Delete an endpoint configuration.
- delete(String) - Method in class com.ngrok.services.EndpointIpPolicyModule
-
Creates a call builder for the Delete API operation.
- delete(String) - Method in class com.ngrok.services.EndpointLoggingModule
-
Creates a call builder for the Delete API operation.
- delete(String) - Method in class com.ngrok.services.EndpointMutualTlsModule
-
Creates a call builder for the Delete API operation.
- delete(String) - Method in class com.ngrok.services.EndpointOAuthModule
-
Creates a call builder for the Delete API operation.
- delete(String) - Method in class com.ngrok.services.EndpointOidcModule
-
Creates a call builder for the Delete API operation.
- delete(String) - Method in class com.ngrok.services.EndpointRequestHeadersModule
-
Creates a call builder for the Delete API operation.
- delete(String) - Method in class com.ngrok.services.EndpointResponseHeadersModule
-
Creates a call builder for the Delete API operation.
- delete(String) - Method in class com.ngrok.services.EndpointSamlModule
-
Creates a call builder for the Delete API operation.
- delete(String) - Method in class com.ngrok.services.EndpointTlsTerminationModule
-
Creates a call builder for the Delete API operation.
- delete(String) - Method in class com.ngrok.services.EndpointWebhookValidationModule
-
Creates a call builder for the Delete API operation.
- delete(String) - Method in class com.ngrok.services.EventDestinations
-
Delete an Event Destination.
- delete(String) - Method in class com.ngrok.services.EventStreams
-
Delete an Event Stream.
- delete(String) - Method in class com.ngrok.services.EventSubscriptions
-
Delete an Event Subscription.
- delete(String) - Method in class com.ngrok.services.IpPolicies
-
Delete an IP policy.
- delete(String) - Method in class com.ngrok.services.IpPolicyRules
-
Delete an IP policy rule.
- delete(String) - Method in class com.ngrok.services.IpRestrictions
-
Delete an IP restriction See also https://ngrok.com/docs/api#api-ip-restrictions-delete.
- delete(String) - Method in class com.ngrok.services.ReservedAddrs
-
Delete a reserved address.
- delete(String) - Method in class com.ngrok.services.ReservedDomains
-
Delete a reserved domain.
- delete(String) - Method in class com.ngrok.services.SshCertificateAuthorities
-
Delete an SSH Certificate Authority See also https://ngrok.com/docs/api#api-ssh-certificate-authorities-delete.
- delete(String) - Method in class com.ngrok.services.SshCredentials
-
Delete an ssh_credential by ID See also https://ngrok.com/docs/api#api-ssh-credentials-delete.
- delete(String) - Method in class com.ngrok.services.SshHostCertificates
-
Delete an SSH Host Certificate See also https://ngrok.com/docs/api#api-ssh-host-certificates-delete.
- delete(String) - Method in class com.ngrok.services.SshUserCertificates
-
Delete an SSH User Certificate See also https://ngrok.com/docs/api#api-ssh-user-certificates-delete.
- delete(String) - Method in class com.ngrok.services.TlsCertificates
-
Delete a TLS certificate See also https://ngrok.com/docs/api#api-tls-certificates-delete.
- delete(String, String) - Method in class com.ngrok.services.EventSources
-
Remove a type for which this event subscription will trigger See also https://ngrok.com/docs/api#api-event-sources-delete.
- DELETE - Enum constant in enum com.ngrok.NgrokApiClient.HttpMethod
-
HTTP DELETE
- deleteCertificate(String) - Method in class com.ngrok.services.ReservedDomains
-
Detach the certificate attached to a reserved domain.
- deleteCertificateManagementPolicy(String) - Method in class com.ngrok.services.ReservedDomains
-
Detach the certificate management policy attached to a reserved domain.
- deleteEndpointConfig(String) - Method in class com.ngrok.services.ReservedAddrs
-
Detach the endpoint configuration attached to a reserved address.
- deleteHttpEndpointConfig(String) - Method in class com.ngrok.services.ReservedDomains
-
Detach the http endpoint configuration attached to a reserved domain.
- deleteHttpsEndpointConfig(String) - Method in class com.ngrok.services.ReservedDomains
-
Detach the https endpoint configuration attached to a reserved domain.
- deliveryStreamArn(String) - Method in class com.ngrok.definitions.EventTargetFirehose.Builder
-
An Amazon Resource Name specifying the Firehose delivery stream to deposit events into.
- deliveryStreamArn(Optional<String>) - Method in class com.ngrok.definitions.EventTargetFirehose.Builder
-
An Amazon Resource Name specifying the Firehose delivery stream to deposit events into.
- description(String) - Method in class com.ngrok.services.AgentIngresses.CreateCallBuilder
-
human-readable description of the use of this Agent Ingress.
- description(String) - Method in class com.ngrok.services.AgentIngresses.UpdateCallBuilder
-
human-readable description of the use of this Agent Ingress.
- description(String) - Method in class com.ngrok.services.ApiKeys.CreateCallBuilder
-
human-readable description of what uses the API key to authenticate.
- description(String) - Method in class com.ngrok.services.ApiKeys.UpdateCallBuilder
-
human-readable description of what uses the API key to authenticate.
- description(String) - Method in class com.ngrok.services.CertificateAuthorities.CreateCallBuilder
-
human-readable description of this Certificate Authority.
- description(String) - Method in class com.ngrok.services.CertificateAuthorities.UpdateCallBuilder
-
human-readable description of this Certificate Authority.
- description(String) - Method in class com.ngrok.services.Credentials.CreateCallBuilder
-
human-readable description of who or what will use the credential to authenticate.
- description(String) - Method in class com.ngrok.services.Credentials.UpdateCallBuilder
-
human-readable description of who or what will use the credential to authenticate.
- description(String) - Method in class com.ngrok.services.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) - Method in class com.ngrok.services.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) - Method in class com.ngrok.services.EventDestinations.CreateCallBuilder
-
Human-readable description of the Event Destination.
- description(String) - Method in class com.ngrok.services.EventDestinations.UpdateCallBuilder
-
Human-readable description of the Event Destination.
- description(String) - Method in class com.ngrok.services.EventStreams.CreateCallBuilder
-
Human-readable description of the Event Stream.
- description(String) - Method in class com.ngrok.services.EventStreams.UpdateCallBuilder
-
Human-readable description of the Event Stream.
- description(String) - Method in class com.ngrok.services.EventSubscriptions.CreateCallBuilder
-
Arbitrary customer supplied information intended to be human readable.
- description(String) - Method in class com.ngrok.services.EventSubscriptions.UpdateCallBuilder
-
Arbitrary customer supplied information intended to be human readable.
- description(String) - Method in class com.ngrok.services.IpPolicies.CreateCallBuilder
-
human-readable description of the source IPs of this IP policy.
- description(String) - Method in class com.ngrok.services.IpPolicies.UpdateCallBuilder
-
human-readable description of the source IPs of this IP policy.
- description(String) - Method in class com.ngrok.services.IpPolicyRules.CreateCallBuilder
-
human-readable description of the source IPs of this IP rule.
- description(String) - Method in class com.ngrok.services.IpPolicyRules.UpdateCallBuilder
-
human-readable description of the source IPs of this IP rule.
- description(String) - Method in class com.ngrok.services.IpRestrictions.CreateCallBuilder
-
human-readable description of this IP restriction.
- description(String) - Method in class com.ngrok.services.IpRestrictions.UpdateCallBuilder
-
human-readable description of this IP restriction.
- description(String) - Method in class com.ngrok.services.ReservedAddrs.CreateCallBuilder
-
human-readable description of what this reserved address will be used for
- description(String) - Method in class com.ngrok.services.ReservedAddrs.UpdateCallBuilder
-
human-readable description of what this reserved address will be used for
- description(String) - Method in class com.ngrok.services.ReservedDomains.CreateCallBuilder
-
human-readable description of what this reserved domain will be used for
- description(String) - Method in class com.ngrok.services.ReservedDomains.UpdateCallBuilder
-
human-readable description of what this reserved domain will be used for
- description(String) - Method in class com.ngrok.services.SshCertificateAuthorities.CreateCallBuilder
-
human-readable description of this SSH Certificate Authority.
- description(String) - Method in class com.ngrok.services.SshCertificateAuthorities.UpdateCallBuilder
-
human-readable description of this SSH Certificate Authority.
- description(String) - Method in class com.ngrok.services.SshCredentials.CreateCallBuilder
-
human-readable description of who or what will use the ssh credential to authenticate.
- description(String) - Method in class com.ngrok.services.SshCredentials.UpdateCallBuilder
-
human-readable description of who or what will use the ssh credential to authenticate.
- description(String) - Method in class com.ngrok.services.SshHostCertificates.CreateCallBuilder
-
human-readable description of this SSH Host Certificate.
- description(String) - Method in class com.ngrok.services.SshHostCertificates.UpdateCallBuilder
-
human-readable description of this SSH Host Certificate.
- description(String) - Method in class com.ngrok.services.SshUserCertificates.CreateCallBuilder
-
human-readable description of this SSH User Certificate.
- description(String) - Method in class com.ngrok.services.SshUserCertificates.UpdateCallBuilder
-
human-readable description of this SSH User Certificate.
- description(String) - Method in class com.ngrok.services.TlsCertificates.CreateCallBuilder
-
human-readable description of this TLS certificate.
- description(String) - Method in class com.ngrok.services.TlsCertificates.UpdateCallBuilder
-
human-readable description of this TLS certificate.
- description(Optional<String>) - Method in class com.ngrok.services.AgentIngresses.CreateCallBuilder
-
human-readable description of the use of this Agent Ingress.
- description(Optional<String>) - Method in class com.ngrok.services.AgentIngresses.UpdateCallBuilder
-
human-readable description of the use of this Agent Ingress.
- description(Optional<String>) - Method in class com.ngrok.services.ApiKeys.CreateCallBuilder
-
human-readable description of what uses the API key to authenticate.
- description(Optional<String>) - Method in class com.ngrok.services.ApiKeys.UpdateCallBuilder
-
human-readable description of what uses the API key to authenticate.
- description(Optional<String>) - Method in class com.ngrok.services.CertificateAuthorities.CreateCallBuilder
-
human-readable description of this Certificate Authority.
- description(Optional<String>) - Method in class com.ngrok.services.CertificateAuthorities.UpdateCallBuilder
-
human-readable description of this Certificate Authority.
- description(Optional<String>) - Method in class com.ngrok.services.Credentials.CreateCallBuilder
-
human-readable description of who or what will use the credential to authenticate.
- description(Optional<String>) - Method in class com.ngrok.services.Credentials.UpdateCallBuilder
-
human-readable description of who or what will use the credential to authenticate.
- description(Optional<String>) - Method in class com.ngrok.services.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>) - Method in class com.ngrok.services.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>) - Method in class com.ngrok.services.EventDestinations.CreateCallBuilder
-
Human-readable description of the Event Destination.
- description(Optional<String>) - Method in class com.ngrok.services.EventDestinations.UpdateCallBuilder
-
Human-readable description of the Event Destination.
- description(Optional<String>) - Method in class com.ngrok.services.EventStreams.CreateCallBuilder
-
Human-readable description of the Event Stream.
- description(Optional<String>) - Method in class com.ngrok.services.EventStreams.UpdateCallBuilder
-
Human-readable description of the Event Stream.
- description(Optional<String>) - Method in class com.ngrok.services.EventSubscriptions.CreateCallBuilder
-
Arbitrary customer supplied information intended to be human readable.
- description(Optional<String>) - Method in class com.ngrok.services.EventSubscriptions.UpdateCallBuilder
-
Arbitrary customer supplied information intended to be human readable.
- description(Optional<String>) - Method in class com.ngrok.services.IpPolicies.CreateCallBuilder
-
human-readable description of the source IPs of this IP policy.
- description(Optional<String>) - Method in class com.ngrok.services.IpPolicies.UpdateCallBuilder
-
human-readable description of the source IPs of this IP policy.
- description(Optional<String>) - Method in class com.ngrok.services.IpPolicyRules.CreateCallBuilder
-
human-readable description of the source IPs of this IP rule.
- description(Optional<String>) - Method in class com.ngrok.services.IpPolicyRules.UpdateCallBuilder
-
human-readable description of the source IPs of this IP rule.
- description(Optional<String>) - Method in class com.ngrok.services.IpRestrictions.CreateCallBuilder
-
human-readable description of this IP restriction.
- description(Optional<String>) - Method in class com.ngrok.services.IpRestrictions.UpdateCallBuilder
-
human-readable description of this IP restriction.
- description(Optional<String>) - Method in class com.ngrok.services.ReservedAddrs.CreateCallBuilder
-
human-readable description of what this reserved address will be used for
- description(Optional<String>) - Method in class com.ngrok.services.ReservedAddrs.UpdateCallBuilder
-
human-readable description of what this reserved address will be used for
- description(Optional<String>) - Method in class com.ngrok.services.ReservedDomains.CreateCallBuilder
-
human-readable description of what this reserved domain will be used for
- description(Optional<String>) - Method in class com.ngrok.services.ReservedDomains.UpdateCallBuilder
-
human-readable description of what this reserved domain will be used for
- description(Optional<String>) - Method in class com.ngrok.services.SshCertificateAuthorities.CreateCallBuilder
-
human-readable description of this SSH Certificate Authority.
- description(Optional<String>) - Method in class com.ngrok.services.SshCertificateAuthorities.UpdateCallBuilder
-
human-readable description of this SSH Certificate Authority.
- description(Optional<String>) - Method in class com.ngrok.services.SshCredentials.CreateCallBuilder
-
human-readable description of who or what will use the ssh credential to authenticate.
- description(Optional<String>) - Method in class com.ngrok.services.SshCredentials.UpdateCallBuilder
-
human-readable description of who or what will use the ssh credential to authenticate.
- description(Optional<String>) - Method in class com.ngrok.services.SshHostCertificates.CreateCallBuilder
-
human-readable description of this SSH Host Certificate.
- description(Optional<String>) - Method in class com.ngrok.services.SshHostCertificates.UpdateCallBuilder
-
human-readable description of this SSH Host Certificate.
- description(Optional<String>) - Method in class com.ngrok.services.SshUserCertificates.CreateCallBuilder
-
human-readable description of this SSH User Certificate.
- description(Optional<String>) - Method in class com.ngrok.services.SshUserCertificates.UpdateCallBuilder
-
human-readable description of this SSH User Certificate.
- description(Optional<String>) - Method in class com.ngrok.services.TlsCertificates.CreateCallBuilder
-
human-readable description of this TLS certificate.
- description(Optional<String>) - Method in class com.ngrok.services.TlsCertificates.UpdateCallBuilder
-
human-readable description of this TLS certificate.
- destinationIds(List<String>) - Method in class com.ngrok.services.EventStreams.CreateCallBuilder
-
A list of Event Destination IDs which should be used for this Event Stream.
- destinationIds(List<String>) - Method in class com.ngrok.services.EventStreams.UpdateCallBuilder
-
A list of Event Destination IDs which should be used for this Event Stream.
- destinationIds(List<String>) - Method in class com.ngrok.services.EventSubscriptions.CreateCallBuilder
-
A list of Event Destination IDs which should be used for this Event Stream.
- destinationIds(List<String>) - Method in class com.ngrok.services.EventSubscriptions.UpdateCallBuilder
-
A list of Event Destination IDs which should be used for this Event Stream.
- destinationIds(Optional<List<String>>) - Method in class com.ngrok.services.EventStreams.CreateCallBuilder
-
A list of Event Destination IDs which should be used for this Event Stream.
- destinationIds(Optional<List<String>>) - Method in class com.ngrok.services.EventStreams.UpdateCallBuilder
-
A list of Event Destination IDs which should be used for this Event Stream.
- destinationIds(Optional<List<String>>) - Method in class com.ngrok.services.EventSubscriptions.CreateCallBuilder
-
A list of Event Destination IDs which should be used for this Event Stream.
- destinationIds(Optional<List<String>>) - Method in class com.ngrok.services.EventSubscriptions.UpdateCallBuilder
-
A list of Event Destination IDs which should be used for this Event Stream.
E
- ellipticCurve(String) - Method in class com.ngrok.services.SshCertificateAuthorities.CreateCallBuilder
-
the type of elliptic curve to use when creating an ECDSA key
- ellipticCurve(Optional<String>) - Method in class com.ngrok.services.SshCertificateAuthorities.CreateCallBuilder
-
the type of elliptic curve to use when creating an ECDSA key
- emailAddresses(List<String>) - Method in class com.ngrok.definitions.EndpointOAuthFacebook.Builder
-
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
- emailAddresses(List<String>) - Method in class com.ngrok.definitions.EndpointOAuthGitHub.Builder
-
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
- emailAddresses(List<String>) - Method in class com.ngrok.definitions.EndpointOAuthGoogle.Builder
-
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
- emailAddresses(List<String>) - Method in class com.ngrok.definitions.EndpointOAuthMicrosoft.Builder
-
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
- emailAddresses(Optional<List<String>>) - Method in class com.ngrok.definitions.EndpointOAuthFacebook.Builder
-
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
- emailAddresses(Optional<List<String>>) - Method in class com.ngrok.definitions.EndpointOAuthGitHub.Builder
-
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
- emailAddresses(Optional<List<String>>) - Method in class com.ngrok.definitions.EndpointOAuthGoogle.Builder
-
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
- emailAddresses(Optional<List<String>>) - Method in class com.ngrok.definitions.EndpointOAuthMicrosoft.Builder
-
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
- emailDomains(List<String>) - Method in class com.ngrok.definitions.EndpointOAuthFacebook.Builder
-
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
- emailDomains(List<String>) - Method in class com.ngrok.definitions.EndpointOAuthGitHub.Builder
-
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
- emailDomains(List<String>) - Method in class com.ngrok.definitions.EndpointOAuthGoogle.Builder
-
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
- emailDomains(List<String>) - Method in class com.ngrok.definitions.EndpointOAuthMicrosoft.Builder
-
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
- emailDomains(Optional<List<String>>) - Method in class com.ngrok.definitions.EndpointOAuthFacebook.Builder
-
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
- emailDomains(Optional<List<String>>) - Method in class com.ngrok.definitions.EndpointOAuthGitHub.Builder
-
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
- emailDomains(Optional<List<String>>) - Method in class com.ngrok.definitions.EndpointOAuthGoogle.Builder
-
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
- emailDomains(Optional<List<String>>) - Method in class com.ngrok.definitions.EndpointOAuthMicrosoft.Builder
-
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
- enabled(boolean) - Method in class com.ngrok.definitions.EndpointCircuitBreaker.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(boolean) - Method in class com.ngrok.definitions.EndpointCompression.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(boolean) - Method in class com.ngrok.definitions.EndpointIpPolicyMutate.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(boolean) - Method in class com.ngrok.definitions.EndpointLoggingMutate.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(boolean) - Method in class com.ngrok.definitions.EndpointMutualTlsMutate.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(boolean) - Method in class com.ngrok.definitions.EndpointOAuth.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(boolean) - Method in class com.ngrok.definitions.EndpointOidc.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(boolean) - Method in class com.ngrok.definitions.EndpointRequestHeaders.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(boolean) - Method in class com.ngrok.definitions.EndpointResponseHeaders.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(boolean) - Method in class com.ngrok.definitions.EndpointSamlMutate.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(boolean) - Method in class com.ngrok.definitions.EndpointTlsTermination.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(boolean) - Method in class com.ngrok.definitions.EndpointWebhookValidation.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(Optional<Boolean>) - Method in class com.ngrok.definitions.EndpointCircuitBreaker.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(Optional<Boolean>) - Method in class com.ngrok.definitions.EndpointCompression.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(Optional<Boolean>) - Method in class com.ngrok.definitions.EndpointIpPolicyMutate.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(Optional<Boolean>) - Method in class com.ngrok.definitions.EndpointLoggingMutate.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(Optional<Boolean>) - Method in class com.ngrok.definitions.EndpointMutualTlsMutate.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(Optional<Boolean>) - Method in class com.ngrok.definitions.EndpointOAuth.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(Optional<Boolean>) - Method in class com.ngrok.definitions.EndpointOidc.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(Optional<Boolean>) - Method in class com.ngrok.definitions.EndpointRequestHeaders.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(Optional<Boolean>) - Method in class com.ngrok.definitions.EndpointResponseHeaders.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(Optional<Boolean>) - Method in class com.ngrok.definitions.EndpointSamlMutate.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(Optional<Boolean>) - Method in class com.ngrok.definitions.EndpointTlsTermination.Builder
-
trueif the module will be applied to traffic,falseto disable. - enabled(Optional<Boolean>) - Method in class com.ngrok.definitions.EndpointWebhookValidation.Builder
-
trueif the module will be applied to traffic,falseto disable. - EndpointCircuitBreaker - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointCircuitBreakerresource. - EndpointCircuitBreaker.Builder - Class in com.ngrok.definitions
-
Builder class for
EndpointCircuitBreaker. - EndpointCircuitBreakerModule - Class in com.ngrok.services
-
An API client for
EndpointCircuitBreakerModule. - EndpointCircuitBreakerModule(NgrokApiClient) - Constructor for class com.ngrok.services.EndpointCircuitBreakerModule
-
Creates a new sub-client for EndpointCircuitBreakerModule.
- EndpointCircuitBreakerModule.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- EndpointCircuitBreakerModule.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- EndpointCircuitBreakerModule.ReplaceCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Replace API call.
- EndpointCompression - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointCompressionresource. - EndpointCompression.Builder - Class in com.ngrok.definitions
-
Builder class for
EndpointCompression. - EndpointCompressionModule - Class in com.ngrok.services
-
An API client for
EndpointCompressionModule. - EndpointCompressionModule(NgrokApiClient) - Constructor for class com.ngrok.services.EndpointCompressionModule
-
Creates a new sub-client for EndpointCompressionModule.
- EndpointCompressionModule.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- EndpointCompressionModule.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- EndpointCompressionModule.ReplaceCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Replace API call.
- EndpointConfiguration - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointConfigurationresource. - 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>) - Constructor for class com.ngrok.definitions.EndpointConfiguration
-
Creates a new instance of
EndpointConfiguration. - endpointConfigurationId(String) - Method in class com.ngrok.services.ReservedAddrs.CreateCallBuilder
-
ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address
- endpointConfigurationId(String) - Method in class com.ngrok.services.ReservedAddrs.UpdateCallBuilder
-
ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address
- endpointConfigurationId(Optional<String>) - Method in class com.ngrok.services.ReservedAddrs.CreateCallBuilder
-
ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address
- endpointConfigurationId(Optional<String>) - Method in class com.ngrok.services.ReservedAddrs.UpdateCallBuilder
-
ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address
- EndpointConfigurationList - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointConfigurationListresource. - EndpointConfigurationList(List<EndpointConfiguration>, URI, Optional<URI>) - Constructor for class com.ngrok.definitions.EndpointConfigurationList
-
Creates a new instance of
EndpointConfigurationList. - endpointConfigurations() - Method in class com.ngrok.Ngrok
-
Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled.
- EndpointConfigurations - Class in com.ngrok.services
-
Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled.
- EndpointConfigurations(NgrokApiClient) - Constructor for class com.ngrok.services.EndpointConfigurations
-
Creates a new sub-client for EndpointConfigurations.
- EndpointConfigurations.CreateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Create API call.
- EndpointConfigurations.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- EndpointConfigurations.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- EndpointConfigurations.ListCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent List API call.
- EndpointConfigurations.UpdateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Update API call.
- EndpointIpPolicy - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointIpPolicyresource. - EndpointIpPolicy(Optional<Boolean>, List<Ref>) - Constructor for class com.ngrok.definitions.EndpointIpPolicy
-
Creates a new instance of
EndpointIpPolicy. - EndpointIpPolicyModule - Class in com.ngrok.services
-
An API client for
EndpointIpPolicyModule. - EndpointIpPolicyModule(NgrokApiClient) - Constructor for class com.ngrok.services.EndpointIpPolicyModule
-
Creates a new sub-client for EndpointIpPolicyModule.
- EndpointIpPolicyModule.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- EndpointIpPolicyModule.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- EndpointIpPolicyModule.ReplaceCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Replace API call.
- EndpointIpPolicyMutate - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointIpPolicyMutateresource. - EndpointIpPolicyMutate.Builder - Class in com.ngrok.definitions
-
Builder class for
EndpointIpPolicyMutate. - EndpointLogging - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointLoggingresource. - EndpointLogging(Optional<Boolean>, List<Ref>) - Constructor for class com.ngrok.definitions.EndpointLogging
-
Creates a new instance of
EndpointLogging. - EndpointLoggingModule - Class in com.ngrok.services
-
An API client for
EndpointLoggingModule. - EndpointLoggingModule(NgrokApiClient) - Constructor for class com.ngrok.services.EndpointLoggingModule
-
Creates a new sub-client for EndpointLoggingModule.
- EndpointLoggingModule.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- EndpointLoggingModule.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- EndpointLoggingModule.ReplaceCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Replace API call.
- EndpointLoggingMutate - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointLoggingMutateresource. - EndpointLoggingMutate.Builder - Class in com.ngrok.definitions
-
Builder class for
EndpointLoggingMutate. - EndpointMutualTls - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointMutualTlsresource. - EndpointMutualTls(Optional<Boolean>, List<Ref>) - Constructor for class com.ngrok.definitions.EndpointMutualTls
-
Creates a new instance of
EndpointMutualTls. - EndpointMutualTlsModule - Class in com.ngrok.services
-
An API client for
EndpointMutualTlsModule. - EndpointMutualTlsModule(NgrokApiClient) - Constructor for class com.ngrok.services.EndpointMutualTlsModule
-
Creates a new sub-client for EndpointMutualTlsModule.
- EndpointMutualTlsModule.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- EndpointMutualTlsModule.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- EndpointMutualTlsModule.ReplaceCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Replace API call.
- EndpointMutualTlsMutate - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointMutualTlsMutateresource. - EndpointMutualTlsMutate.Builder - Class in com.ngrok.definitions
-
Builder class for
EndpointMutualTlsMutate. - EndpointOAuth - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointOAuthresource. - EndpointOAuth.Builder - Class in com.ngrok.definitions
-
Builder class for
EndpointOAuth. - EndpointOAuthFacebook - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointOAuthFacebookresource. - EndpointOAuthFacebook.Builder - Class in com.ngrok.definitions
-
Builder class for
EndpointOAuthFacebook. - EndpointOAuthGitHub - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointOAuthGitHubresource. - EndpointOAuthGitHub.Builder - Class in com.ngrok.definitions
-
Builder class for
EndpointOAuthGitHub. - EndpointOAuthGoogle - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointOAuthGoogleresource. - EndpointOAuthGoogle.Builder - Class in com.ngrok.definitions
-
Builder class for
EndpointOAuthGoogle. - EndpointOAuthMicrosoft - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointOAuthMicrosoftresource. - EndpointOAuthMicrosoft.Builder - Class in com.ngrok.definitions
-
Builder class for
EndpointOAuthMicrosoft. - EndpointOAuthModule - Class in com.ngrok.services
-
An API client for
EndpointOAuthModule. - EndpointOAuthModule(NgrokApiClient) - Constructor for class com.ngrok.services.EndpointOAuthModule
-
Creates a new sub-client for EndpointOAuthModule.
- EndpointOAuthModule.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- EndpointOAuthModule.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- EndpointOAuthModule.ReplaceCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Replace API call.
- EndpointOAuthProvider - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointOAuthProviderresource. - EndpointOAuthProvider.Builder - Class in com.ngrok.definitions
-
Builder class for
EndpointOAuthProvider. - EndpointOidc - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointOidcresource. - EndpointOidc.Builder - Class in com.ngrok.definitions
-
Builder class for
EndpointOidc. - EndpointOidcModule - Class in com.ngrok.services
-
An API client for
EndpointOidcModule. - EndpointOidcModule(NgrokApiClient) - Constructor for class com.ngrok.services.EndpointOidcModule
-
Creates a new sub-client for EndpointOidcModule.
- EndpointOidcModule.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- EndpointOidcModule.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- EndpointOidcModule.ReplaceCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Replace API call.
- EndpointRequestHeaders - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointRequestHeadersresource. - EndpointRequestHeaders.Builder - Class in com.ngrok.definitions
-
Builder class for
EndpointRequestHeaders. - EndpointRequestHeadersModule - Class in com.ngrok.services
-
An API client for
EndpointRequestHeadersModule. - EndpointRequestHeadersModule(NgrokApiClient) - Constructor for class com.ngrok.services.EndpointRequestHeadersModule
-
Creates a new sub-client for EndpointRequestHeadersModule.
- EndpointRequestHeadersModule.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- EndpointRequestHeadersModule.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- EndpointRequestHeadersModule.ReplaceCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Replace API call.
- EndpointResponseHeaders - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointResponseHeadersresource. - EndpointResponseHeaders.Builder - Class in com.ngrok.definitions
-
Builder class for
EndpointResponseHeaders. - EndpointResponseHeadersModule - Class in com.ngrok.services
-
An API client for
EndpointResponseHeadersModule. - EndpointResponseHeadersModule(NgrokApiClient) - Constructor for class com.ngrok.services.EndpointResponseHeadersModule
-
Creates a new sub-client for EndpointResponseHeadersModule.
- EndpointResponseHeadersModule.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- EndpointResponseHeadersModule.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- EndpointResponseHeadersModule.ReplaceCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Replace API call.
- EndpointSaml - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointSamlresource. - EndpointSaml(Optional<Boolean>, Boolean, String, Long, Duration, String, Boolean, Optional<Boolean>, List<String>, String, URI, URI, String, URI, String) - Constructor for class com.ngrok.definitions.EndpointSaml
-
Creates a new instance of
EndpointSaml. - EndpointSamlModule - Class in com.ngrok.services
-
An API client for
EndpointSamlModule. - EndpointSamlModule(NgrokApiClient) - Constructor for class com.ngrok.services.EndpointSamlModule
-
Creates a new sub-client for EndpointSamlModule.
- EndpointSamlModule.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- EndpointSamlModule.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- EndpointSamlModule.ReplaceCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Replace API call.
- EndpointSamlMutate - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointSamlMutateresource. - EndpointSamlMutate.Builder - Class in com.ngrok.definitions
-
Builder class for
EndpointSamlMutate. - EndpointTlsTermination - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointTlsTerminationresource. - EndpointTlsTermination.Builder - Class in com.ngrok.definitions
-
Builder class for
EndpointTlsTermination. - EndpointTlsTerminationModule - Class in com.ngrok.services
-
An API client for
EndpointTlsTerminationModule. - EndpointTlsTerminationModule(NgrokApiClient) - Constructor for class com.ngrok.services.EndpointTlsTerminationModule
-
Creates a new sub-client for EndpointTlsTerminationModule.
- EndpointTlsTerminationModule.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- EndpointTlsTerminationModule.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- EndpointTlsTerminationModule.ReplaceCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Replace API call.
- EndpointWebhookValidation - Class in com.ngrok.definitions
-
A class encapsulating the
EndpointWebhookValidationresource. - EndpointWebhookValidation.Builder - Class in com.ngrok.definitions
-
Builder class for
EndpointWebhookValidation. - EndpointWebhookValidationModule - Class in com.ngrok.services
-
An API client for
EndpointWebhookValidationModule. - EndpointWebhookValidationModule(NgrokApiClient) - Constructor for class com.ngrok.services.EndpointWebhookValidationModule
-
Creates a new sub-client for EndpointWebhookValidationModule.
- EndpointWebhookValidationModule.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- EndpointWebhookValidationModule.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- EndpointWebhookValidationModule.ReplaceCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Replace API call.
- enforced(boolean) - Method in class com.ngrok.services.IpRestrictions.CreateCallBuilder
-
true if the IP restriction will be enforced.
- enforced(boolean) - Method in class com.ngrok.services.IpRestrictions.UpdateCallBuilder
-
true if the IP restriction will be enforced.
- enforced(Optional<Boolean>) - Method in class com.ngrok.services.IpRestrictions.CreateCallBuilder
-
true if the IP restriction will be enforced.
- enforced(Optional<Boolean>) - Method in class com.ngrok.services.IpRestrictions.UpdateCallBuilder
-
true if the IP restriction will be enforced.
- equals(Object) - Method in class com.ngrok.definitions.AbuseReport
- equals(Object) - Method in class com.ngrok.definitions.AbuseReportHostname
- equals(Object) - Method in class com.ngrok.definitions.AgentIngress
- equals(Object) - Method in class com.ngrok.definitions.AgentIngressList
- equals(Object) - Method in class com.ngrok.definitions.ApiKey
- equals(Object) - Method in class com.ngrok.definitions.ApiKeyList
- equals(Object) - Method in class com.ngrok.definitions.AwsAuth
- equals(Object) - Method in class com.ngrok.definitions.AwsCredentials
- equals(Object) - Method in class com.ngrok.definitions.AwsRole
- equals(Object) - Method in class com.ngrok.definitions.CertificateAuthority
- equals(Object) - Method in class com.ngrok.definitions.CertificateAuthorityList
- equals(Object) - Method in class com.ngrok.definitions.Credential
- equals(Object) - Method in class com.ngrok.definitions.CredentialList
- equals(Object) - Method in class com.ngrok.definitions.EndpointCircuitBreaker
- equals(Object) - Method in class com.ngrok.definitions.EndpointCompression
- equals(Object) - Method in class com.ngrok.definitions.EndpointConfiguration
- equals(Object) - Method in class com.ngrok.definitions.EndpointConfigurationList
- equals(Object) - Method in class com.ngrok.definitions.EndpointIpPolicy
- equals(Object) - Method in class com.ngrok.definitions.EndpointIpPolicyMutate
- equals(Object) - Method in class com.ngrok.definitions.EndpointLogging
- equals(Object) - Method in class com.ngrok.definitions.EndpointLoggingMutate
- equals(Object) - Method in class com.ngrok.definitions.EndpointMutualTls
- equals(Object) - Method in class com.ngrok.definitions.EndpointMutualTlsMutate
- equals(Object) - Method in class com.ngrok.definitions.EndpointOAuth
- equals(Object) - Method in class com.ngrok.definitions.EndpointOAuthFacebook
- equals(Object) - Method in class com.ngrok.definitions.EndpointOAuthGitHub
- equals(Object) - Method in class com.ngrok.definitions.EndpointOAuthGoogle
- equals(Object) - Method in class com.ngrok.definitions.EndpointOAuthMicrosoft
- equals(Object) - Method in class com.ngrok.definitions.EndpointOAuthProvider
- equals(Object) - Method in class com.ngrok.definitions.EndpointOidc
- equals(Object) - Method in class com.ngrok.definitions.EndpointRequestHeaders
- equals(Object) - Method in class com.ngrok.definitions.EndpointResponseHeaders
- equals(Object) - Method in class com.ngrok.definitions.EndpointSaml
- equals(Object) - Method in class com.ngrok.definitions.EndpointSamlMutate
- equals(Object) - Method in class com.ngrok.definitions.EndpointTlsTermination
- equals(Object) - Method in class com.ngrok.definitions.EndpointWebhookValidation
- equals(Object) - Method in class com.ngrok.definitions.EventDestination
- equals(Object) - Method in class com.ngrok.definitions.EventDestinationList
- equals(Object) - Method in class com.ngrok.definitions.EventSource
- equals(Object) - Method in class com.ngrok.definitions.EventSourceList
- equals(Object) - Method in class com.ngrok.definitions.EventSourceReplace
- equals(Object) - Method in class com.ngrok.definitions.EventStream
- equals(Object) - Method in class com.ngrok.definitions.EventStreamList
- equals(Object) - Method in class com.ngrok.definitions.EventSubscription
- equals(Object) - Method in class com.ngrok.definitions.EventSubscriptionList
- equals(Object) - Method in class com.ngrok.definitions.EventTarget
- equals(Object) - Method in class com.ngrok.definitions.EventTargetCloudwatchLogs
- equals(Object) - Method in class com.ngrok.definitions.EventTargetFirehose
- equals(Object) - Method in class com.ngrok.definitions.EventTargetKinesis
- equals(Object) - Method in class com.ngrok.definitions.IpPolicy
- equals(Object) - Method in class com.ngrok.definitions.IpPolicyList
- equals(Object) - Method in class com.ngrok.definitions.IpPolicyRule
- equals(Object) - Method in class com.ngrok.definitions.IpPolicyRuleList
- equals(Object) - Method in class com.ngrok.definitions.IpRestriction
- equals(Object) - Method in class com.ngrok.definitions.IpRestrictionList
- equals(Object) - Method in class com.ngrok.definitions.Ref
- equals(Object) - Method in class com.ngrok.definitions.ReservedAddr
- equals(Object) - Method in class com.ngrok.definitions.ReservedAddrList
- equals(Object) - Method in class com.ngrok.definitions.ReservedDomain
- equals(Object) - Method in class com.ngrok.definitions.ReservedDomainCertJob
- equals(Object) - Method in class com.ngrok.definitions.ReservedDomainCertPolicy
- equals(Object) - Method in class com.ngrok.definitions.ReservedDomainCertStatus
- equals(Object) - Method in class com.ngrok.definitions.ReservedDomainList
- equals(Object) - Method in class com.ngrok.definitions.SshCertificateAuthority
- equals(Object) - Method in class com.ngrok.definitions.SshCertificateAuthorityList
- equals(Object) - Method in class com.ngrok.definitions.SshCredential
- equals(Object) - Method in class com.ngrok.definitions.SshCredentialList
- equals(Object) - Method in class com.ngrok.definitions.SshHostCertificate
- equals(Object) - Method in class com.ngrok.definitions.SshHostCertificateList
- equals(Object) - Method in class com.ngrok.definitions.SshUserCertificate
- equals(Object) - Method in class com.ngrok.definitions.SshUserCertificateList
- equals(Object) - Method in class com.ngrok.definitions.TlsCertificate
- equals(Object) - Method in class com.ngrok.definitions.TlsCertificateList
- equals(Object) - Method in class com.ngrok.definitions.TlsCertificateSaNs
- equals(Object) - Method in class com.ngrok.definitions.Tunnel
- equals(Object) - Method in class com.ngrok.definitions.TunnelList
- equals(Object) - Method in class com.ngrok.definitions.TunnelSession
- equals(Object) - Method in class com.ngrok.definitions.TunnelSessionList
- errorThresholdPercentage(double) - Method in class com.ngrok.definitions.EndpointCircuitBreaker.Builder
-
Error threshold percentage should be between 0 - 1.0, not 0-100.0
- errorThresholdPercentage(Optional<Double>) - Method in class com.ngrok.definitions.EndpointCircuitBreaker.Builder
-
Error threshold percentage should be between 0 - 1.0, not 0-100.0
- EventDestination - Class in com.ngrok.definitions
-
A class encapsulating the
EventDestinationresource. - EventDestination(String, String, OffsetDateTime, String, String, EventTarget, URI) - Constructor for class com.ngrok.definitions.EventDestination
-
Creates a new instance of
EventDestination. - EventDestinationList - Class in com.ngrok.definitions
-
A class encapsulating the
EventDestinationListresource. - EventDestinationList(List<EventDestination>, URI, Optional<URI>) - Constructor for class com.ngrok.definitions.EventDestinationList
-
Creates a new instance of
EventDestinationList. - eventDestinations() - Method in class com.ngrok.Ngrok
-
Creates a service client for EventDestinations.
- EventDestinations - Class in com.ngrok.services
-
An API client for
EventDestinations. - EventDestinations(NgrokApiClient) - Constructor for class com.ngrok.services.EventDestinations
-
Creates a new sub-client for EventDestinations.
- EventDestinations.CreateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Create API call.
- EventDestinations.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- EventDestinations.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- EventDestinations.ListCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent List API call.
- EventDestinations.UpdateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Update API call.
- EventSource - Class in com.ngrok.definitions
-
A class encapsulating the
EventSourceresource. - EventSource(String, URI) - Constructor for class com.ngrok.definitions.EventSource
-
Creates a new instance of
EventSource. - EventSourceList - Class in com.ngrok.definitions
-
A class encapsulating the
EventSourceListresource. - EventSourceList(List<EventSource>, URI) - Constructor for class com.ngrok.definitions.EventSourceList
-
Creates a new instance of
EventSourceList. - EventSourceReplace - Class in com.ngrok.definitions
-
A class encapsulating the
EventSourceReplaceresource. - EventSourceReplace.Builder - Class in com.ngrok.definitions
-
Builder class for
EventSourceReplace. - eventSources() - Method in class com.ngrok.Ngrok
-
Creates a service client for EventSources.
- EventSources - Class in com.ngrok.services
-
An API client for
EventSources. - EventSources(NgrokApiClient) - Constructor for class com.ngrok.services.EventSources
-
Creates a new sub-client for EventSources.
- EventSources.CreateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Create API call.
- EventSources.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- EventSources.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- EventSources.ListCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent List API call.
- EventSources.UpdateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Update API call.
- EventStream - Class in com.ngrok.definitions
-
A class encapsulating the
EventStreamresource. - EventStream(String, URI, OffsetDateTime, String, String, List<String>, String, List<String>, Double) - Constructor for class com.ngrok.definitions.EventStream
-
Creates a new instance of
EventStream. - eventStreamIds(List<String>) - Method in class com.ngrok.definitions.EndpointLoggingMutate.Builder
-
list of all EventStreams that will be used to configure and export this endpoint's logs
- eventStreamIds(Optional<List<String>>) - Method in class com.ngrok.definitions.EndpointLoggingMutate.Builder
-
list of all EventStreams that will be used to configure and export this endpoint's logs
- EventStreamList - Class in com.ngrok.definitions
-
A class encapsulating the
EventStreamListresource. - EventStreamList(List<EventStream>, URI, Optional<URI>) - Constructor for class com.ngrok.definitions.EventStreamList
-
Creates a new instance of
EventStreamList. - eventStreams() - Method in class com.ngrok.Ngrok
-
Creates a service client for EventStreams.
- EventStreams - Class in com.ngrok.services
-
An API client for
EventStreams. - EventStreams(NgrokApiClient) - Constructor for class com.ngrok.services.EventStreams
-
Creates a new sub-client for EventStreams.
- EventStreams.CreateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Create API call.
- EventStreams.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- EventStreams.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- EventStreams.ListCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent List API call.
- EventStreams.UpdateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Update API call.
- EventSubscription - Class in com.ngrok.definitions
-
A class encapsulating the
EventSubscriptionresource. - EventSubscription(String, URI, OffsetDateTime, String, String, List<EventSource>, List<Ref>) - Constructor for class com.ngrok.definitions.EventSubscription
-
Creates a new instance of
EventSubscription. - EventSubscriptionList - Class in com.ngrok.definitions
-
A class encapsulating the
EventSubscriptionListresource. - EventSubscriptionList(List<EventSubscription>, URI, Optional<URI>) - Constructor for class com.ngrok.definitions.EventSubscriptionList
-
Creates a new instance of
EventSubscriptionList. - eventSubscriptions() - Method in class com.ngrok.Ngrok
-
Creates a service client for EventSubscriptions.
- EventSubscriptions - Class in com.ngrok.services
-
An API client for
EventSubscriptions. - EventSubscriptions(NgrokApiClient) - Constructor for class com.ngrok.services.EventSubscriptions
-
Creates a new sub-client for EventSubscriptions.
- EventSubscriptions.CreateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Create API call.
- EventSubscriptions.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- EventSubscriptions.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- EventSubscriptions.ListCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent List API call.
- EventSubscriptions.UpdateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Update API call.
- EventTarget - Class in com.ngrok.definitions
-
A class encapsulating the
EventTargetresource. - EventTarget.Builder - Class in com.ngrok.definitions
-
Builder class for
EventTarget. - EventTargetCloudwatchLogs - Class in com.ngrok.definitions
-
A class encapsulating the
EventTargetCloudwatchLogsresource. - EventTargetCloudwatchLogs.Builder - Class in com.ngrok.definitions
-
Builder class for
EventTargetCloudwatchLogs. - EventTargetFirehose - Class in com.ngrok.definitions
-
A class encapsulating the
EventTargetFirehoseresource. - EventTargetFirehose.Builder - Class in com.ngrok.definitions
-
Builder class for
EventTargetFirehose. - EventTargetKinesis - Class in com.ngrok.definitions
-
A class encapsulating the
EventTargetKinesisresource. - EventTargetKinesis.Builder - Class in com.ngrok.definitions
-
Builder class for
EventTargetKinesis. - eventType(String) - Method in class com.ngrok.services.EventStreams.CreateCallBuilder
-
The protocol that determines which events will be collected.
- eventType(Optional<String>) - Method in class com.ngrok.services.EventStreams.CreateCallBuilder
-
The protocol that determines which events will be collected.
- extensions(Map<String, String>) - Method in class com.ngrok.services.SshUserCertificates.CreateCallBuilder
-
A map of extensions included in the certificate.
- extensions(Optional<Map<String, String>>) - Method in class com.ngrok.services.SshUserCertificates.CreateCallBuilder
-
A map of extensions included in the certificate.
F
- facebook(EndpointOAuthFacebook) - Method in class com.ngrok.definitions.EndpointOAuthProvider.Builder
-
configuration for using facebook as the identity provider
- facebook(Optional<EndpointOAuthFacebook>) - Method in class com.ngrok.definitions.EndpointOAuthProvider.Builder
-
configuration for using facebook as the identity provider
- fields(List<String>) - Method in class com.ngrok.services.EventStreams.CreateCallBuilder
-
A list of protocol-specific fields you want to collect on each event.
- fields(List<String>) - Method in class com.ngrok.services.EventStreams.UpdateCallBuilder
-
A list of protocol-specific fields you want to collect on each event.
- fields(Optional<List<String>>) - Method in class com.ngrok.services.EventStreams.CreateCallBuilder
-
A list of protocol-specific fields you want to collect on each event.
- fields(Optional<List<String>>) - Method in class com.ngrok.services.EventStreams.UpdateCallBuilder
-
A list of protocol-specific fields you want to collect on each event.
- firehose(EventTargetFirehose) - Method in class com.ngrok.definitions.EventTarget.Builder
-
Configuration used to send events to Amazon Kinesis Data Firehose.
- firehose(Optional<EventTargetFirehose>) - Method in class com.ngrok.definitions.EventTarget.Builder
-
Configuration used to send events to Amazon Kinesis Data Firehose.
- forceAuthn(boolean) - Method in class com.ngrok.definitions.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>) - Method in class com.ngrok.definitions.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) - Method in class com.ngrok.services.EventDestinations.CreateCallBuilder
-
The output format you would like to serialize events into when sending to their target.
- format(String) - Method in class com.ngrok.services.EventDestinations.UpdateCallBuilder
-
The output format you would like to serialize events into when sending to their target.
- format(Optional<String>) - Method in class com.ngrok.services.EventDestinations.CreateCallBuilder
-
The output format you would like to serialize events into when sending to their target.
- format(Optional<String>) - Method in class com.ngrok.services.EventDestinations.UpdateCallBuilder
-
The output format you would like to serialize events into when sending to their target.
G
- get(String) - Method in class com.ngrok.services.AbuseReports
-
Get the detailed status of abuse report by ID.
- get(String) - Method in class com.ngrok.services.AgentIngresses
-
Get the details of an Agent Ingress by ID.
- get(String) - Method in class com.ngrok.services.ApiKeys
-
Get the details of an API key by ID.
- get(String) - Method in class com.ngrok.services.CertificateAuthorities
-
Get detailed information about a certficate authority See also https://ngrok.com/docs/api#api-certificate-authorities-get.
- get(String) - Method in class com.ngrok.services.Credentials
-
Get detailed information about a tunnel authtoken credential See also https://ngrok.com/docs/api#api-credentials-get.
- get(String) - Method in class com.ngrok.services.EndpointCircuitBreakerModule
-
Creates a call builder for the Get API operation.
- get(String) - Method in class com.ngrok.services.EndpointCompressionModule
-
Creates a call builder for the Get API operation.
- get(String) - Method in class com.ngrok.services.EndpointConfigurations
-
Returns detailed information about an endpoint configuration See also https://ngrok.com/docs/api#api-endpoint-configurations-get.
- get(String) - Method in class com.ngrok.services.EndpointIpPolicyModule
-
Creates a call builder for the Get API operation.
- get(String) - Method in class com.ngrok.services.EndpointLoggingModule
-
Creates a call builder for the Get API operation.
- get(String) - Method in class com.ngrok.services.EndpointMutualTlsModule
-
Creates a call builder for the Get API operation.
- get(String) - Method in class com.ngrok.services.EndpointOAuthModule
-
Creates a call builder for the Get API operation.
- get(String) - Method in class com.ngrok.services.EndpointOidcModule
-
Creates a call builder for the Get API operation.
- get(String) - Method in class com.ngrok.services.EndpointRequestHeadersModule
-
Creates a call builder for the Get API operation.
- get(String) - Method in class com.ngrok.services.EndpointResponseHeadersModule
-
Creates a call builder for the Get API operation.
- get(String) - Method in class com.ngrok.services.EndpointSamlModule
-
Creates a call builder for the Get API operation.
- get(String) - Method in class com.ngrok.services.EndpointTlsTerminationModule
-
Creates a call builder for the Get API operation.
- get(String) - Method in class com.ngrok.services.EndpointWebhookValidationModule
-
Creates a call builder for the Get API operation.
- get(String) - Method in class com.ngrok.services.EventDestinations
-
Get detailed information about an Event Destination by ID.
- get(String) - Method in class com.ngrok.services.EventStreams
-
Get detailed information about an Event Stream by ID.
- get(String) - Method in class com.ngrok.services.EventSubscriptions
-
Get an Event Subscription by ID.
- get(String) - Method in class com.ngrok.services.IpPolicies
-
Get detailed information about an IP policy by ID.
- get(String) - Method in class com.ngrok.services.IpPolicyRules
-
Get detailed information about an IP policy rule by ID.
- get(String) - Method in class com.ngrok.services.IpRestrictions
-
Get detailed information about an IP restriction See also https://ngrok.com/docs/api#api-ip-restrictions-get.
- get(String) - Method in class com.ngrok.services.ReservedAddrs
-
Get the details of a reserved address.
- get(String) - Method in class com.ngrok.services.ReservedDomains
-
Get the details of a reserved domain.
- get(String) - Method in class com.ngrok.services.SshCertificateAuthorities
-
Get detailed information about an SSH Certficate Authority See also https://ngrok.com/docs/api#api-ssh-certificate-authorities-get.
- get(String) - Method in class com.ngrok.services.SshCredentials
-
Get detailed information about an ssh_credential See also https://ngrok.com/docs/api#api-ssh-credentials-get.
- get(String) - Method in class com.ngrok.services.SshHostCertificates
-
Get detailed information about an SSH Host Certficate See also https://ngrok.com/docs/api#api-ssh-host-certificates-get.
- get(String) - Method in class com.ngrok.services.SshUserCertificates
-
Get detailed information about an SSH User Certficate See also https://ngrok.com/docs/api#api-ssh-user-certificates-get.
- get(String) - Method in class com.ngrok.services.TlsCertificates
-
Get detailed information about a TLS certificate See also https://ngrok.com/docs/api#api-tls-certificates-get.
- get(String) - Method in class com.ngrok.services.TunnelSessions
-
Get the detailed status of a tunnel session by ID See also https://ngrok.com/docs/api#api-tunnel-sessions-get.
- get(String, String) - Method in class com.ngrok.services.EventSources
-
Get the details for a given type that triggers for the given event subscription See also https://ngrok.com/docs/api#api-event-sources-get.
- GET - Enum constant in enum com.ngrok.NgrokApiClient.HttpMethod
-
HTTP GET
- getAcl() - Method in class com.ngrok.definitions.Credential
-
optional list of ACL rules.
- getAcl() - Method in class com.ngrok.definitions.SshCredential
-
optional list of ACL rules.
- getAcmeChallengeCnameTarget() - Method in class com.ngrok.definitions.ReservedDomain
-
DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name.
- getAction() - Method in class com.ngrok.definitions.IpPolicy
-
the IP policy action.
- getAdd() - Method in class com.ngrok.definitions.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() - Method in class com.ngrok.definitions.EndpointResponseHeaders
-
a map of header key to header value that will be injected into the HTTP Response returned to the HTTP client
- getAddr() - Method in class com.ngrok.definitions.ReservedAddr
-
hostname:port of the reserved address that was assigned at creation time
- getAgentVersion() - Method in class com.ngrok.definitions.TunnelSession
-
version of the ngrok agent that started this ngrok tunnel session
- getAllowIdpInitiated() - Method in class com.ngrok.definitions.EndpointSaml
-
If true, the IdP may initiate a login directly (e.g.
- getAllowIdpInitiated() - Method in class com.ngrok.definitions.EndpointSamlMutate
-
If true, the IdP may initiate a login directly (e.g.
- getAssertionConsumerServiceUrl() - Method in class com.ngrok.definitions.EndpointSaml
-
The public URL of the SP's Assertion Consumer Service.
- getAuth() - Method in class com.ngrok.definitions.EventTargetCloudwatchLogs
-
Configuration for how to authenticate into your AWS account.
- getAuth() - Method in class com.ngrok.definitions.EventTargetFirehose
-
Configuration for how to authenticate into your AWS account.
- getAuth() - Method in class com.ngrok.definitions.EventTargetKinesis
-
Configuration for how to authenticate into your AWS account.
- getAuthCheckInterval() - Method in class com.ngrok.definitions.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() - Method in class com.ngrok.definitions.ReservedDomainCertPolicy
-
certificate authority to request certificates from.
- getAuthorizedGroups() - Method in class com.ngrok.definitions.EndpointSaml
-
If present, only users who are a member of one of the listed groups may access the target endpoint.
- getAuthorizedGroups() - Method in class com.ngrok.definitions.EndpointSamlMutate
-
If present, only users who are a member of one of the listed groups may access the target endpoint.
- getAwsAccessKeyId() - Method in class com.ngrok.definitions.AwsCredentials
-
The ID portion of an AWS access key.
- getAwsSecretAccessKey() - Method in class com.ngrok.definitions.AwsCredentials
-
The secret portion of an AWS access key.
- getCaPem() - Method in class com.ngrok.definitions.CertificateAuthority
-
raw PEM of the Certificate Authority
- getCertificate() - Method in class com.ngrok.definitions.ReservedDomain
-
object referencing the TLS certificate used for connections to this domain.
- getCertificate() - Method in class com.ngrok.definitions.SshHostCertificate
-
the signed SSH certificate in OpenSSH Authorized Keys format.
- getCertificate() - Method in class com.ngrok.definitions.SshUserCertificate
-
the signed SSH certificate in OpenSSH Authorized Keys Format.
- getCertificateAuthorities() - Method in class com.ngrok.definitions.CertificateAuthorityList
-
the list of all certificate authorities on this account
- getCertificateAuthorities() - Method in class com.ngrok.definitions.EndpointMutualTls
-
PEM-encoded CA certificates that will be used to validate.
- getCertificateAuthorityIds() - Method in class com.ngrok.definitions.EndpointMutualTlsMutate
-
list of certificate authorities that will be used to validate the TLS client certificate presnted by the initiatiator of the TLS connection
- getCertificateManagementPolicy() - Method in class com.ngrok.definitions.ReservedDomain
-
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
- getCertificateManagementStatus() - Method in class com.ngrok.definitions.ReservedDomain
-
status of the automatic certificate management for this domain, or null if automatic management is disabled
- getCertificatePem() - Method in class com.ngrok.definitions.TlsCertificate
-
chain of PEM-encoded certificates, leaf first.
- getCidr() - Method in class com.ngrok.definitions.IpPolicyRule
-
an IP or IP range specified in CIDR notation.
- getCircuitBreaker() - Method in class com.ngrok.definitions.EndpointConfiguration
-
circuit breaker module configuration or
null - getClientId() - Method in class com.ngrok.definitions.EndpointOAuthFacebook
-
the OAuth app client ID.
- getClientId() - Method in class com.ngrok.definitions.EndpointOAuthGitHub
-
the OAuth app client ID.
- getClientId() - Method in class com.ngrok.definitions.EndpointOAuthGoogle
-
the OAuth app client ID.
- getClientId() - Method in class com.ngrok.definitions.EndpointOAuthMicrosoft
-
the OAuth app client ID.
- getClientId() - Method in class com.ngrok.definitions.EndpointOidc
-
The OIDC app's client ID and OIDC audience.
- getClientSecret() - Method in class com.ngrok.definitions.EndpointOAuthFacebook
-
the OAuth app client secret.
- getClientSecret() - Method in class com.ngrok.definitions.EndpointOAuthGitHub
-
the OAuth app client secret.
- getClientSecret() - Method in class com.ngrok.definitions.EndpointOAuthGoogle
-
the OAuth app client secret.
- getClientSecret() - Method in class com.ngrok.definitions.EndpointOAuthMicrosoft
-
the OAuth app client secret.
- getClientSecret() - Method in class com.ngrok.definitions.EndpointOidc
-
The OIDC app's client secret.
- getCloudwatchLogs() - Method in class com.ngrok.definitions.EventTarget
-
Configuration used to send events to Amazon CloudWatch Logs.
- getCnameTarget() - Method in class com.ngrok.definitions.ReservedDomain
-
DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io
- getCompression() - Method in class com.ngrok.definitions.EndpointConfiguration
-
compression module configuration or
null - getCookiePrefix() - Method in class com.ngrok.definitions.EndpointOAuth
-
the prefix of the session cookie that ngrok sets on the http client to cache authentication.
- getCookiePrefix() - Method in class com.ngrok.definitions.EndpointOidc
-
the prefix of the session cookie that ngrok sets on the http client to cache authentication.
- getCookiePrefix() - Method in class com.ngrok.definitions.EndpointSaml
-
the prefix of the session cookie that ngrok sets on the http client to cache authentication.
- getCookiePrefix() - Method in class com.ngrok.definitions.EndpointSamlMutate
-
the prefix of the session cookie that ngrok sets on the http client to cache authentication.
- getCreatedAt() - Method in class com.ngrok.definitions.AbuseReport
-
timestamp that the abuse report record was created in RFC 3339 format
- getCreatedAt() - Method in class com.ngrok.definitions.AgentIngress
-
timestamp when the Agent Ingress was created, RFC 3339 format
- getCreatedAt() - Method in class com.ngrok.definitions.ApiKey
-
timestamp when the api key was created, RFC 3339 format
- getCreatedAt() - Method in class com.ngrok.definitions.CertificateAuthority
-
timestamp when the Certificate Authority was created, RFC 3339 format
- getCreatedAt() - Method in class com.ngrok.definitions.Credential
-
timestamp when the tunnel credential was created, RFC 3339 format
- getCreatedAt() - Method in class com.ngrok.definitions.EndpointConfiguration
-
timestamp when the endpoint configuration was created, RFC 3339 format
- getCreatedAt() - Method in class com.ngrok.definitions.EventDestination
-
Timestamp when the Event Destination was created, RFC 3339 format.
- getCreatedAt() - Method in class com.ngrok.definitions.EventStream
-
Timestamp when the Event Stream was created, RFC 3339 format.
- getCreatedAt() - Method in class com.ngrok.definitions.EventSubscription
-
When the Event Subscription was created (RFC 3339 format).
- getCreatedAt() - Method in class com.ngrok.definitions.IpPolicy
-
timestamp when the IP policy was created, RFC 3339 format
- getCreatedAt() - Method in class com.ngrok.definitions.IpPolicyRule
-
timestamp when the IP policy rule was created, RFC 3339 format
- getCreatedAt() - Method in class com.ngrok.definitions.IpRestriction
-
timestamp when the IP restriction was created, RFC 3339 format
- getCreatedAt() - Method in class com.ngrok.definitions.ReservedAddr
-
timestamp when the reserved address was created, RFC 3339 format
- getCreatedAt() - Method in class com.ngrok.definitions.ReservedDomain
-
timestamp when the reserved domain was created, RFC 3339 format
- getCreatedAt() - Method in class com.ngrok.definitions.SshCertificateAuthority
-
timestamp when the SSH Certificate Authority API resource was created, RFC 3339 format
- getCreatedAt() - Method in class com.ngrok.definitions.SshCredential
-
timestamp when the ssh credential was created, RFC 3339 format
- getCreatedAt() - Method in class com.ngrok.definitions.SshHostCertificate
-
timestamp when the SSH Host Certificate API resource was created, RFC 3339 format
- getCreatedAt() - Method in class com.ngrok.definitions.SshUserCertificate
-
timestamp when the SSH User Certificate API resource was created, RFC 3339 format
- getCreatedAt() - Method in class com.ngrok.definitions.TlsCertificate
-
timestamp when the TLS certificate was created, RFC 3339 format
- getCredential() - Method in class com.ngrok.definitions.TunnelSession
-
reference to the tunnel credential or ssh credential used by the ngrok agent to start this tunnel session
- getCredentials() - Method in class com.ngrok.definitions.CredentialList
-
the list of all tunnel credentials on this account
- getCreds() - Method in class com.ngrok.definitions.AwsAuth
-
Credentials to your AWS account if you prefer ngrok to sign in with long-term access keys.
- getCriticalOptions() - Method in class com.ngrok.definitions.SshUserCertificate
-
A map of critical options included in the certificate.
- getDeliveryStreamArn() - Method in class com.ngrok.definitions.EventTargetFirehose
-
An Amazon Resource Name specifying the Firehose delivery stream to deposit events into.
- getDescription() - Method in class com.ngrok.definitions.AgentIngress
-
human-readable description of the use of this Agent Ingress.
- getDescription() - Method in class com.ngrok.definitions.ApiKey
-
human-readable description of what uses the API key to authenticate.
- getDescription() - Method in class com.ngrok.definitions.CertificateAuthority
-
human-readable description of this Certificate Authority.
- getDescription() - Method in class com.ngrok.definitions.Credential
-
human-readable description of who or what will use the credential to authenticate.
- getDescription() - Method in class com.ngrok.definitions.EndpointConfiguration
-
human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to.
- getDescription() - Method in class com.ngrok.definitions.EventDestination
-
Human-readable description of the Event Destination.
- getDescription() - Method in class com.ngrok.definitions.EventStream
-
Human-readable description of the Event Stream.
- getDescription() - Method in class com.ngrok.definitions.EventSubscription
-
Arbitrary customer supplied information intended to be human readable.
- getDescription() - Method in class com.ngrok.definitions.IpPolicy
-
human-readable description of the source IPs of this IP policy.
- getDescription() - Method in class com.ngrok.definitions.IpPolicyRule
-
human-readable description of the source IPs of this IP rule.
- getDescription() - Method in class com.ngrok.definitions.IpRestriction
-
human-readable description of this IP restriction.
- getDescription() - Method in class com.ngrok.definitions.ReservedAddr
-
human-readable description of what this reserved address will be used for
- getDescription() - Method in class com.ngrok.definitions.ReservedDomain
-
human-readable description of what this reserved domain will be used for
- getDescription() - Method in class com.ngrok.definitions.SshCertificateAuthority
-
human-readable description of this SSH Certificate Authority.
- getDescription() - Method in class com.ngrok.definitions.SshCredential
-
human-readable description of who or what will use the ssh credential to authenticate.
- getDescription() - Method in class com.ngrok.definitions.SshHostCertificate
-
human-readable description of this SSH Host Certificate.
- getDescription() - Method in class com.ngrok.definitions.SshUserCertificate
-
human-readable description of this SSH User Certificate.
- getDescription() - Method in class com.ngrok.definitions.TlsCertificate
-
human-readable description of this TLS certificate.
- getDestinationIds() - Method in class com.ngrok.definitions.EventStream
-
A list of Event Destination IDs which should be used for this Event Stream.
- getDestinations() - Method in class com.ngrok.definitions.EventSubscription
-
Destinations to which these events will be sent
- getDetails() - Method in exception com.ngrok.definitions.NgrokApiError
-
Fetches any further details about the error.
- getDnsNames() - Method in class com.ngrok.definitions.TlsCertificateSaNs
-
set of additional domains (including wildcards) this TLS certificate is valid for
- getDomain() - Method in class com.ngrok.definitions.AgentIngress
-
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
- getDomain() - Method in class com.ngrok.definitions.ReservedDomain
-
hostname of the reserved domain
- getEmailAddresses() - Method in class com.ngrok.definitions.EndpointOAuthFacebook
-
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
- getEmailAddresses() - Method in class com.ngrok.definitions.EndpointOAuthGitHub
-
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
- getEmailAddresses() - Method in class com.ngrok.definitions.EndpointOAuthGoogle
-
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
- getEmailAddresses() - Method in class com.ngrok.definitions.EndpointOAuthMicrosoft
-
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
- getEmailDomains() - Method in class com.ngrok.definitions.EndpointOAuthFacebook
-
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
- getEmailDomains() - Method in class com.ngrok.definitions.EndpointOAuthGitHub
-
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
- getEmailDomains() - Method in class com.ngrok.definitions.EndpointOAuthGoogle
-
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
- getEmailDomains() - Method in class com.ngrok.definitions.EndpointOAuthMicrosoft
-
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
- getEnabled() - Method in class com.ngrok.definitions.EndpointCircuitBreaker
-
trueif the module will be applied to traffic,falseto disable. - getEnabled() - Method in class com.ngrok.definitions.EndpointCompression
-
trueif the module will be applied to traffic,falseto disable. - getEnabled() - Method in class com.ngrok.definitions.EndpointIpPolicy
-
trueif the module will be applied to traffic,falseto disable. - getEnabled() - Method in class com.ngrok.definitions.EndpointIpPolicyMutate
-
trueif the module will be applied to traffic,falseto disable. - getEnabled() - Method in class com.ngrok.definitions.EndpointLogging
-
trueif the module will be applied to traffic,falseto disable. - getEnabled() - Method in class com.ngrok.definitions.EndpointLoggingMutate
-
trueif the module will be applied to traffic,falseto disable. - getEnabled() - Method in class com.ngrok.definitions.EndpointMutualTls
-
trueif the module will be applied to traffic,falseto disable. - getEnabled() - Method in class com.ngrok.definitions.EndpointMutualTlsMutate
-
trueif the module will be applied to traffic,falseto disable. - getEnabled() - Method in class com.ngrok.definitions.EndpointOAuth
-
trueif the module will be applied to traffic,falseto disable. - getEnabled() - Method in class com.ngrok.definitions.EndpointOidc
-
trueif the module will be applied to traffic,falseto disable. - getEnabled() - Method in class com.ngrok.definitions.EndpointRequestHeaders
-
trueif the module will be applied to traffic,falseto disable. - getEnabled() - Method in class com.ngrok.definitions.EndpointResponseHeaders
-
trueif the module will be applied to traffic,falseto disable. - getEnabled() - Method in class com.ngrok.definitions.EndpointSaml
-
trueif the module will be applied to traffic,falseto disable. - getEnabled() - Method in class com.ngrok.definitions.EndpointSamlMutate
-
trueif the module will be applied to traffic,falseto disable. - getEnabled() - Method in class com.ngrok.definitions.EndpointTlsTermination
-
trueif the module will be applied to traffic,falseto disable. - getEnabled() - Method in class com.ngrok.definitions.EndpointWebhookValidation
-
trueif the module will be applied to traffic,falseto disable. - getEndpointConfiguration() - Method in class com.ngrok.definitions.ReservedAddr
-
object reference to the endpoint configuration that will be applied to traffic to this address
- getEndpointConfigurations() - Method in class com.ngrok.definitions.EndpointConfigurationList
-
the list of all endpoint configurations on this account
- getEnforced() - Method in class com.ngrok.definitions.IpRestriction
-
true if the IP restriction will be enforced.
- getEntityId() - Method in class com.ngrok.definitions.EndpointSaml
-
The SP Entity's unique ID.
- getErrorCode() - Method in exception com.ngrok.definitions.NgrokApiError
-
Fetches the ngrok API error code, if any.
- getErrorCode() - Method in class com.ngrok.definitions.ReservedDomainCertJob
-
if present, an error code indicating why provisioning is failing.
- getErrorThresholdPercentage() - Method in class com.ngrok.definitions.EndpointCircuitBreaker
-
Error threshold percentage should be between 0 - 1.0, not 0-100.0
- getEventDestinations() - Method in class com.ngrok.definitions.EventDestinationList
-
The list of all Event Destinations on this account.
- getEventStreamIds() - Method in class com.ngrok.definitions.EndpointLoggingMutate
-
list of all EventStreams that will be used to configure and export this endpoint's logs
- getEventStreams() - Method in class com.ngrok.definitions.EndpointLogging
-
list of all EventStreams that will be used to configure and export this endpoint's logs
- getEventStreams() - Method in class com.ngrok.definitions.EventStreamList
-
The list of all Event Streams on this account.
- getEventSubscriptions() - Method in class com.ngrok.definitions.EventSubscriptionList
-
The list of all Event Subscriptions on this account.
- getEventType() - Method in class com.ngrok.definitions.EventStream
-
The protocol that determines which events will be collected.
- getExtendedKeyUsages() - Method in class com.ngrok.definitions.CertificateAuthority
-
extended set of actions the private key of this Certificate Authority can be used for
- getExtendedKeyUsages() - Method in class com.ngrok.definitions.TlsCertificate
-
extended set of actions the private key of this TLS certificate can be used for
- getExtensions() - Method in class com.ngrok.definitions.SshUserCertificate
-
A map of extensions included in the certificate.
- getFacebook() - Method in class com.ngrok.definitions.EndpointOAuthProvider
-
configuration for using facebook as the identity provider
- getFields() - Method in class com.ngrok.definitions.EventStream
-
A list of protocol-specific fields you want to collect on each event.
- getFirehose() - Method in class com.ngrok.definitions.EventTarget
-
Configuration used to send events to Amazon Kinesis Data Firehose.
- getForceAuthn() - Method in class com.ngrok.definitions.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() - Method in class com.ngrok.definitions.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() - Method in class com.ngrok.definitions.EventDestination
-
The output format you would like to serialize events into when sending to their target.
- getGithub() - Method in class com.ngrok.definitions.EndpointOAuthProvider
-
configuration for using github as the identity provider
- getGoogle() - Method in class com.ngrok.definitions.EndpointOAuthProvider
-
configuration for using google as the identity provider
- getHostname() - Method in class com.ngrok.definitions.AbuseReportHostname
-
the hostname ngrok has parsed out of one of the reported URLs in this abuse report
- getHostnames() - Method in class com.ngrok.definitions.AbuseReport
-
an array of hostname statuses related to the report
- getHttpEndpointConfiguration() - Method in class com.ngrok.definitions.ReservedDomain
-
object referencing the endpoint configuration applied to http traffic on this domain
- getHttpsEndpointConfiguration() - Method in class com.ngrok.definitions.ReservedDomain
-
object referencing the endpoint configuration applied to https traffic on this domain
- getHttpStatusCode() - Method in exception com.ngrok.definitions.NgrokApiError
-
Fetches the HTTP status code.
- getId() - Method in class com.ngrok.definitions.AbuseReport
-
ID of the abuse report
- getId() - Method in class com.ngrok.definitions.AgentIngress
-
unique Agent Ingress resource identifier
- getId() - Method in class com.ngrok.definitions.ApiKey
-
unique API key resource identifier
- getId() - Method in class com.ngrok.definitions.CertificateAuthority
-
unique identifier for this Certificate Authority
- getId() - Method in class com.ngrok.definitions.Credential
-
unique tunnel credential resource identifier
- getId() - Method in class com.ngrok.definitions.EndpointConfiguration
-
unique identifier of this endpoint configuration
- getId() - Method in class com.ngrok.definitions.EventDestination
-
Unique identifier for this Event Destination.
- getId() - Method in class com.ngrok.definitions.EventStream
-
Unique identifier for this Event Stream.
- getId() - Method in class com.ngrok.definitions.EventSubscription
-
Unique identifier for this Event Subscription.
- getId() - Method in class com.ngrok.definitions.IpPolicy
-
unique identifier for this IP policy
- getId() - Method in class com.ngrok.definitions.IpPolicyRule
-
unique identifier for this IP policy rule
- getId() - Method in class com.ngrok.definitions.IpRestriction
-
unique identifier for this IP restriction
- getId() - Method in class com.ngrok.definitions.Ref
-
a resource identifier
- getId() - Method in class com.ngrok.definitions.ReservedAddr
-
unique reserved address resource identifier
- getId() - Method in class com.ngrok.definitions.ReservedDomain
-
unique reserved domain resource identifier
- getId() - Method in class com.ngrok.definitions.SshCertificateAuthority
-
unique identifier for this SSH Certificate Authority
- getId() - Method in class com.ngrok.definitions.SshCredential
-
unique ssh credential resource identifier
- getId() - Method in class com.ngrok.definitions.SshHostCertificate
-
unique identifier for this SSH Host Certificate
- getId() - Method in class com.ngrok.definitions.SshUserCertificate
-
unique identifier for this SSH User Certificate
- getId() - Method in class com.ngrok.definitions.TlsCertificate
-
unique identifier for this TLS certificate
- getId() - Method in class com.ngrok.definitions.Tunnel
-
unique tunnel resource identifier
- getId() - Method in class com.ngrok.definitions.TunnelSession
-
unique tunnel session resource identifier
- getIdpMetadata() - Method in class com.ngrok.definitions.EndpointSaml
-
The full XML IdP EntityDescriptor.
- getIdpMetadata() - Method in class com.ngrok.definitions.EndpointSamlMutate
-
The full XML IdP EntityDescriptor.
- getInactivityTimeout() - Method in class com.ngrok.definitions.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() - Method in class com.ngrok.definitions.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() - Method in class com.ngrok.definitions.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() - Method in class com.ngrok.definitions.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() - Method in class com.ngrok.definitions.AgentIngressList
-
the list of Agent Ingresses owned by this account
- getIp() - Method in class com.ngrok.definitions.TunnelSession
-
source ip address of the tunnel session
- getIpPolicies() - Method in class com.ngrok.definitions.EndpointIpPolicy
-
Fetches the value of the
ipPoliciesproperty. - getIpPolicies() - Method in class com.ngrok.definitions.IpPolicyList
-
the list of all IP policies on this account
- getIpPolicies() - Method in class com.ngrok.definitions.IpRestriction
-
the set of IP policies that are used to enforce the restriction
- getIpPolicy() - Method in class com.ngrok.definitions.EndpointConfiguration
-
ip policy module configuration or
null - getIpPolicy() - Method in class com.ngrok.definitions.IpPolicyRule
-
object describing the IP policy this IP Policy Rule belongs to
- getIpPolicyIds() - Method in class com.ngrok.definitions.EndpointIpPolicyMutate
-
list of all IP policies that will be used to check if a source IP is allowed access to the endpoint
- getIpPolicyRules() - Method in class com.ngrok.definitions.IpPolicyRuleList
-
the list of all IP policy rules on this account
- getIpRestrictions() - Method in class com.ngrok.definitions.IpRestrictionList
-
the list of all IP restrictions on this account
- getIps() - Method in class com.ngrok.definitions.TlsCertificateSaNs
-
set of IP addresses this TLS certificate is also valid for
- getIssuedAt() - Method in class com.ngrok.definitions.TlsCertificate
-
timestamp (in RFC 3339 format) when this TLS certificate was issued automatically, or null if this certificate was user-uploaded
- getIssuer() - Method in class com.ngrok.definitions.EndpointOidc
-
URL of the OIDC "OpenID provider".
- getIssuerCommonName() - Method in class com.ngrok.definitions.TlsCertificate
-
issuer common name from the leaf of this TLS certificate
- getKeys() - Method in class com.ngrok.definitions.ApiKeyList
-
the list of API keys for this account
- getKeyType() - Method in class com.ngrok.definitions.SshCertificateAuthority
-
the type of private key for this SSH Certificate Authority
- getKeyType() - Method in class com.ngrok.definitions.SshHostCertificate
-
the key type of the
public_key, one ofrsa,ecdsaored25519 - getKeyType() - Method in class com.ngrok.definitions.SshUserCertificate
-
the key type of the
public_key, one ofrsa,ecdsaored25519 - getKeyUsages() - Method in class com.ngrok.definitions.CertificateAuthority
-
set of actions the private key of this Certificate Authority can be used for
- getKeyUsages() - Method in class com.ngrok.definitions.TlsCertificate
-
set of actions the private key of this TLS certificate can be used for
- getKinesis() - Method in class com.ngrok.definitions.EventTarget
-
Configuration used to send events to Amazon Kinesis.
- getLogging() - Method in class com.ngrok.definitions.EndpointConfiguration
-
logging module configuration or
null - getLogGroupArn() - Method in class com.ngrok.definitions.EventTargetCloudwatchLogs
-
An Amazon Resource Name specifying the CloudWatch Logs group to deposit events into.
- getMaximumDuration() - Method in class com.ngrok.definitions.EndpointOAuth
-
Integer number of seconds of the maximum duration of an authenticated session.
- getMaximumDuration() - Method in class com.ngrok.definitions.EndpointOidc
-
Integer number of seconds of the maximum duration of an authenticated session.
- getMaximumDuration() - Method in class com.ngrok.definitions.EndpointSaml
-
Integer number of seconds of the maximum duration of an authenticated session.
- getMaximumDuration() - Method in class com.ngrok.definitions.EndpointSamlMutate
-
Integer number of seconds of the maximum duration of an authenticated session.
- getMetadata() - Method in class com.ngrok.definitions.AbuseReport
-
arbitrary user-defined data about this abuse report.
- getMetadata() - Method in class com.ngrok.definitions.AgentIngress
-
arbitrary user-defined machine-readable data of this Agent Ingress.
- getMetadata() - Method in class com.ngrok.definitions.ApiKey
-
arbitrary user-defined data of this API key.
- getMetadata() - Method in class com.ngrok.definitions.CertificateAuthority
-
arbitrary user-defined machine-readable data of this Certificate Authority.
- getMetadata() - Method in class com.ngrok.definitions.Credential
-
arbitrary user-defined machine-readable data of this credential.
- getMetadata() - Method in class com.ngrok.definitions.EndpointConfiguration
-
arbitrary user-defined machine-readable data of this endpoint configuration.
- getMetadata() - Method in class com.ngrok.definitions.EventDestination
-
Arbitrary user-defined machine-readable data of this Event Destination.
- getMetadata() - Method in class com.ngrok.definitions.EventStream
-
Arbitrary user-defined machine-readable data of this Event Stream.
- getMetadata() - Method in class com.ngrok.definitions.EventSubscription
-
Arbitrary customer supplied information intended to be machine readable.
- getMetadata() - Method in class com.ngrok.definitions.IpPolicy
-
arbitrary user-defined machine-readable data of this IP policy.
- getMetadata() - Method in class com.ngrok.definitions.IpPolicyRule
-
arbitrary user-defined machine-readable data of this IP policy rule.
- getMetadata() - Method in class com.ngrok.definitions.IpRestriction
-
arbitrary user-defined machine-readable data of this IP restriction.
- getMetadata() - Method in class com.ngrok.definitions.ReservedAddr
-
arbitrary user-defined machine-readable data of this reserved address.
- getMetadata() - Method in class com.ngrok.definitions.ReservedDomain
-
arbitrary user-defined machine-readable data of this reserved domain.
- getMetadata() - Method in class com.ngrok.definitions.SshCertificateAuthority
-
arbitrary user-defined machine-readable data of this SSH Certificate Authority.
- getMetadata() - Method in class com.ngrok.definitions.SshCredential
-
arbitrary user-defined machine-readable data of this ssh credential.
- getMetadata() - Method in class com.ngrok.definitions.SshHostCertificate
-
arbitrary user-defined machine-readable data of this SSH Host Certificate.
- getMetadata() - Method in class com.ngrok.definitions.SshUserCertificate
-
arbitrary user-defined machine-readable data of this SSH User Certificate.
- getMetadata() - Method in class com.ngrok.definitions.TlsCertificate
-
arbitrary user-defined machine-readable data of this TLS certificate.
- getMetadata() - Method in class com.ngrok.definitions.Tunnel
-
user-supplied metadata for the tunnel defined in the ngrok configuration file.
- getMetadata() - Method in class com.ngrok.definitions.TunnelSession
-
arbitrary user-defined data specified in the metadata property in the ngrok configuration file.
- getMetadataUrl() - Method in class com.ngrok.definitions.EndpointSaml
-
A public URL where the SP's metadata is hosted.
- getMicrosoft() - Method in class com.ngrok.definitions.EndpointOAuthProvider
-
configuration for using microsoft as the identity provider
- getMinVersion() - Method in class com.ngrok.definitions.EndpointTlsTermination
-
The minimum TLS version used for termination and advertised to the client during the TLS handshake.
- getMsg() - Method in class com.ngrok.definitions.ReservedDomainCertJob
-
a message describing the current status or error
- getMutualTls() - Method in class com.ngrok.definitions.EndpointConfiguration
-
mutual TLS module configuration or
null - getNameidFormat() - Method in class com.ngrok.definitions.EndpointSaml
-
Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects.
- getNameidFormat() - Method in class com.ngrok.definitions.EndpointSamlMutate
-
Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects.
- getNextPageUri() - Method in class com.ngrok.definitions.AgentIngressList
-
URI of the next page, or null if there is no next page
- getNextPageUri() - Method in class com.ngrok.definitions.ApiKeyList
-
URI of the next page, or null if there is no next page
- getNextPageUri() - Method in class com.ngrok.definitions.CertificateAuthorityList
-
URI of the next page, or null if there is no next page
- getNextPageUri() - Method in class com.ngrok.definitions.CredentialList
-
URI of the next page, or null if there is no next page
- getNextPageUri() - Method in class com.ngrok.definitions.EndpointConfigurationList
-
URI of the next page, or null if there is no next page
- getNextPageUri() - Method in class com.ngrok.definitions.EventDestinationList
-
URI of the next page, or null if there is no next page.
- getNextPageUri() - Method in class com.ngrok.definitions.EventStreamList
-
URI of the next page, or null if there is no next page.
- getNextPageUri() - Method in class com.ngrok.definitions.EventSubscriptionList
-
URI of next page, or null if there is no next page.
- getNextPageUri() - Method in class com.ngrok.definitions.IpPolicyList
-
URI of the next page, or null if there is no next page
- getNextPageUri() - Method in class com.ngrok.definitions.IpPolicyRuleList
-
URI of the next page, or null if there is no next page
- getNextPageUri() - Method in class com.ngrok.definitions.IpRestrictionList
-
URI of the next page, or null if there is no next page
- getNextPageUri() - Method in interface com.ngrok.definitions.Pageable
-
Fetches the URI of the next page.
- getNextPageUri() - Method in class com.ngrok.definitions.ReservedAddrList
-
URI of the next page, or null if there is no next page
- getNextPageUri() - Method in class com.ngrok.definitions.ReservedDomainList
-
URI of the next page, or null if there is no next page
- getNextPageUri() - Method in class com.ngrok.definitions.SshCertificateAuthorityList
-
URI of the next page, or null if there is no next page
- getNextPageUri() - Method in class com.ngrok.definitions.SshCredentialList
-
URI of the next page, or null if there is no next page
- getNextPageUri() - Method in class com.ngrok.definitions.SshHostCertificateList
-
URI of the next page, or null if there is no next page
- getNextPageUri() - Method in class com.ngrok.definitions.SshUserCertificateList
-
URI of the next page, or null if there is no next page
- getNextPageUri() - Method in class com.ngrok.definitions.TlsCertificateList
-
URI of the next page, or null if there is no next page
- getNextPageUri() - Method in class com.ngrok.definitions.TunnelList
-
URI of the next page, or null if there is no next page
- getNextPageUri() - Method in class com.ngrok.definitions.TunnelSessionList
-
URI of the next page, or null if there is no next page
- getNotAfter() - Method in class com.ngrok.definitions.CertificateAuthority
-
timestamp when this Certificate Authority becomes invalid, RFC 3339 format
- getNotAfter() - Method in class com.ngrok.definitions.TlsCertificate
-
timestamp when this TLS certificate becomes invalid, RFC 3339 format
- getNotBefore() - Method in class com.ngrok.definitions.CertificateAuthority
-
timestamp when this Certificate Authority becomes valid, RFC 3339 format
- getNotBefore() - Method in class com.ngrok.definitions.TlsCertificate
-
timestamp when this TLS certificate becomes valid, RFC 3339 format
- getNsTargets() - Method in class com.ngrok.definitions.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() - Method in class com.ngrok.definitions.EndpointCircuitBreaker
-
Integer number of buckets into which metrics are retained.
- getOauth() - Method in class com.ngrok.definitions.EndpointConfiguration
-
oauth module configuration or
null - getOidc() - Method in class com.ngrok.definitions.EndpointConfiguration
-
oidc module configuration or
null - getOptionsPassthrough() - Method in class com.ngrok.definitions.EndpointOAuth
-
Do not enforce authentication on HTTP OPTIONS requests.
- getOptionsPassthrough() - Method in class com.ngrok.definitions.EndpointOidc
-
Do not enforce authentication on HTTP OPTIONS requests.
- getOptionsPassthrough() - Method in class com.ngrok.definitions.EndpointSaml
-
Do not enforce authentication on HTTP OPTIONS requests.
- getOptionsPassthrough() - Method in class com.ngrok.definitions.EndpointSamlMutate
-
Do not enforce authentication on HTTP OPTIONS requests.
- getOrganizations() - Method in class com.ngrok.definitions.EndpointOAuthGitHub
-
a list of github org identifiers.
- getOs() - Method in class com.ngrok.definitions.TunnelSession
-
operating system of the host the ngrok agent is running on
- getPage() - Method in class com.ngrok.definitions.Page
-
Returns the current response page.
- getPrincipals() - Method in class com.ngrok.definitions.SshHostCertificate
-
the list of principals included in the ssh host certificate.
- getPrincipals() - Method in class com.ngrok.definitions.SshUserCertificate
-
the list of principals included in the ssh user certificate.
- getPrivateKeyType() - Method in class com.ngrok.definitions.ReservedDomainCertPolicy
-
type of private key to use when requesting certificates.
- getPrivateKeyType() - Method in class com.ngrok.definitions.TlsCertificate
-
type of the private key of this TLS certificate.
- getProto() - Method in class com.ngrok.definitions.Tunnel
-
tunnel protocol.
- getProvider() - Method in class com.ngrok.definitions.EndpointOAuth
-
an object which defines the identity provider to use for authentication and configuration for who may access the endpoint
- getProvider() - Method in class com.ngrok.definitions.EndpointWebhookValidation
-
a string indicating which webhook provider will be sending webhooks to this endpoint.
- getProvisioningJob() - Method in class com.ngrok.definitions.ReservedDomainCertStatus
-
status of the certificate provisioning job, or null if the certificiate isn't being provisioned or renewed
- getPublicKey() - Method in class com.ngrok.definitions.SshCertificateAuthority
-
raw public key for this SSH Certificate Authority
- getPublicKey() - Method in class com.ngrok.definitions.SshCredential
-
the PEM-encoded public key of the SSH keypair that will be used to authenticate
- getPublicKey() - Method in class com.ngrok.definitions.SshHostCertificate
-
a public key in OpenSSH Authorized Keys format that this certificate signs
- getPublicKey() - Method in class com.ngrok.definitions.SshUserCertificate
-
a public key in OpenSSH Authorized Keys format that this certificate signs
- getPublicUrl() - Method in class com.ngrok.definitions.Tunnel
-
URL of the tunnel's public endpoint
- getRegion() - Method in class com.ngrok.definitions.ReservedAddr
-
reserve the address in this geographic ngrok datacenter.
- getRegion() - Method in class com.ngrok.definitions.ReservedDomain
-
reserve the domain in this geographic ngrok datacenter.
- getRegion() - Method in class com.ngrok.definitions.Tunnel
-
identifier of tune region where the tunnel is running
- getRegion() - Method in class com.ngrok.definitions.TunnelSession
-
the ngrok region identifier in which this tunnel session was started
- getRegionDomains() - Method in class com.ngrok.definitions.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() - Method in class com.ngrok.definitions.EndpointRequestHeaders
-
a list of header names that will be removed from the HTTP Request before being sent to the upstream application server
- getRemove() - Method in class com.ngrok.definitions.EndpointResponseHeaders
-
a list of header names that will be removed from the HTTP Response returned to the HTTP client
- getRenewsAt() - Method in class com.ngrok.definitions.ReservedDomainCertStatus
-
timestamp when the next renewal will be requested, RFC 3339 format
- getRequestHeaders() - Method in class com.ngrok.definitions.EndpointConfiguration
-
request headers module configuration or
null - getRequestSigningCertificatePem() - Method in class com.ngrok.definitions.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() - Method in class com.ngrok.definitions.ReservedAddrList
-
the list of all reserved addresses on this account
- getReservedDomains() - Method in class com.ngrok.definitions.ReservedDomainList
-
the list of all reserved domains on this account
- getResponseHeaders() - Method in class com.ngrok.definitions.EndpointConfiguration
-
response headers module configuration or
null - getRetriesAt() - Method in class com.ngrok.definitions.ReservedDomainCertJob
-
timestamp when the provisioning job will be retried
- getRole() - Method in class com.ngrok.definitions.AwsAuth
-
A role for ngrok to assume on your behalf to deposit events into your AWS account.
- getRoleArn() - Method in class com.ngrok.definitions.AwsRole
-
An ARN that specifies the role that ngrok should use to deliver to the configured target.
- getRollingWindow() - Method in class com.ngrok.definitions.EndpointCircuitBreaker
-
Integer number of seconds in the statistical rolling window that metrics are retained for.
- getSaml() - Method in class com.ngrok.definitions.EndpointConfiguration
-
saml module configuration or
null - getSamplingRate() - Method in class com.ngrok.definitions.EventStream
-
The percentage of all events you would like to capture.
- getScopes() - Method in class com.ngrok.definitions.EndpointOAuthFacebook
-
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for.
- getScopes() - Method in class com.ngrok.definitions.EndpointOAuthGitHub
-
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for.
- getScopes() - Method in class com.ngrok.definitions.EndpointOAuthGoogle
-
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for.
- getScopes() - Method in class com.ngrok.definitions.EndpointOAuthMicrosoft
-
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for.
- getScopes() - Method in class com.ngrok.definitions.EndpointOidc
-
The set of scopes to request from the OIDC identity provider.
- getSecret() - Method in class com.ngrok.definitions.EndpointWebhookValidation
-
a string secret used to validate requests from the given provider.
- getSerialNumber() - Method in class com.ngrok.definitions.TlsCertificate
-
serial number of the leaf of this TLS certificate
- getSingleLogoutUrl() - Method in class com.ngrok.definitions.EndpointSaml
-
The public URL of the SP's Single Logout Service.
- getSources() - Method in class com.ngrok.definitions.EventSourceList
-
The list of all Event Sources for an Event Subscription
- getSources() - Method in class com.ngrok.definitions.EventSubscription
-
Sources containing the types for which this event subscription will trigger
- getSshCertificateAuthorities() - Method in class com.ngrok.definitions.SshCertificateAuthorityList
-
the list of all certificate authorities on this account
- getSshCertificateAuthorityId() - Method in class com.ngrok.definitions.SshHostCertificate
-
the ssh certificate authority that is used to sign this ssh host certificate
- getSshCertificateAuthorityId() - Method in class com.ngrok.definitions.SshUserCertificate
-
the ssh certificate authority that is used to sign this ssh user certificate
- getSshCredentials() - Method in class com.ngrok.definitions.SshCredentialList
-
the list of all ssh credentials on this account
- getSshHostCertificates() - Method in class com.ngrok.definitions.SshHostCertificateList
-
the list of all ssh host certificates on this account
- getSshUserCertificates() - Method in class com.ngrok.definitions.SshUserCertificateList
-
the list of all ssh user certificates on this account
- getStartedAt() - Method in class com.ngrok.definitions.ReservedDomainCertJob
-
timestamp when the provisioning job started, RFC 3339 format
- getStartedAt() - Method in class com.ngrok.definitions.Tunnel
-
timestamp when the tunnel was initiated in RFC 3339 format
- getStartedAt() - Method in class com.ngrok.definitions.TunnelSession
-
time when the tunnel session first connected to the ngrok servers
- getStatus() - Method in class com.ngrok.definitions.AbuseReport
-
Indicates whether ngrok has processed the abuse report.
- getStatus() - Method in class com.ngrok.definitions.AbuseReportHostname
-
indicates what action ngrok has taken against the hostname.
- getStreamArn() - Method in class com.ngrok.definitions.EventTargetKinesis
-
An Amazon Resource Name specifying the Kinesis stream to deposit events into.
- getSubjectAlternativeNames() - Method in class com.ngrok.definitions.TlsCertificate
-
subject alternative names (SANs) from the leaf of this TLS certificate
- getSubjectCommonName() - Method in class com.ngrok.definitions.CertificateAuthority
-
subject common name of the Certificate Authority
- getSubjectCommonName() - Method in class com.ngrok.definitions.TlsCertificate
-
subject common name from the leaf of this TLS certificate
- getSubjectCountry() - Method in class com.ngrok.definitions.TlsCertificate
-
subject country from the leaf of this TLS certificate
- getSubjectLocality() - Method in class com.ngrok.definitions.TlsCertificate
-
subject locality from the leaf of this TLS certificate
- getSubjectOrganization() - Method in class com.ngrok.definitions.TlsCertificate
-
subject organization from the leaf of this TLS certificate
- getSubjectOrganizationalUnit() - Method in class com.ngrok.definitions.TlsCertificate
-
subject organizational unit from the leaf of this TLS certificate
- getSubjectProvince() - Method in class com.ngrok.definitions.TlsCertificate
-
subject province from the leaf of this TLS certificate
- getTarget() - Method in class com.ngrok.definitions.EventDestination
-
An object that encapsulates where and how to send your events.
- getTeams() - Method in class com.ngrok.definitions.EndpointOAuthGitHub
-
a list of github teams identifiers.
- getTerminateAt() - Method in class com.ngrok.definitions.EndpointTlsTermination
-
edgeif the ngrok edge should terminate TLS traffic,upstreamif TLS traffic should be passed through to the upstream ngrok agent / application server for termination. - getTlsCertificates() - Method in class com.ngrok.definitions.TlsCertificateList
-
the list of all TLS certificates on this account
- getTlsTermination() - Method in class com.ngrok.definitions.EndpointConfiguration
-
TLS termination module configuration or
null - getToken() - Method in class com.ngrok.definitions.ApiKey
-
the bearer token that can be placed into the Authorization header to authenticate request to the ngrok API.
- getToken() - Method in class com.ngrok.definitions.Credential
-
the credential's authtoken that can be used to authenticate an ngrok client.
- getTransport() - Method in class com.ngrok.definitions.TunnelSession
-
the transport protocol used to start the tunnel session.
- getTrippedDuration() - Method in class com.ngrok.definitions.EndpointCircuitBreaker
-
Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health
- getTunnels() - Method in class com.ngrok.definitions.TunnelList
-
the list of all online tunnels on this account
- getTunnelSession() - Method in class com.ngrok.definitions.Tunnel
-
reference object pointing to the tunnel session on which this tunnel was started
- getTunnelSessions() - Method in class com.ngrok.definitions.TunnelSessionList
-
list of all tunnel sessions on this account
- getType() - Method in class com.ngrok.definitions.EndpointConfiguration
-
they type of traffic this endpoint configuration can be applied to.
- getType() - Method in class com.ngrok.definitions.EventSource
-
Type of event for which an event subscription will trigger
- getType() - Method in class com.ngrok.definitions.EventSourceReplace
-
Type of event for which an event subscription will trigger
- getType() - Method in class com.ngrok.definitions.IpRestriction
-
the type of IP restriction.
- getUri() - Method in class com.ngrok.definitions.AbuseReport
-
URI of the abuse report API resource
- getUri() - Method in class com.ngrok.definitions.AgentIngress
-
URI to the API resource of this Agent ingress
- getUri() - Method in class com.ngrok.definitions.AgentIngressList
-
URI of the Agent Ingress list API resource
- getUri() - Method in class com.ngrok.definitions.ApiKey
-
URI to the API resource of this API key
- getUri() - Method in class com.ngrok.definitions.ApiKeyList
-
URI of the API keys list API resource
- getUri() - Method in class com.ngrok.definitions.CertificateAuthority
-
URI of the Certificate Authority API resource
- getUri() - Method in class com.ngrok.definitions.CertificateAuthorityList
-
URI of the certificates authorities list API resource
- getUri() - Method in class com.ngrok.definitions.Credential
-
URI of the tunnel credential API resource
- getUri() - Method in class com.ngrok.definitions.CredentialList
-
URI of the tunnel credential list API resource
- getUri() - Method in class com.ngrok.definitions.EndpointConfiguration
-
URI of the endpoint configuration API resource
- getUri() - Method in class com.ngrok.definitions.EndpointConfigurationList
-
URI of the endpoint configurations list API resource
- getUri() - Method in class com.ngrok.definitions.EventDestination
-
URI of the Event Destination API resource.
- getUri() - Method in class com.ngrok.definitions.EventDestinationList
-
URI of the Event Destinations list API resource.
- getUri() - Method in class com.ngrok.definitions.EventSource
-
URI of the Event Source API resource.
- getUri() - Method in class com.ngrok.definitions.EventSourceList
-
URI of the next page, or null if there is no next page.
- getUri() - Method in class com.ngrok.definitions.EventStream
-
URI of the Event Stream API resource.
- getUri() - Method in class com.ngrok.definitions.EventStreamList
-
URI of the Event Stream list API resource.
- getUri() - Method in class com.ngrok.definitions.EventSubscription
-
URI of the Event Subscription API resource.
- getUri() - Method in class com.ngrok.definitions.EventSubscriptionList
-
URI of the Event Subscriptions list API resource.
- getUri() - Method in class com.ngrok.definitions.IpPolicy
-
URI of the IP Policy API resource
- getUri() - Method in class com.ngrok.definitions.IpPolicyList
-
URI of the IP policy list API resource
- getUri() - Method in class com.ngrok.definitions.IpPolicyRule
-
URI of the IP policy rule API resource
- getUri() - Method in class com.ngrok.definitions.IpPolicyRuleList
-
URI of the IP policy rule list API resource
- getUri() - Method in class com.ngrok.definitions.IpRestriction
-
URI of the IP restriction API resource
- getUri() - Method in class com.ngrok.definitions.IpRestrictionList
-
URI of the IP resrtrictions list API resource
- getUri() - Method in class com.ngrok.definitions.Ref
-
a uri for locating a resource
- getUri() - Method in class com.ngrok.definitions.ReservedAddr
-
URI of the reserved address API resource
- getUri() - Method in class com.ngrok.definitions.ReservedAddrList
-
URI of the reserved address list API resource
- getUri() - Method in class com.ngrok.definitions.ReservedDomain
-
URI of the reserved domain API resource
- getUri() - Method in class com.ngrok.definitions.ReservedDomainList
-
URI of the reserved domain list API resource
- getUri() - Method in class com.ngrok.definitions.SshCertificateAuthority
-
URI of the SSH Certificate Authority API resource
- getUri() - Method in class com.ngrok.definitions.SshCertificateAuthorityList
-
URI of the certificates authorities list API resource
- getUri() - Method in class com.ngrok.definitions.SshCredential
-
URI of the ssh credential API resource
- getUri() - Method in class com.ngrok.definitions.SshCredentialList
-
URI of the ssh credential list API resource
- getUri() - Method in class com.ngrok.definitions.SshHostCertificate
-
URI of the SSH Host Certificate API resource
- getUri() - Method in class com.ngrok.definitions.SshHostCertificateList
-
URI of the ssh host certificates list API resource
- getUri() - Method in class com.ngrok.definitions.SshUserCertificate
-
URI of the SSH User Certificate API resource
- getUri() - Method in class com.ngrok.definitions.SshUserCertificateList
-
URI of the ssh user certificates list API resource
- getUri() - Method in class com.ngrok.definitions.TlsCertificate
-
URI of the TLS certificate API resource
- getUri() - Method in class com.ngrok.definitions.TlsCertificateList
-
URI of the TLS certificates list API resource
- getUri() - Method in class com.ngrok.definitions.TunnelList
-
URI of the tunnels list API resource
- getUri() - Method in class com.ngrok.definitions.TunnelSession
-
URI to the API resource of the tunnel session
- getUri() - Method in class com.ngrok.definitions.TunnelSessionList
-
URI to the API resource of the tunnel session list
- getUrls() - Method in class com.ngrok.definitions.AbuseReport
-
a list of URLs containing suspected abusive content
- getValidAfter() - Method in class com.ngrok.definitions.SshHostCertificate
-
the time when the ssh host certificate becomes valid, in RFC 3339 format.
- getValidAfter() - Method in class com.ngrok.definitions.SshUserCertificate
-
the time when the ssh host certificate becomes valid, in RFC 3339 format.
- getValidUntil() - Method in class com.ngrok.definitions.SshHostCertificate
-
the time after which the ssh host certificate becomes invalid, in RFC 3339 format.
- getValidUntil() - Method in class com.ngrok.definitions.SshUserCertificate
-
the time after which the ssh host certificate becomes invalid, in RFC 3339 format.
- getVolumeThreshold() - Method in class com.ngrok.definitions.EndpointCircuitBreaker
-
Integer number of requests in a rolling window that will trip the circuit.
- getWebhookValidation() - Method in class com.ngrok.definitions.EndpointConfiguration
-
webhook validation module configuration or
null - github(EndpointOAuthGitHub) - Method in class com.ngrok.definitions.EndpointOAuthProvider.Builder
-
configuration for using github as the identity provider
- github(Optional<EndpointOAuthGitHub>) - Method in class com.ngrok.definitions.EndpointOAuthProvider.Builder
-
configuration for using github as the identity provider
- google(EndpointOAuthGoogle) - Method in class com.ngrok.definitions.EndpointOAuthProvider.Builder
-
configuration for using google as the identity provider
- google(Optional<EndpointOAuthGoogle>) - Method in class com.ngrok.definitions.EndpointOAuthProvider.Builder
-
configuration for using google as the identity provider
H
- hashCode() - Method in class com.ngrok.definitions.AbuseReport
- hashCode() - Method in class com.ngrok.definitions.AbuseReportHostname
- hashCode() - Method in class com.ngrok.definitions.AgentIngress
- hashCode() - Method in class com.ngrok.definitions.AgentIngressList
- hashCode() - Method in class com.ngrok.definitions.ApiKey
- hashCode() - Method in class com.ngrok.definitions.ApiKeyList
- hashCode() - Method in class com.ngrok.definitions.AwsAuth
- hashCode() - Method in class com.ngrok.definitions.AwsCredentials
- hashCode() - Method in class com.ngrok.definitions.AwsRole
- hashCode() - Method in class com.ngrok.definitions.CertificateAuthority
- hashCode() - Method in class com.ngrok.definitions.CertificateAuthorityList
- hashCode() - Method in class com.ngrok.definitions.Credential
- hashCode() - Method in class com.ngrok.definitions.CredentialList
- hashCode() - Method in class com.ngrok.definitions.EndpointCircuitBreaker
- hashCode() - Method in class com.ngrok.definitions.EndpointCompression
- hashCode() - Method in class com.ngrok.definitions.EndpointConfiguration
- hashCode() - Method in class com.ngrok.definitions.EndpointConfigurationList
- hashCode() - Method in class com.ngrok.definitions.EndpointIpPolicy
- hashCode() - Method in class com.ngrok.definitions.EndpointIpPolicyMutate
- hashCode() - Method in class com.ngrok.definitions.EndpointLogging
- hashCode() - Method in class com.ngrok.definitions.EndpointLoggingMutate
- hashCode() - Method in class com.ngrok.definitions.EndpointMutualTls
- hashCode() - Method in class com.ngrok.definitions.EndpointMutualTlsMutate
- hashCode() - Method in class com.ngrok.definitions.EndpointOAuth
- hashCode() - Method in class com.ngrok.definitions.EndpointOAuthFacebook
- hashCode() - Method in class com.ngrok.definitions.EndpointOAuthGitHub
- hashCode() - Method in class com.ngrok.definitions.EndpointOAuthGoogle
- hashCode() - Method in class com.ngrok.definitions.EndpointOAuthMicrosoft
- hashCode() - Method in class com.ngrok.definitions.EndpointOAuthProvider
- hashCode() - Method in class com.ngrok.definitions.EndpointOidc
- hashCode() - Method in class com.ngrok.definitions.EndpointRequestHeaders
- hashCode() - Method in class com.ngrok.definitions.EndpointResponseHeaders
- hashCode() - Method in class com.ngrok.definitions.EndpointSaml
- hashCode() - Method in class com.ngrok.definitions.EndpointSamlMutate
- hashCode() - Method in class com.ngrok.definitions.EndpointTlsTermination
- hashCode() - Method in class com.ngrok.definitions.EndpointWebhookValidation
- hashCode() - Method in class com.ngrok.definitions.EventDestination
- hashCode() - Method in class com.ngrok.definitions.EventDestinationList
- hashCode() - Method in class com.ngrok.definitions.EventSource
- hashCode() - Method in class com.ngrok.definitions.EventSourceList
- hashCode() - Method in class com.ngrok.definitions.EventSourceReplace
- hashCode() - Method in class com.ngrok.definitions.EventStream
- hashCode() - Method in class com.ngrok.definitions.EventStreamList
- hashCode() - Method in class com.ngrok.definitions.EventSubscription
- hashCode() - Method in class com.ngrok.definitions.EventSubscriptionList
- hashCode() - Method in class com.ngrok.definitions.EventTarget
- hashCode() - Method in class com.ngrok.definitions.EventTargetCloudwatchLogs
- hashCode() - Method in class com.ngrok.definitions.EventTargetFirehose
- hashCode() - Method in class com.ngrok.definitions.EventTargetKinesis
- hashCode() - Method in class com.ngrok.definitions.IpPolicy
- hashCode() - Method in class com.ngrok.definitions.IpPolicyList
- hashCode() - Method in class com.ngrok.definitions.IpPolicyRule
- hashCode() - Method in class com.ngrok.definitions.IpPolicyRuleList
- hashCode() - Method in class com.ngrok.definitions.IpRestriction
- hashCode() - Method in class com.ngrok.definitions.IpRestrictionList
- hashCode() - Method in class com.ngrok.definitions.Ref
- hashCode() - Method in class com.ngrok.definitions.ReservedAddr
- hashCode() - Method in class com.ngrok.definitions.ReservedAddrList
- hashCode() - Method in class com.ngrok.definitions.ReservedDomain
- hashCode() - Method in class com.ngrok.definitions.ReservedDomainCertJob
- hashCode() - Method in class com.ngrok.definitions.ReservedDomainCertPolicy
- hashCode() - Method in class com.ngrok.definitions.ReservedDomainCertStatus
- hashCode() - Method in class com.ngrok.definitions.ReservedDomainList
- hashCode() - Method in class com.ngrok.definitions.SshCertificateAuthority
- hashCode() - Method in class com.ngrok.definitions.SshCertificateAuthorityList
- hashCode() - Method in class com.ngrok.definitions.SshCredential
- hashCode() - Method in class com.ngrok.definitions.SshCredentialList
- hashCode() - Method in class com.ngrok.definitions.SshHostCertificate
- hashCode() - Method in class com.ngrok.definitions.SshHostCertificateList
- hashCode() - Method in class com.ngrok.definitions.SshUserCertificate
- hashCode() - Method in class com.ngrok.definitions.SshUserCertificateList
- hashCode() - Method in class com.ngrok.definitions.TlsCertificate
- hashCode() - Method in class com.ngrok.definitions.TlsCertificateList
- hashCode() - Method in class com.ngrok.definitions.TlsCertificateSaNs
- hashCode() - Method in class com.ngrok.definitions.Tunnel
- hashCode() - Method in class com.ngrok.definitions.TunnelList
- hashCode() - Method in class com.ngrok.definitions.TunnelSession
- hashCode() - Method in class com.ngrok.definitions.TunnelSessionList
- httpClient(WebClient) - Method in class com.ngrok.DefaultNgrokApiClient.Builder
-
Sets the HTTP client to use to make requests.
- httpClient(Optional<WebClient>) - Method in class com.ngrok.DefaultNgrokApiClient.Builder
-
Sets the HTTP client to use to make requests.
- httpEndpointConfigurationId(String) - Method in class com.ngrok.services.ReservedDomains.CreateCallBuilder
-
ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain
- httpEndpointConfigurationId(String) - Method in class com.ngrok.services.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>) - Method in class com.ngrok.services.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>) - Method in class com.ngrok.services.ReservedDomains.UpdateCallBuilder
-
ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain
- httpsEndpointConfigurationId(String) - Method in class com.ngrok.services.ReservedDomains.CreateCallBuilder
-
ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
- httpsEndpointConfigurationId(String) - Method in class com.ngrok.services.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>) - Method in class com.ngrok.services.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>) - Method in class com.ngrok.services.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) - Method in class com.ngrok.definitions.EndpointSamlMutate.Builder
-
The full XML IdP EntityDescriptor.
- idpMetadata(Optional<String>) - Method in class com.ngrok.definitions.EndpointSamlMutate.Builder
-
The full XML IdP EntityDescriptor.
- inactivityTimeout(long) - Method in class com.ngrok.definitions.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) - Method in class com.ngrok.definitions.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) - Method in class com.ngrok.definitions.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>) - Method in class com.ngrok.definitions.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>) - Method in class com.ngrok.definitions.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>) - Method in class com.ngrok.definitions.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() - Method in class com.ngrok.Ngrok
-
IP Policies are reusable groups of CIDR ranges with an
allowordenyaction. - IpPolicies - Class in com.ngrok.services
-
IP Policies are reusable groups of CIDR ranges with an
allowordenyaction. - IpPolicies(NgrokApiClient) - Constructor for class com.ngrok.services.IpPolicies
-
Creates a new sub-client for IpPolicies.
- IpPolicies.CreateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Create API call.
- IpPolicies.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- IpPolicies.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- IpPolicies.ListCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent List API call.
- IpPolicies.UpdateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Update API call.
- ipPolicy() - Method in class com.ngrok.Ngrok.PointcfgModuleNamespace
-
Creates a service client for
EndpointIpPolicyModule. - ipPolicy(EndpointIpPolicyMutate) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
ip policy module configuration or
null - ipPolicy(EndpointIpPolicyMutate) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
ip policy module configuration or
null - ipPolicy(Optional<EndpointIpPolicyMutate>) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
ip policy module configuration or
null - ipPolicy(Optional<EndpointIpPolicyMutate>) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
ip policy module configuration or
null - IpPolicy - Class in com.ngrok.definitions
-
A class encapsulating the
IpPolicyresource. - IpPolicy(String, URI, OffsetDateTime, String, String, String) - Constructor for class com.ngrok.definitions.IpPolicy
-
Creates a new instance of
IpPolicy. - ipPolicyIds(List<String>) - Method in class com.ngrok.definitions.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>) - Method in class com.ngrok.services.IpRestrictions.UpdateCallBuilder
-
the set of IP policy identifiers that are used to enforce the restriction
- ipPolicyIds(Optional<List<String>>) - Method in class com.ngrok.definitions.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>>) - Method in class com.ngrok.services.IpRestrictions.UpdateCallBuilder
-
the set of IP policy identifiers that are used to enforce the restriction
- IpPolicyList - Class in com.ngrok.definitions
-
A class encapsulating the
IpPolicyListresource. - IpPolicyList(List<IpPolicy>, URI, Optional<URI>) - Constructor for class com.ngrok.definitions.IpPolicyList
-
Creates a new instance of
IpPolicyList. - IpPolicyRule - Class in com.ngrok.definitions
-
A class encapsulating the
IpPolicyRuleresource. - IpPolicyRule(String, URI, OffsetDateTime, String, String, String, Ref) - Constructor for class com.ngrok.definitions.IpPolicyRule
-
Creates a new instance of
IpPolicyRule. - IpPolicyRuleList - Class in com.ngrok.definitions
-
A class encapsulating the
IpPolicyRuleListresource. - IpPolicyRuleList(List<IpPolicyRule>, URI, Optional<URI>) - Constructor for class com.ngrok.definitions.IpPolicyRuleList
-
Creates a new instance of
IpPolicyRuleList. - ipPolicyRules() - Method in class com.ngrok.Ngrok
-
IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.
- IpPolicyRules - Class in com.ngrok.services
-
IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.
- IpPolicyRules(NgrokApiClient) - Constructor for class com.ngrok.services.IpPolicyRules
-
Creates a new sub-client for IpPolicyRules.
- IpPolicyRules.CreateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Create API call.
- IpPolicyRules.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- IpPolicyRules.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- IpPolicyRules.ListCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent List API call.
- IpPolicyRules.UpdateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Update API call.
- IpRestriction - Class in com.ngrok.definitions
-
A class encapsulating the
IpRestrictionresource. - IpRestriction(String, URI, OffsetDateTime, String, String, Boolean, String, List<Ref>) - Constructor for class com.ngrok.definitions.IpRestriction
-
Creates a new instance of
IpRestriction. - IpRestrictionList - Class in com.ngrok.definitions
-
A class encapsulating the
IpRestrictionListresource. - IpRestrictionList(List<IpRestriction>, URI, Optional<URI>) - Constructor for class com.ngrok.definitions.IpRestrictionList
-
Creates a new instance of
IpRestrictionList. - ipRestrictions() - Method in class com.ngrok.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 - Class in 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) - Constructor for class com.ngrok.services.IpRestrictions
-
Creates a new sub-client for IpRestrictions.
- IpRestrictions.CreateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Create API call.
- IpRestrictions.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- IpRestrictions.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- IpRestrictions.ListCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent List API call.
- IpRestrictions.UpdateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Update API call.
- isErrorCode(String...) - Method in exception com.ngrok.definitions.NgrokApiError
-
Checks if this error object contains one of the provided codes.
- issuer(String) - Method in class com.ngrok.definitions.EndpointOidc.Builder
-
URL of the OIDC "OpenID provider".
- issuer(Optional<String>) - Method in class com.ngrok.definitions.EndpointOidc.Builder
-
URL of the OIDC "OpenID provider".
K
- keySize(long) - Method in class com.ngrok.services.SshCertificateAuthorities.CreateCallBuilder
-
the key size to use when creating an RSA key.
- keySize(Optional<Long>) - Method in class com.ngrok.services.SshCertificateAuthorities.CreateCallBuilder
-
the key size to use when creating an RSA key.
- kinesis(EventTargetKinesis) - Method in class com.ngrok.definitions.EventTarget.Builder
-
Configuration used to send events to Amazon Kinesis.
- kinesis(Optional<EventTargetKinesis>) - Method in class com.ngrok.definitions.EventTarget.Builder
-
Configuration used to send events to Amazon Kinesis.
L
- limit(String) - Method in class com.ngrok.services.AgentIngresses.ListCallBuilder
-
Sets the
limitparameter. - limit(String) - Method in class com.ngrok.services.ApiKeys.ListCallBuilder
-
Sets the
limitparameter. - limit(String) - Method in class com.ngrok.services.CertificateAuthorities.ListCallBuilder
-
Sets the
limitparameter. - limit(String) - Method in class com.ngrok.services.Credentials.ListCallBuilder
-
Sets the
limitparameter. - limit(String) - Method in class com.ngrok.services.EndpointConfigurations.ListCallBuilder
-
Sets the
limitparameter. - limit(String) - Method in class com.ngrok.services.EventDestinations.ListCallBuilder
-
Sets the
limitparameter. - limit(String) - Method in class com.ngrok.services.EventStreams.ListCallBuilder
-
Sets the
limitparameter. - limit(String) - Method in class com.ngrok.services.EventSubscriptions.ListCallBuilder
-
Sets the
limitparameter. - limit(String) - Method in class com.ngrok.services.IpPolicies.ListCallBuilder
-
Sets the
limitparameter. - limit(String) - Method in class com.ngrok.services.IpPolicyRules.ListCallBuilder
-
Sets the
limitparameter. - limit(String) - Method in class com.ngrok.services.IpRestrictions.ListCallBuilder
-
Sets the
limitparameter. - limit(String) - Method in class com.ngrok.services.ReservedAddrs.ListCallBuilder
-
Sets the
limitparameter. - limit(String) - Method in class com.ngrok.services.ReservedDomains.ListCallBuilder
-
Sets the
limitparameter. - limit(String) - Method in class com.ngrok.services.SshCertificateAuthorities.ListCallBuilder
-
Sets the
limitparameter. - limit(String) - Method in class com.ngrok.services.SshCredentials.ListCallBuilder
-
Sets the
limitparameter. - limit(String) - Method in class com.ngrok.services.SshHostCertificates.ListCallBuilder
-
Sets the
limitparameter. - limit(String) - Method in class com.ngrok.services.SshUserCertificates.ListCallBuilder
-
Sets the
limitparameter. - limit(String) - Method in class com.ngrok.services.TlsCertificates.ListCallBuilder
-
Sets the
limitparameter. - limit(String) - Method in class com.ngrok.services.Tunnels.ListCallBuilder
-
Sets the
limitparameter. - limit(String) - Method in class com.ngrok.services.TunnelSessions.ListCallBuilder
-
Sets the
limitparameter. - limit(Optional<String>) - Method in class com.ngrok.services.AgentIngresses.ListCallBuilder
-
Sets (or unsets) the
limitparameter. - limit(Optional<String>) - Method in class com.ngrok.services.ApiKeys.ListCallBuilder
-
Sets (or unsets) the
limitparameter. - limit(Optional<String>) - Method in class com.ngrok.services.CertificateAuthorities.ListCallBuilder
-
Sets (or unsets) the
limitparameter. - limit(Optional<String>) - Method in class com.ngrok.services.Credentials.ListCallBuilder
-
Sets (or unsets) the
limitparameter. - limit(Optional<String>) - Method in class com.ngrok.services.EndpointConfigurations.ListCallBuilder
-
Sets (or unsets) the
limitparameter. - limit(Optional<String>) - Method in class com.ngrok.services.EventDestinations.ListCallBuilder
-
Sets (or unsets) the
limitparameter. - limit(Optional<String>) - Method in class com.ngrok.services.EventStreams.ListCallBuilder
-
Sets (or unsets) the
limitparameter. - limit(Optional<String>) - Method in class com.ngrok.services.EventSubscriptions.ListCallBuilder
-
Sets (or unsets) the
limitparameter. - limit(Optional<String>) - Method in class com.ngrok.services.IpPolicies.ListCallBuilder
-
Sets (or unsets) the
limitparameter. - limit(Optional<String>) - Method in class com.ngrok.services.IpPolicyRules.ListCallBuilder
-
Sets (or unsets) the
limitparameter. - limit(Optional<String>) - Method in class com.ngrok.services.IpRestrictions.ListCallBuilder
-
Sets (or unsets) the
limitparameter. - limit(Optional<String>) - Method in class com.ngrok.services.ReservedAddrs.ListCallBuilder
-
Sets (or unsets) the
limitparameter. - limit(Optional<String>) - Method in class com.ngrok.services.ReservedDomains.ListCallBuilder
-
Sets (or unsets) the
limitparameter. - limit(Optional<String>) - Method in class com.ngrok.services.SshCertificateAuthorities.ListCallBuilder
-
Sets (or unsets) the
limitparameter. - limit(Optional<String>) - Method in class com.ngrok.services.SshCredentials.ListCallBuilder
-
Sets (or unsets) the
limitparameter. - limit(Optional<String>) - Method in class com.ngrok.services.SshHostCertificates.ListCallBuilder
-
Sets (or unsets) the
limitparameter. - limit(Optional<String>) - Method in class com.ngrok.services.SshUserCertificates.ListCallBuilder
-
Sets (or unsets) the
limitparameter. - limit(Optional<String>) - Method in class com.ngrok.services.TlsCertificates.ListCallBuilder
-
Sets (or unsets) the
limitparameter. - limit(Optional<String>) - Method in class com.ngrok.services.Tunnels.ListCallBuilder
-
Sets (or unsets) the
limitparameter. - limit(Optional<String>) - Method in class com.ngrok.services.TunnelSessions.ListCallBuilder
-
Sets (or unsets) the
limitparameter. - list() - Method in class com.ngrok.services.AgentIngresses
-
List all Agent Ingresses owned by this account See also https://ngrok.com/docs/api#api-agent-ingresses-list.
- list() - Method in class com.ngrok.services.ApiKeys
-
List all API keys owned by this account See also https://ngrok.com/docs/api#api-api-keys-list.
- list() - Method in class com.ngrok.services.CertificateAuthorities
-
List all Certificate Authority on this account See also https://ngrok.com/docs/api#api-certificate-authorities-list.
- list() - Method in class com.ngrok.services.Credentials
-
List all tunnel authtoken credentials on this account See also https://ngrok.com/docs/api#api-credentials-list.
- list() - Method in class com.ngrok.services.EndpointConfigurations
-
Returns a list of all endpoint configurations on this account See also https://ngrok.com/docs/api#api-endpoint-configurations-list.
- list() - Method in class com.ngrok.services.EventDestinations
-
List all Event Destinations on this account.
- list() - Method in class com.ngrok.services.EventStreams
-
List all Event Streams available on this account.
- list() - Method in class com.ngrok.services.EventSubscriptions
-
List this Account's Event Subscriptions.
- list() - Method in class com.ngrok.services.IpPolicies
-
List all IP policies on this account See also https://ngrok.com/docs/api#api-ip-policies-list.
- list() - Method in class com.ngrok.services.IpPolicyRules
-
List all IP policy rules on this account See also https://ngrok.com/docs/api#api-ip-policy-rules-list.
- list() - Method in class com.ngrok.services.IpRestrictions
-
List all IP restrictions on this account See also https://ngrok.com/docs/api#api-ip-restrictions-list.
- list() - Method in class com.ngrok.services.ReservedAddrs
-
List all reserved addresses on this account.
- list() - Method in class com.ngrok.services.ReservedDomains
-
List all reserved domains on this account.
- list() - Method in class com.ngrok.services.SshCertificateAuthorities
-
List all SSH Certificate Authorities on this account See also https://ngrok.com/docs/api#api-ssh-certificate-authorities-list.
- list() - Method in class com.ngrok.services.SshCredentials
-
List all ssh credentials on this account See also https://ngrok.com/docs/api#api-ssh-credentials-list.
- list() - Method in class com.ngrok.services.SshHostCertificates
-
List all SSH Host Certificates issued on this account See also https://ngrok.com/docs/api#api-ssh-host-certificates-list.
- list() - Method in class com.ngrok.services.SshUserCertificates
-
List all SSH User Certificates issued on this account See also https://ngrok.com/docs/api#api-ssh-user-certificates-list.
- list() - Method in class com.ngrok.services.TlsCertificates
-
List all TLS certificates on this account See also https://ngrok.com/docs/api#api-tls-certificates-list.
- list() - Method in class com.ngrok.services.Tunnels
-
List all online tunnels currently running on the account.
- list() - Method in class com.ngrok.services.TunnelSessions
-
List all online tunnel sessions running on this account.
- list(String) - Method in class com.ngrok.services.EventSources
-
List the types for which this event subscription will trigger See also https://ngrok.com/docs/api#api-event-sources-list.
- logging() - Method in class com.ngrok.Ngrok.PointcfgModuleNamespace
-
Creates a service client for
EndpointLoggingModule. - logging(EndpointLoggingMutate) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
logging module configuration or
null - logging(EndpointLoggingMutate) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
logging module configuration or
null - logging(Optional<EndpointLoggingMutate>) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
logging module configuration or
null - logging(Optional<EndpointLoggingMutate>) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
logging module configuration or
null - logGroupArn(String) - Method in class com.ngrok.definitions.EventTargetCloudwatchLogs.Builder
-
An Amazon Resource Name specifying the CloudWatch Logs group to deposit events into.
- logGroupArn(Optional<String>) - Method in class com.ngrok.definitions.EventTargetCloudwatchLogs.Builder
-
An Amazon Resource Name specifying the CloudWatch Logs group to deposit events into.
M
- maximumDuration(Duration) - Method in class com.ngrok.definitions.EndpointOAuth.Builder
-
Integer number of seconds of the maximum duration of an authenticated session.
- maximumDuration(Duration) - Method in class com.ngrok.definitions.EndpointOidc.Builder
-
Integer number of seconds of the maximum duration of an authenticated session.
- maximumDuration(Duration) - Method in class com.ngrok.definitions.EndpointSamlMutate.Builder
-
Integer number of seconds of the maximum duration of an authenticated session.
- maximumDuration(Optional<Duration>) - Method in class com.ngrok.definitions.EndpointOAuth.Builder
-
Integer number of seconds of the maximum duration of an authenticated session.
- maximumDuration(Optional<Duration>) - Method in class com.ngrok.definitions.EndpointOidc.Builder
-
Integer number of seconds of the maximum duration of an authenticated session.
- maximumDuration(Optional<Duration>) - Method in class com.ngrok.definitions.EndpointSamlMutate.Builder
-
Integer number of seconds of the maximum duration of an authenticated session.
- metadata(String) - Method in class com.ngrok.services.AbuseReports.CreateCallBuilder
-
arbitrary user-defined data about this abuse report.
- metadata(String) - Method in class com.ngrok.services.AgentIngresses.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this Agent Ingress.
- metadata(String) - Method in class com.ngrok.services.AgentIngresses.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this Agent Ingress.
- metadata(String) - Method in class com.ngrok.services.ApiKeys.CreateCallBuilder
-
arbitrary user-defined data of this API key.
- metadata(String) - Method in class com.ngrok.services.ApiKeys.UpdateCallBuilder
-
arbitrary user-defined data of this API key.
- metadata(String) - Method in class com.ngrok.services.CertificateAuthorities.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this Certificate Authority.
- metadata(String) - Method in class com.ngrok.services.CertificateAuthorities.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this Certificate Authority.
- metadata(String) - Method in class com.ngrok.services.Credentials.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this credential.
- metadata(String) - Method in class com.ngrok.services.Credentials.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this credential.
- metadata(String) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this endpoint configuration.
- metadata(String) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this endpoint configuration.
- metadata(String) - Method in class com.ngrok.services.EventDestinations.CreateCallBuilder
-
Arbitrary user-defined machine-readable data of this Event Destination.
- metadata(String) - Method in class com.ngrok.services.EventDestinations.UpdateCallBuilder
-
Arbitrary user-defined machine-readable data of this Event Destination.
- metadata(String) - Method in class com.ngrok.services.EventStreams.CreateCallBuilder
-
Arbitrary user-defined machine-readable data of this Event Stream.
- metadata(String) - Method in class com.ngrok.services.EventStreams.UpdateCallBuilder
-
Arbitrary user-defined machine-readable data of this Event Stream.
- metadata(String) - Method in class com.ngrok.services.EventSubscriptions.CreateCallBuilder
-
Arbitrary customer supplied information intended to be machine readable.
- metadata(String) - Method in class com.ngrok.services.EventSubscriptions.UpdateCallBuilder
-
Arbitrary customer supplied information intended to be machine readable.
- metadata(String) - Method in class com.ngrok.services.IpPolicies.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this IP policy.
- metadata(String) - Method in class com.ngrok.services.IpPolicies.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this IP policy.
- metadata(String) - Method in class com.ngrok.services.IpPolicyRules.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this IP policy rule.
- metadata(String) - Method in class com.ngrok.services.IpPolicyRules.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this IP policy rule.
- metadata(String) - Method in class com.ngrok.services.IpRestrictions.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this IP restriction.
- metadata(String) - Method in class com.ngrok.services.IpRestrictions.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this IP restriction.
- metadata(String) - Method in class com.ngrok.services.ReservedAddrs.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this reserved address.
- metadata(String) - Method in class com.ngrok.services.ReservedAddrs.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this reserved address.
- metadata(String) - Method in class com.ngrok.services.ReservedDomains.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this reserved domain.
- metadata(String) - Method in class com.ngrok.services.ReservedDomains.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this reserved domain.
- metadata(String) - Method in class com.ngrok.services.SshCertificateAuthorities.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this SSH Certificate Authority.
- metadata(String) - Method in class com.ngrok.services.SshCertificateAuthorities.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this SSH Certificate Authority.
- metadata(String) - Method in class com.ngrok.services.SshCredentials.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this ssh credential.
- metadata(String) - Method in class com.ngrok.services.SshCredentials.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this ssh credential.
- metadata(String) - Method in class com.ngrok.services.SshHostCertificates.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this SSH Host Certificate.
- metadata(String) - Method in class com.ngrok.services.SshHostCertificates.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this SSH Host Certificate.
- metadata(String) - Method in class com.ngrok.services.SshUserCertificates.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this SSH User Certificate.
- metadata(String) - Method in class com.ngrok.services.SshUserCertificates.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this SSH User Certificate.
- metadata(String) - Method in class com.ngrok.services.TlsCertificates.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this TLS certificate.
- metadata(String) - Method in class com.ngrok.services.TlsCertificates.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this TLS certificate.
- metadata(Optional<String>) - Method in class com.ngrok.services.AbuseReports.CreateCallBuilder
-
arbitrary user-defined data about this abuse report.
- metadata(Optional<String>) - Method in class com.ngrok.services.AgentIngresses.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this Agent Ingress.
- metadata(Optional<String>) - Method in class com.ngrok.services.AgentIngresses.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this Agent Ingress.
- metadata(Optional<String>) - Method in class com.ngrok.services.ApiKeys.CreateCallBuilder
-
arbitrary user-defined data of this API key.
- metadata(Optional<String>) - Method in class com.ngrok.services.ApiKeys.UpdateCallBuilder
-
arbitrary user-defined data of this API key.
- metadata(Optional<String>) - Method in class com.ngrok.services.CertificateAuthorities.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this Certificate Authority.
- metadata(Optional<String>) - Method in class com.ngrok.services.CertificateAuthorities.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this Certificate Authority.
- metadata(Optional<String>) - Method in class com.ngrok.services.Credentials.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this credential.
- metadata(Optional<String>) - Method in class com.ngrok.services.Credentials.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this credential.
- metadata(Optional<String>) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this endpoint configuration.
- metadata(Optional<String>) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this endpoint configuration.
- metadata(Optional<String>) - Method in class com.ngrok.services.EventDestinations.CreateCallBuilder
-
Arbitrary user-defined machine-readable data of this Event Destination.
- metadata(Optional<String>) - Method in class com.ngrok.services.EventDestinations.UpdateCallBuilder
-
Arbitrary user-defined machine-readable data of this Event Destination.
- metadata(Optional<String>) - Method in class com.ngrok.services.EventStreams.CreateCallBuilder
-
Arbitrary user-defined machine-readable data of this Event Stream.
- metadata(Optional<String>) - Method in class com.ngrok.services.EventStreams.UpdateCallBuilder
-
Arbitrary user-defined machine-readable data of this Event Stream.
- metadata(Optional<String>) - Method in class com.ngrok.services.EventSubscriptions.CreateCallBuilder
-
Arbitrary customer supplied information intended to be machine readable.
- metadata(Optional<String>) - Method in class com.ngrok.services.EventSubscriptions.UpdateCallBuilder
-
Arbitrary customer supplied information intended to be machine readable.
- metadata(Optional<String>) - Method in class com.ngrok.services.IpPolicies.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this IP policy.
- metadata(Optional<String>) - Method in class com.ngrok.services.IpPolicies.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this IP policy.
- metadata(Optional<String>) - Method in class com.ngrok.services.IpPolicyRules.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this IP policy rule.
- metadata(Optional<String>) - Method in class com.ngrok.services.IpPolicyRules.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this IP policy rule.
- metadata(Optional<String>) - Method in class com.ngrok.services.IpRestrictions.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this IP restriction.
- metadata(Optional<String>) - Method in class com.ngrok.services.IpRestrictions.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this IP restriction.
- metadata(Optional<String>) - Method in class com.ngrok.services.ReservedAddrs.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this reserved address.
- metadata(Optional<String>) - Method in class com.ngrok.services.ReservedAddrs.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this reserved address.
- metadata(Optional<String>) - Method in class com.ngrok.services.ReservedDomains.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this reserved domain.
- metadata(Optional<String>) - Method in class com.ngrok.services.ReservedDomains.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this reserved domain.
- metadata(Optional<String>) - Method in class com.ngrok.services.SshCertificateAuthorities.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this SSH Certificate Authority.
- metadata(Optional<String>) - Method in class com.ngrok.services.SshCertificateAuthorities.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this SSH Certificate Authority.
- metadata(Optional<String>) - Method in class com.ngrok.services.SshCredentials.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this ssh credential.
- metadata(Optional<String>) - Method in class com.ngrok.services.SshCredentials.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this ssh credential.
- metadata(Optional<String>) - Method in class com.ngrok.services.SshHostCertificates.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this SSH Host Certificate.
- metadata(Optional<String>) - Method in class com.ngrok.services.SshHostCertificates.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this SSH Host Certificate.
- metadata(Optional<String>) - Method in class com.ngrok.services.SshUserCertificates.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this SSH User Certificate.
- metadata(Optional<String>) - Method in class com.ngrok.services.SshUserCertificates.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this SSH User Certificate.
- metadata(Optional<String>) - Method in class com.ngrok.services.TlsCertificates.CreateCallBuilder
-
arbitrary user-defined machine-readable data of this TLS certificate.
- metadata(Optional<String>) - Method in class com.ngrok.services.TlsCertificates.UpdateCallBuilder
-
arbitrary user-defined machine-readable data of this TLS certificate.
- microsoft(EndpointOAuthMicrosoft) - Method in class com.ngrok.definitions.EndpointOAuthProvider.Builder
-
configuration for using microsoft as the identity provider
- microsoft(Optional<EndpointOAuthMicrosoft>) - Method in class com.ngrok.definitions.EndpointOAuthProvider.Builder
-
configuration for using microsoft as the identity provider
- minVersion(String) - Method in class com.ngrok.definitions.EndpointTlsTermination.Builder
-
The minimum TLS version used for termination and advertised to the client during the TLS handshake.
- minVersion(Optional<String>) - Method in class com.ngrok.definitions.EndpointTlsTermination.Builder
-
The minimum TLS version used for termination and advertised to the client during the TLS handshake.
- module(EndpointCircuitBreaker) - Method in class com.ngrok.services.EndpointCircuitBreakerModule.ReplaceCallBuilder
-
Sets the
moduleparameter. - module(EndpointCompression) - Method in class com.ngrok.services.EndpointCompressionModule.ReplaceCallBuilder
-
Sets the
moduleparameter. - module(EndpointIpPolicyMutate) - Method in class com.ngrok.services.EndpointIpPolicyModule.ReplaceCallBuilder
-
Sets the
moduleparameter. - module(EndpointLoggingMutate) - Method in class com.ngrok.services.EndpointLoggingModule.ReplaceCallBuilder
-
Sets the
moduleparameter. - module(EndpointMutualTlsMutate) - Method in class com.ngrok.services.EndpointMutualTlsModule.ReplaceCallBuilder
-
Sets the
moduleparameter. - module(EndpointOAuth) - Method in class com.ngrok.services.EndpointOAuthModule.ReplaceCallBuilder
-
Sets the
moduleparameter. - module(EndpointOidc) - Method in class com.ngrok.services.EndpointOidcModule.ReplaceCallBuilder
-
Sets the
moduleparameter. - module(EndpointRequestHeaders) - Method in class com.ngrok.services.EndpointRequestHeadersModule.ReplaceCallBuilder
-
Sets the
moduleparameter. - module(EndpointResponseHeaders) - Method in class com.ngrok.services.EndpointResponseHeadersModule.ReplaceCallBuilder
-
Sets the
moduleparameter. - module(EndpointSamlMutate) - Method in class com.ngrok.services.EndpointSamlModule.ReplaceCallBuilder
-
Sets the
moduleparameter. - module(EndpointTlsTermination) - Method in class com.ngrok.services.EndpointTlsTerminationModule.ReplaceCallBuilder
-
Sets the
moduleparameter. - module(EndpointWebhookValidation) - Method in class com.ngrok.services.EndpointWebhookValidationModule.ReplaceCallBuilder
-
Sets the
moduleparameter. - module(Optional<EndpointCircuitBreaker>) - Method in class com.ngrok.services.EndpointCircuitBreakerModule.ReplaceCallBuilder
-
Sets (or unsets) the
moduleparameter. - module(Optional<EndpointCompression>) - Method in class com.ngrok.services.EndpointCompressionModule.ReplaceCallBuilder
-
Sets (or unsets) the
moduleparameter. - module(Optional<EndpointIpPolicyMutate>) - Method in class com.ngrok.services.EndpointIpPolicyModule.ReplaceCallBuilder
-
Sets (or unsets) the
moduleparameter. - module(Optional<EndpointLoggingMutate>) - Method in class com.ngrok.services.EndpointLoggingModule.ReplaceCallBuilder
-
Sets (or unsets) the
moduleparameter. - module(Optional<EndpointMutualTlsMutate>) - Method in class com.ngrok.services.EndpointMutualTlsModule.ReplaceCallBuilder
-
Sets (or unsets) the
moduleparameter. - module(Optional<EndpointOAuth>) - Method in class com.ngrok.services.EndpointOAuthModule.ReplaceCallBuilder
-
Sets (or unsets) the
moduleparameter. - module(Optional<EndpointOidc>) - Method in class com.ngrok.services.EndpointOidcModule.ReplaceCallBuilder
-
Sets (or unsets) the
moduleparameter. - module(Optional<EndpointRequestHeaders>) - Method in class com.ngrok.services.EndpointRequestHeadersModule.ReplaceCallBuilder
-
Sets (or unsets) the
moduleparameter. - module(Optional<EndpointResponseHeaders>) - Method in class com.ngrok.services.EndpointResponseHeadersModule.ReplaceCallBuilder
-
Sets (or unsets) the
moduleparameter. - module(Optional<EndpointSamlMutate>) - Method in class com.ngrok.services.EndpointSamlModule.ReplaceCallBuilder
-
Sets (or unsets) the
moduleparameter. - module(Optional<EndpointTlsTermination>) - Method in class com.ngrok.services.EndpointTlsTerminationModule.ReplaceCallBuilder
-
Sets (or unsets) the
moduleparameter. - module(Optional<EndpointWebhookValidation>) - Method in class com.ngrok.services.EndpointWebhookValidationModule.ReplaceCallBuilder
-
Sets (or unsets) the
moduleparameter. - mutualTls() - Method in class com.ngrok.Ngrok.PointcfgModuleNamespace
-
Creates a service client for
EndpointMutualTlsModule. - mutualTls(EndpointMutualTlsMutate) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
mutual TLS module configuration or
null - mutualTls(EndpointMutualTlsMutate) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
mutual TLS module configuration or
null - mutualTls(Optional<EndpointMutualTlsMutate>) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
mutual TLS module configuration or
null - mutualTls(Optional<EndpointMutualTlsMutate>) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
mutual TLS module configuration or
null
N
- nameidFormat(String) - Method in class com.ngrok.definitions.EndpointSamlMutate.Builder
-
Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects.
- nameidFormat(Optional<String>) - Method in class com.ngrok.definitions.EndpointSamlMutate.Builder
-
Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects.
- newBuilder() - Static method in class com.ngrok.definitions.AwsAuth
-
Creates a new builder for the
AwsAuthtype. - newBuilder() - Static method in class com.ngrok.definitions.EndpointCircuitBreaker
-
Creates a new builder for the
EndpointCircuitBreakertype. - newBuilder() - Static method in class com.ngrok.definitions.EndpointCompression
-
Creates a new builder for the
EndpointCompressiontype. - newBuilder() - Static method in class com.ngrok.definitions.EndpointIpPolicyMutate
-
Creates a new builder for the
EndpointIpPolicyMutatetype. - newBuilder() - Static method in class com.ngrok.definitions.EndpointLoggingMutate
-
Creates a new builder for the
EndpointLoggingMutatetype. - newBuilder() - Static method in class com.ngrok.definitions.EndpointMutualTlsMutate
-
Creates a new builder for the
EndpointMutualTlsMutatetype. - newBuilder() - Static method in class com.ngrok.definitions.EndpointOAuth
-
Creates a new builder for the
EndpointOAuthtype. - newBuilder() - Static method in class com.ngrok.definitions.EndpointOAuthFacebook
-
Creates a new builder for the
EndpointOAuthFacebooktype. - newBuilder() - Static method in class com.ngrok.definitions.EndpointOAuthGitHub
-
Creates a new builder for the
EndpointOAuthGitHubtype. - newBuilder() - Static method in class com.ngrok.definitions.EndpointOAuthGoogle
-
Creates a new builder for the
EndpointOAuthGoogletype. - newBuilder() - Static method in class com.ngrok.definitions.EndpointOAuthMicrosoft
-
Creates a new builder for the
EndpointOAuthMicrosofttype. - newBuilder() - Static method in class com.ngrok.definitions.EndpointOAuthProvider
-
Creates a new builder for the
EndpointOAuthProvidertype. - newBuilder() - Static method in class com.ngrok.definitions.EndpointOidc
-
Creates a new builder for the
EndpointOidctype. - newBuilder() - Static method in class com.ngrok.definitions.EndpointRequestHeaders
-
Creates a new builder for the
EndpointRequestHeaderstype. - newBuilder() - Static method in class com.ngrok.definitions.EndpointResponseHeaders
-
Creates a new builder for the
EndpointResponseHeaderstype. - newBuilder() - Static method in class com.ngrok.definitions.EndpointSamlMutate
-
Creates a new builder for the
EndpointSamlMutatetype. - newBuilder() - Static method in class com.ngrok.definitions.EndpointTlsTermination
-
Creates a new builder for the
EndpointTlsTerminationtype. - newBuilder() - Static method in class com.ngrok.definitions.EndpointWebhookValidation
-
Creates a new builder for the
EndpointWebhookValidationtype. - newBuilder() - Static method in class com.ngrok.definitions.EventSourceReplace
-
Creates a new builder for the
EventSourceReplacetype. - newBuilder() - Static method in class com.ngrok.definitions.EventTarget
-
Creates a new builder for the
EventTargettype. - newBuilder() - Static method in class com.ngrok.definitions.EventTargetCloudwatchLogs
-
Creates a new builder for the
EventTargetCloudwatchLogstype. - newBuilder() - Static method in class com.ngrok.definitions.EventTargetFirehose
-
Creates a new builder for the
EventTargetFirehosetype. - newBuilder() - Static method in class com.ngrok.definitions.EventTargetKinesis
-
Creates a new builder for the
EventTargetKinesistype. - newBuilder() - Static method in class com.ngrok.definitions.ReservedDomainCertPolicy
-
Creates a new builder for the
ReservedDomainCertPolicytype. - newBuilder(String) - Static method in class com.ngrok.DefaultNgrokApiClient
-
Creates a new ngrok API client builder.
- newBuilder(String) - Static method in class com.ngrok.definitions.AwsRole
-
Creates a new builder for the
AwsRoletype. - newBuilder(String, String) - Static method in class com.ngrok.definitions.AwsCredentials
-
Creates a new builder for the
AwsCredentialstype. - newDefaultHttpClient() - Static method in class com.ngrok.DefaultNgrokApiClient
-
Creates a new default Armeria
WebClient. - next() - Method in class com.ngrok.definitions.Page
-
Fetches the next page of responses, if any.
- Ngrok - Class in com.ngrok
-
Main entry point for the ngrok API.
- Ngrok(NgrokApiClient) - Constructor for class com.ngrok.Ngrok
-
Create a new ngrok API instance.
- Ngrok.PointcfgModuleNamespace - Class in com.ngrok
-
A namespace object for PointcfgModule.
- NgrokApiClient - Interface in com.ngrok
-
API client interface.
- NgrokApiClient.HttpMethod - Enum in com.ngrok
-
HTTP request methods
- NgrokApiError - Exception in com.ngrok.definitions
-
Representation of an API error from ngrok.
- NgrokApiError(int) - Constructor for exception com.ngrok.definitions.NgrokApiError
-
Creates a new API error.
- NgrokApiError(int, Optional<String>, Throwable) - Constructor for exception com.ngrok.definitions.NgrokApiError
-
Creates a new API error.
- NgrokApiError(String, int, Optional<String>, Map<String, String>) - Constructor for exception com.ngrok.definitions.NgrokApiError
-
Creates a new API error.
- numBuckets(long) - Method in class com.ngrok.definitions.EndpointCircuitBreaker.Builder
-
Integer number of buckets into which metrics are retained.
- numBuckets(Optional<Long>) - Method in class com.ngrok.definitions.EndpointCircuitBreaker.Builder
-
Integer number of buckets into which metrics are retained.
O
- oauth() - Method in class com.ngrok.Ngrok.PointcfgModuleNamespace
-
Creates a service client for
EndpointOAuthModule. - oauth(EndpointOAuth) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
oauth module configuration or
null - oauth(EndpointOAuth) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
oauth module configuration or
null - oauth(Optional<EndpointOAuth>) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
oauth module configuration or
null - oauth(Optional<EndpointOAuth>) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
oauth module configuration or
null - objectMapper(ObjectMapper) - Method in class com.ngrok.DefaultNgrokApiClient.Builder
-
Sets the Jackson object mapper to use to serialize request bodies and deserialize response bodies.
- objectMapper(Optional<ObjectMapper>) - Method in class com.ngrok.DefaultNgrokApiClient.Builder
-
Sets the Jackson object mapper to use to serialize request bodies and deserialize response bodies.
- oidc() - Method in class com.ngrok.Ngrok.PointcfgModuleNamespace
-
Creates a service client for
EndpointOidcModule. - oidc(EndpointOidc) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
oidc module configuration or
null - oidc(EndpointOidc) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
oidc module configuration or
null - oidc(Optional<EndpointOidc>) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
oidc module configuration or
null - oidc(Optional<EndpointOidc>) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
oidc module configuration or
null - optionsPassthrough(boolean) - Method in class com.ngrok.definitions.EndpointOAuth.Builder
-
Do not enforce authentication on HTTP OPTIONS requests.
- optionsPassthrough(boolean) - Method in class com.ngrok.definitions.EndpointOidc.Builder
-
Do not enforce authentication on HTTP OPTIONS requests.
- optionsPassthrough(boolean) - Method in class com.ngrok.definitions.EndpointSamlMutate.Builder
-
Do not enforce authentication on HTTP OPTIONS requests.
- optionsPassthrough(Optional<Boolean>) - Method in class com.ngrok.definitions.EndpointOAuth.Builder
-
Do not enforce authentication on HTTP OPTIONS requests.
- optionsPassthrough(Optional<Boolean>) - Method in class com.ngrok.definitions.EndpointOidc.Builder
-
Do not enforce authentication on HTTP OPTIONS requests.
- optionsPassthrough(Optional<Boolean>) - Method in class com.ngrok.definitions.EndpointSamlMutate.Builder
-
Do not enforce authentication on HTTP OPTIONS requests.
- organizations(List<String>) - Method in class com.ngrok.definitions.EndpointOAuthGitHub.Builder
-
a list of github org identifiers.
- organizations(Optional<List<String>>) - Method in class com.ngrok.definitions.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
Pageableresponse. - Page(NgrokApiClient, T) - Constructor for class com.ngrok.definitions.Page
-
Create a new page.
- Pageable - Interface in com.ngrok.definitions
-
Interface indicating a resource type that can have more than one page of responses.
- PATCH - Enum constant in enum com.ngrok.NgrokApiClient.HttpMethod
-
HTTP PATCH
- pointcfgModule() - Method in class com.ngrok.Ngrok
-
Creates a namespace object for PointcfgModule.
- POST - Enum constant in enum com.ngrok.NgrokApiClient.HttpMethod
-
HTTP POST
- principals(List<String>) - Method in class com.ngrok.services.SshHostCertificates.CreateCallBuilder
-
the list of principals included in the ssh host certificate.
- principals(List<String>) - Method in class com.ngrok.services.SshUserCertificates.CreateCallBuilder
-
the list of principals included in the ssh user certificate.
- principals(Optional<List<String>>) - Method in class com.ngrok.services.SshHostCertificates.CreateCallBuilder
-
the list of principals included in the ssh host certificate.
- principals(Optional<List<String>>) - Method in class com.ngrok.services.SshUserCertificates.CreateCallBuilder
-
the list of principals included in the ssh user certificate.
- privateKeyType(String) - Method in class com.ngrok.definitions.ReservedDomainCertPolicy.Builder
-
type of private key to use when requesting certificates.
- privateKeyType(String) - Method in class com.ngrok.services.SshCertificateAuthorities.CreateCallBuilder
-
the type of private key to generate.
- privateKeyType(Optional<String>) - Method in class com.ngrok.definitions.ReservedDomainCertPolicy.Builder
-
type of private key to use when requesting certificates.
- privateKeyType(Optional<String>) - Method in class com.ngrok.services.SshCertificateAuthorities.CreateCallBuilder
-
the type of private key to generate.
- provider(EndpointOAuthProvider) - Method in class com.ngrok.definitions.EndpointOAuth.Builder
-
an object which defines the identity provider to use for authentication and configuration for who may access the endpoint
- provider(String) - Method in class com.ngrok.definitions.EndpointWebhookValidation.Builder
-
a string indicating which webhook provider will be sending webhooks to this endpoint.
- provider(Optional<EndpointOAuthProvider>) - Method in class com.ngrok.definitions.EndpointOAuth.Builder
-
an object which defines the identity provider to use for authentication and configuration for who may access the endpoint
- provider(Optional<String>) - Method in class com.ngrok.definitions.EndpointWebhookValidation.Builder
-
a string indicating which webhook provider will be sending webhooks to this endpoint.
- PUT - Enum constant in enum com.ngrok.NgrokApiClient.HttpMethod
-
HTTP PUT
R
- Ref - Class in com.ngrok.definitions
-
A class encapsulating the
Refresource. - Ref(String, URI) - Constructor for class com.ngrok.definitions.Ref
-
Creates a new instance of
Ref. - region(String) - Method in class com.ngrok.services.ReservedAddrs.CreateCallBuilder
-
reserve the address in this geographic ngrok datacenter.
- region(String) - Method in class com.ngrok.services.ReservedDomains.CreateCallBuilder
-
reserve the domain in this geographic ngrok datacenter.
- region(Optional<String>) - Method in class com.ngrok.services.ReservedAddrs.CreateCallBuilder
-
reserve the address in this geographic ngrok datacenter.
- region(Optional<String>) - Method in class com.ngrok.services.ReservedDomains.CreateCallBuilder
-
reserve the domain in this geographic ngrok datacenter.
- remove(List<String>) - Method in class com.ngrok.definitions.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>) - Method in class com.ngrok.definitions.EndpointResponseHeaders.Builder
-
a list of header names that will be removed from the HTTP Response returned to the HTTP client
- remove(Optional<List<String>>) - Method in class com.ngrok.definitions.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>>) - Method in class com.ngrok.definitions.EndpointResponseHeaders.Builder
-
a list of header names that will be removed from the HTTP Response returned to the HTTP client
- replace(String) - Method in class com.ngrok.services.EndpointCircuitBreakerModule
-
Creates a call builder for the Replace API operation.
- replace(String) - Method in class com.ngrok.services.EndpointCompressionModule
-
Creates a call builder for the Replace API operation.
- replace(String) - Method in class com.ngrok.services.EndpointIpPolicyModule
-
Creates a call builder for the Replace API operation.
- replace(String) - Method in class com.ngrok.services.EndpointLoggingModule
-
Creates a call builder for the Replace API operation.
- replace(String) - Method in class com.ngrok.services.EndpointMutualTlsModule
-
Creates a call builder for the Replace API operation.
- replace(String) - Method in class com.ngrok.services.EndpointOAuthModule
-
Creates a call builder for the Replace API operation.
- replace(String) - Method in class com.ngrok.services.EndpointOidcModule
-
Creates a call builder for the Replace API operation.
- replace(String) - Method in class com.ngrok.services.EndpointRequestHeadersModule
-
Creates a call builder for the Replace API operation.
- replace(String) - Method in class com.ngrok.services.EndpointResponseHeadersModule
-
Creates a call builder for the Replace API operation.
- replace(String) - Method in class com.ngrok.services.EndpointSamlModule
-
Creates a call builder for the Replace API operation.
- replace(String) - Method in class com.ngrok.services.EndpointTlsTerminationModule
-
Creates a call builder for the Replace API operation.
- replace(String) - Method in class com.ngrok.services.EndpointWebhookValidationModule
-
Creates a call builder for the Replace API operation.
- requestHeaders() - Method in class com.ngrok.Ngrok.PointcfgModuleNamespace
-
Creates a service client for
EndpointRequestHeadersModule. - requestHeaders(EndpointRequestHeaders) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
request headers module configuration or
null - requestHeaders(EndpointRequestHeaders) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
request headers module configuration or
null - requestHeaders(Optional<EndpointRequestHeaders>) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
request headers module configuration or
null - requestHeaders(Optional<EndpointRequestHeaders>) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
request headers module configuration or
null - ReservedAddr - Class in com.ngrok.definitions
-
A class encapsulating the
ReservedAddrresource. - ReservedAddr(String, URI, OffsetDateTime, String, String, String, String, Optional<Ref>) - Constructor for class com.ngrok.definitions.ReservedAddr
-
Creates a new instance of
ReservedAddr. - ReservedAddrList - Class in com.ngrok.definitions
-
A class encapsulating the
ReservedAddrListresource. - ReservedAddrList(List<ReservedAddr>, URI, Optional<URI>) - Constructor for class com.ngrok.definitions.ReservedAddrList
-
Creates a new instance of
ReservedAddrList. - reservedAddrs() - Method in class com.ngrok.Ngrok
-
Reserved Addresses are TCP addresses that can be used to listen for traffic.
- ReservedAddrs - Class in com.ngrok.services
-
Reserved Addresses are TCP addresses that can be used to listen for traffic.
- ReservedAddrs(NgrokApiClient) - Constructor for class com.ngrok.services.ReservedAddrs
-
Creates a new sub-client for ReservedAddrs.
- ReservedAddrs.CreateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Create API call.
- ReservedAddrs.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- ReservedAddrs.DeleteEndpointConfigCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent DeleteEndpointConfig API call.
- ReservedAddrs.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- ReservedAddrs.ListCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent List API call.
- ReservedAddrs.UpdateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Update API call.
- ReservedDomain - Class in com.ngrok.definitions
-
A class encapsulating the
ReservedDomainresource. - ReservedDomain(String, URI, OffsetDateTime, String, String, String, String, Optional<String>, Optional<Ref>, Optional<Ref>, Optional<Ref>, Optional<ReservedDomainCertPolicy>, Optional<ReservedDomainCertStatus>, Optional<String>) - Constructor for class com.ngrok.definitions.ReservedDomain
-
Creates a new instance of
ReservedDomain. - ReservedDomainCertJob - Class in com.ngrok.definitions
-
A class encapsulating the
ReservedDomainCertJobresource. - ReservedDomainCertJob(Optional<String>, String, OffsetDateTime, Optional<OffsetDateTime>) - Constructor for class com.ngrok.definitions.ReservedDomainCertJob
-
Creates a new instance of
ReservedDomainCertJob. - ReservedDomainCertPolicy - Class in com.ngrok.definitions
-
A class encapsulating the
ReservedDomainCertPolicyresource. - ReservedDomainCertPolicy.Builder - Class in com.ngrok.definitions
-
Builder class for
ReservedDomainCertPolicy. - ReservedDomainCertStatus - Class in com.ngrok.definitions
-
A class encapsulating the
ReservedDomainCertStatusresource. - ReservedDomainCertStatus(Optional<OffsetDateTime>, Optional<ReservedDomainCertJob>) - Constructor for class com.ngrok.definitions.ReservedDomainCertStatus
-
Creates a new instance of
ReservedDomainCertStatus. - ReservedDomainList - Class in com.ngrok.definitions
-
A class encapsulating the
ReservedDomainListresource. - ReservedDomainList(List<ReservedDomain>, URI, Optional<URI>) - Constructor for class com.ngrok.definitions.ReservedDomainList
-
Creates a new instance of
ReservedDomainList. - reservedDomains() - Method in class com.ngrok.Ngrok
-
Reserved Domains are hostnames that you can listen for traffic on.
- ReservedDomains - Class in com.ngrok.services
-
Reserved Domains are hostnames that you can listen for traffic on.
- ReservedDomains(NgrokApiClient) - Constructor for class com.ngrok.services.ReservedDomains
-
Creates a new sub-client for ReservedDomains.
- ReservedDomains.CreateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Create API call.
- ReservedDomains.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- ReservedDomains.DeleteCertificateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent DeleteCertificate API call.
- ReservedDomains.DeleteCertificateManagementPolicyCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent DeleteCertificateManagementPolicy API call.
- ReservedDomains.DeleteHttpEndpointConfigCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent DeleteHttpEndpointConfig API call.
- ReservedDomains.DeleteHttpsEndpointConfigCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent DeleteHttpsEndpointConfig API call.
- ReservedDomains.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- ReservedDomains.ListCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent List API call.
- ReservedDomains.UpdateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Update API call.
- responseHeaders() - Method in class com.ngrok.Ngrok.PointcfgModuleNamespace
-
Creates a service client for
EndpointResponseHeadersModule. - responseHeaders(EndpointResponseHeaders) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
response headers module configuration or
null - responseHeaders(EndpointResponseHeaders) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
response headers module configuration or
null - responseHeaders(Optional<EndpointResponseHeaders>) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
response headers module configuration or
null - responseHeaders(Optional<EndpointResponseHeaders>) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
response headers module configuration or
null - restart(String) - Method in class com.ngrok.services.TunnelSessions
-
Issues a command instructing the ngrok agent to restart.
- role(AwsRole) - Method in class com.ngrok.definitions.AwsAuth.Builder
-
A role for ngrok to assume on your behalf to deposit events into your AWS account.
- role(Optional<AwsRole>) - Method in class com.ngrok.definitions.AwsAuth.Builder
-
A role for ngrok to assume on your behalf to deposit events into your AWS account.
- rollingWindow(long) - Method in class com.ngrok.definitions.EndpointCircuitBreaker.Builder
-
Integer number of seconds in the statistical rolling window that metrics are retained for.
- rollingWindow(Optional<Long>) - Method in class com.ngrok.definitions.EndpointCircuitBreaker.Builder
-
Integer number of seconds in the statistical rolling window that metrics are retained for.
S
- saml() - Method in class com.ngrok.Ngrok.PointcfgModuleNamespace
-
Creates a service client for
EndpointSamlModule. - saml(EndpointSamlMutate) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
saml module configuration or
null - saml(EndpointSamlMutate) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
saml module configuration or
null - saml(Optional<EndpointSamlMutate>) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
saml module configuration or
null - saml(Optional<EndpointSamlMutate>) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
saml module configuration or
null - samplingRate(double) - Method in class com.ngrok.services.EventStreams.CreateCallBuilder
-
The percentage of all events you would like to capture.
- samplingRate(double) - Method in class com.ngrok.services.EventStreams.UpdateCallBuilder
-
The percentage of all events you would like to capture.
- samplingRate(Optional<Double>) - Method in class com.ngrok.services.EventStreams.CreateCallBuilder
-
The percentage of all events you would like to capture.
- samplingRate(Optional<Double>) - Method in class com.ngrok.services.EventStreams.UpdateCallBuilder
-
The percentage of all events you would like to capture.
- scopes(List<String>) - Method in class com.ngrok.definitions.EndpointOAuthFacebook.Builder
-
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for.
- scopes(List<String>) - Method in class com.ngrok.definitions.EndpointOAuthGitHub.Builder
-
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for.
- scopes(List<String>) - Method in class com.ngrok.definitions.EndpointOAuthGoogle.Builder
-
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for.
- scopes(List<String>) - Method in class com.ngrok.definitions.EndpointOAuthMicrosoft.Builder
-
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for.
- scopes(List<String>) - Method in class com.ngrok.definitions.EndpointOidc.Builder
-
The set of scopes to request from the OIDC identity provider.
- scopes(Optional<List<String>>) - Method in class com.ngrok.definitions.EndpointOAuthFacebook.Builder
-
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for.
- scopes(Optional<List<String>>) - Method in class com.ngrok.definitions.EndpointOAuthGitHub.Builder
-
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for.
- scopes(Optional<List<String>>) - Method in class com.ngrok.definitions.EndpointOAuthGoogle.Builder
-
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for.
- scopes(Optional<List<String>>) - Method in class com.ngrok.definitions.EndpointOAuthMicrosoft.Builder
-
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for.
- scopes(Optional<List<String>>) - Method in class com.ngrok.definitions.EndpointOidc.Builder
-
The set of scopes to request from the OIDC identity provider.
- secret(String) - Method in class com.ngrok.definitions.EndpointWebhookValidation.Builder
-
a string secret used to validate requests from the given provider.
- secret(Optional<String>) - Method in class com.ngrok.definitions.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>>) - Method in class com.ngrok.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>>) - Method in interface com.ngrok.NgrokApiClient
-
Sends a request to the ngrok API.
- sendRequest(URI, Class<O>) - Method in class com.ngrok.DefaultNgrokApiClient
-
Sends a GET request directly to the specified URI.
- sendRequest(URI, Class<O>) - Method in interface com.ngrok.NgrokApiClient
-
Sends a GET request directly to the specified URI.
- sources(List<EventSourceReplace>) - Method in class com.ngrok.services.EventSubscriptions.CreateCallBuilder
-
Sources containing the types for which this event subscription will trigger
- sources(List<EventSourceReplace>) - Method in class com.ngrok.services.EventSubscriptions.UpdateCallBuilder
-
Sources containing the types for which this event subscription will trigger
- sources(Optional<List<EventSourceReplace>>) - Method in class com.ngrok.services.EventSubscriptions.CreateCallBuilder
-
Sources containing the types for which this event subscription will trigger
- sources(Optional<List<EventSourceReplace>>) - Method in class com.ngrok.services.EventSubscriptions.UpdateCallBuilder
-
Sources containing the types for which this event subscription will trigger
- sshCertificateAuthorities() - Method in class com.ngrok.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 - Class in 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) - Constructor for class com.ngrok.services.SshCertificateAuthorities
-
Creates a new sub-client for SshCertificateAuthorities.
- SshCertificateAuthorities.CreateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Create API call.
- SshCertificateAuthorities.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- SshCertificateAuthorities.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- SshCertificateAuthorities.ListCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent List API call.
- SshCertificateAuthorities.UpdateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Update API call.
- SshCertificateAuthority - Class in com.ngrok.definitions
-
A class encapsulating the
SshCertificateAuthorityresource. - SshCertificateAuthority(String, URI, OffsetDateTime, String, String, String, String) - Constructor for class com.ngrok.definitions.SshCertificateAuthority
-
Creates a new instance of
SshCertificateAuthority. - SshCertificateAuthorityList - Class in com.ngrok.definitions
-
A class encapsulating the
SshCertificateAuthorityListresource. - SshCertificateAuthorityList(List<SshCertificateAuthority>, URI, Optional<URI>) - Constructor for class com.ngrok.definitions.SshCertificateAuthorityList
-
Creates a new instance of
SshCertificateAuthorityList. - SshCredential - Class in com.ngrok.definitions
-
A class encapsulating the
SshCredentialresource. - SshCredential(String, URI, OffsetDateTime, String, String, String, List<String>) - Constructor for class com.ngrok.definitions.SshCredential
-
Creates a new instance of
SshCredential. - SshCredentialList - Class in com.ngrok.definitions
-
A class encapsulating the
SshCredentialListresource. - SshCredentialList(List<SshCredential>, URI, Optional<URI>) - Constructor for class com.ngrok.definitions.SshCredentialList
-
Creates a new instance of
SshCredentialList. - sshCredentials() - Method in class com.ngrok.Ngrok
-
SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.
- SshCredentials - Class in 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) - Constructor for class com.ngrok.services.SshCredentials
-
Creates a new sub-client for SshCredentials.
- SshCredentials.CreateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Create API call.
- SshCredentials.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- SshCredentials.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- SshCredentials.ListCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent List API call.
- SshCredentials.UpdateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Update API call.
- SshHostCertificate - Class in com.ngrok.definitions
-
A class encapsulating the
SshHostCertificateresource. - SshHostCertificate(String, URI, OffsetDateTime, String, String, String, String, String, List<String>, OffsetDateTime, OffsetDateTime, String) - Constructor for class com.ngrok.definitions.SshHostCertificate
-
Creates a new instance of
SshHostCertificate. - SshHostCertificateList - Class in com.ngrok.definitions
-
A class encapsulating the
SshHostCertificateListresource. - SshHostCertificateList(List<SshHostCertificate>, URI, Optional<URI>) - Constructor for class com.ngrok.definitions.SshHostCertificateList
-
Creates a new instance of
SshHostCertificateList. - sshHostCertificates() - Method in class com.ngrok.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 - Class in 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) - Constructor for class com.ngrok.services.SshHostCertificates
-
Creates a new sub-client for SshHostCertificates.
- SshHostCertificates.CreateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Create API call.
- SshHostCertificates.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- SshHostCertificates.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- SshHostCertificates.ListCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent List API call.
- SshHostCertificates.UpdateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Update API call.
- SshUserCertificate - Class in com.ngrok.definitions
-
A class encapsulating the
SshUserCertificateresource. - SshUserCertificate(String, URI, OffsetDateTime, String, String, String, String, String, List<String>, Map<String, String>, Map<String, String>, OffsetDateTime, OffsetDateTime, String) - Constructor for class com.ngrok.definitions.SshUserCertificate
-
Creates a new instance of
SshUserCertificate. - SshUserCertificateList - Class in com.ngrok.definitions
-
A class encapsulating the
SshUserCertificateListresource. - SshUserCertificateList(List<SshUserCertificate>, URI, Optional<URI>) - Constructor for class com.ngrok.definitions.SshUserCertificateList
-
Creates a new instance of
SshUserCertificateList. - sshUserCertificates() - Method in class com.ngrok.Ngrok
-
SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection.
- SshUserCertificates - Class in com.ngrok.services
-
SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection.
- SshUserCertificates(NgrokApiClient) - Constructor for class com.ngrok.services.SshUserCertificates
-
Creates a new sub-client for SshUserCertificates.
- SshUserCertificates.CreateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Create API call.
- SshUserCertificates.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- SshUserCertificates.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- SshUserCertificates.ListCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent List API call.
- SshUserCertificates.UpdateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Update API call.
- stop(String) - Method in class com.ngrok.services.TunnelSessions
-
Issues a command instructing the ngrok agent that started this tunnel session to exit.
- streamArn(String) - Method in class com.ngrok.definitions.EventTargetKinesis.Builder
-
An Amazon Resource Name specifying the Kinesis stream to deposit events into.
- streamArn(Optional<String>) - Method in class com.ngrok.definitions.EventTargetKinesis.Builder
-
An Amazon Resource Name specifying the Kinesis stream to deposit events into.
T
- target(EventTarget) - Method in class com.ngrok.services.EventDestinations.CreateCallBuilder
-
An object that encapsulates where and how to send your events.
- target(EventTarget) - Method in class com.ngrok.services.EventDestinations.UpdateCallBuilder
-
An object that encapsulates where and how to send your events.
- target(Optional<EventTarget>) - Method in class com.ngrok.services.EventDestinations.CreateCallBuilder
-
An object that encapsulates where and how to send your events.
- target(Optional<EventTarget>) - Method in class com.ngrok.services.EventDestinations.UpdateCallBuilder
-
An object that encapsulates where and how to send your events.
- teams(List<String>) - Method in class com.ngrok.definitions.EndpointOAuthGitHub.Builder
-
a list of github teams identifiers.
- teams(Optional<List<String>>) - Method in class com.ngrok.definitions.EndpointOAuthGitHub.Builder
-
a list of github teams identifiers.
- terminateAt(String) - Method in class com.ngrok.definitions.EndpointTlsTermination.Builder
-
edgeif the ngrok edge should terminate TLS traffic,upstreamif TLS traffic should be passed through to the upstream ngrok agent / application server for termination. - terminateAt(Optional<String>) - Method in class com.ngrok.definitions.EndpointTlsTermination.Builder
-
edgeif the ngrok edge should terminate TLS traffic,upstreamif TLS traffic should be passed through to the upstream ngrok agent / application server for termination. - TlsCertificate - Class in com.ngrok.definitions
-
A class encapsulating the
TlsCertificateresource. - 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) - Constructor for class com.ngrok.definitions.TlsCertificate
-
Creates a new instance of
TlsCertificate. - TlsCertificateList - Class in com.ngrok.definitions
-
A class encapsulating the
TlsCertificateListresource. - TlsCertificateList(List<TlsCertificate>, URI, Optional<URI>) - Constructor for class com.ngrok.definitions.TlsCertificateList
-
Creates a new instance of
TlsCertificateList. - tlsCertificates() - Method in class com.ngrok.Ngrok
-
TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic.
- TlsCertificates - Class in 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) - Constructor for class com.ngrok.services.TlsCertificates
-
Creates a new sub-client for TlsCertificates.
- TlsCertificates.CreateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Create API call.
- TlsCertificates.DeleteCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Delete API call.
- TlsCertificates.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- TlsCertificates.ListCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent List API call.
- TlsCertificates.UpdateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Update API call.
- TlsCertificateSaNs - Class in com.ngrok.definitions
-
A class encapsulating the
TlsCertificateSaNsresource. - TlsCertificateSaNs(List<String>, List<String>) - Constructor for class com.ngrok.definitions.TlsCertificateSaNs
-
Creates a new instance of
TlsCertificateSaNs. - tlsTermination() - Method in class com.ngrok.Ngrok.PointcfgModuleNamespace
-
Creates a service client for
EndpointTlsTerminationModule. - tlsTermination(EndpointTlsTermination) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
TLS termination module configuration or
null - tlsTermination(EndpointTlsTermination) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
TLS termination module configuration or
null - tlsTermination(Optional<EndpointTlsTermination>) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
TLS termination module configuration or
null - tlsTermination(Optional<EndpointTlsTermination>) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
TLS termination module configuration or
null - toString() - Method in class com.ngrok.definitions.AbuseReport
- toString() - Method in class com.ngrok.definitions.AbuseReportHostname
- toString() - Method in class com.ngrok.definitions.AgentIngress
- toString() - Method in class com.ngrok.definitions.AgentIngressList
- toString() - Method in class com.ngrok.definitions.ApiKey
- toString() - Method in class com.ngrok.definitions.ApiKeyList
- toString() - Method in class com.ngrok.definitions.AwsAuth
- toString() - Method in class com.ngrok.definitions.AwsCredentials
- toString() - Method in class com.ngrok.definitions.AwsRole
- toString() - Method in class com.ngrok.definitions.CertificateAuthority
- toString() - Method in class com.ngrok.definitions.CertificateAuthorityList
- toString() - Method in class com.ngrok.definitions.Credential
- toString() - Method in class com.ngrok.definitions.CredentialList
- toString() - Method in class com.ngrok.definitions.EndpointCircuitBreaker
- toString() - Method in class com.ngrok.definitions.EndpointCompression
- toString() - Method in class com.ngrok.definitions.EndpointConfiguration
- toString() - Method in class com.ngrok.definitions.EndpointConfigurationList
- toString() - Method in class com.ngrok.definitions.EndpointIpPolicy
- toString() - Method in class com.ngrok.definitions.EndpointIpPolicyMutate
- toString() - Method in class com.ngrok.definitions.EndpointLogging
- toString() - Method in class com.ngrok.definitions.EndpointLoggingMutate
- toString() - Method in class com.ngrok.definitions.EndpointMutualTls
- toString() - Method in class com.ngrok.definitions.EndpointMutualTlsMutate
- toString() - Method in class com.ngrok.definitions.EndpointOAuth
- toString() - Method in class com.ngrok.definitions.EndpointOAuthFacebook
- toString() - Method in class com.ngrok.definitions.EndpointOAuthGitHub
- toString() - Method in class com.ngrok.definitions.EndpointOAuthGoogle
- toString() - Method in class com.ngrok.definitions.EndpointOAuthMicrosoft
- toString() - Method in class com.ngrok.definitions.EndpointOAuthProvider
- toString() - Method in class com.ngrok.definitions.EndpointOidc
- toString() - Method in class com.ngrok.definitions.EndpointRequestHeaders
- toString() - Method in class com.ngrok.definitions.EndpointResponseHeaders
- toString() - Method in class com.ngrok.definitions.EndpointSaml
- toString() - Method in class com.ngrok.definitions.EndpointSamlMutate
- toString() - Method in class com.ngrok.definitions.EndpointTlsTermination
- toString() - Method in class com.ngrok.definitions.EndpointWebhookValidation
- toString() - Method in class com.ngrok.definitions.EventDestination
- toString() - Method in class com.ngrok.definitions.EventDestinationList
- toString() - Method in class com.ngrok.definitions.EventSource
- toString() - Method in class com.ngrok.definitions.EventSourceList
- toString() - Method in class com.ngrok.definitions.EventSourceReplace
- toString() - Method in class com.ngrok.definitions.EventStream
- toString() - Method in class com.ngrok.definitions.EventStreamList
- toString() - Method in class com.ngrok.definitions.EventSubscription
- toString() - Method in class com.ngrok.definitions.EventSubscriptionList
- toString() - Method in class com.ngrok.definitions.EventTarget
- toString() - Method in class com.ngrok.definitions.EventTargetCloudwatchLogs
- toString() - Method in class com.ngrok.definitions.EventTargetFirehose
- toString() - Method in class com.ngrok.definitions.EventTargetKinesis
- toString() - Method in class com.ngrok.definitions.IpPolicy
- toString() - Method in class com.ngrok.definitions.IpPolicyList
- toString() - Method in class com.ngrok.definitions.IpPolicyRule
- toString() - Method in class com.ngrok.definitions.IpPolicyRuleList
- toString() - Method in class com.ngrok.definitions.IpRestriction
- toString() - Method in class com.ngrok.definitions.IpRestrictionList
- toString() - Method in class com.ngrok.definitions.Ref
- toString() - Method in class com.ngrok.definitions.ReservedAddr
- toString() - Method in class com.ngrok.definitions.ReservedAddrList
- toString() - Method in class com.ngrok.definitions.ReservedDomain
- toString() - Method in class com.ngrok.definitions.ReservedDomainCertJob
- toString() - Method in class com.ngrok.definitions.ReservedDomainCertPolicy
- toString() - Method in class com.ngrok.definitions.ReservedDomainCertStatus
- toString() - Method in class com.ngrok.definitions.ReservedDomainList
- toString() - Method in class com.ngrok.definitions.SshCertificateAuthority
- toString() - Method in class com.ngrok.definitions.SshCertificateAuthorityList
- toString() - Method in class com.ngrok.definitions.SshCredential
- toString() - Method in class com.ngrok.definitions.SshCredentialList
- toString() - Method in class com.ngrok.definitions.SshHostCertificate
- toString() - Method in class com.ngrok.definitions.SshHostCertificateList
- toString() - Method in class com.ngrok.definitions.SshUserCertificate
- toString() - Method in class com.ngrok.definitions.SshUserCertificateList
- toString() - Method in class com.ngrok.definitions.TlsCertificate
- toString() - Method in class com.ngrok.definitions.TlsCertificateList
- toString() - Method in class com.ngrok.definitions.TlsCertificateSaNs
- toString() - Method in class com.ngrok.definitions.Tunnel
- toString() - Method in class com.ngrok.definitions.TunnelList
- toString() - Method in class com.ngrok.definitions.TunnelSession
- toString() - Method in class com.ngrok.definitions.TunnelSessionList
- trippedDuration(Duration) - Method in class com.ngrok.definitions.EndpointCircuitBreaker.Builder
-
Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health
- trippedDuration(Optional<Duration>) - Method in class com.ngrok.definitions.EndpointCircuitBreaker.Builder
-
Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health
- Tunnel - Class in com.ngrok.definitions
-
A class encapsulating the
Tunnelresource. - Tunnel(String, URI, OffsetDateTime, String, String, String, Ref) - Constructor for class com.ngrok.definitions.Tunnel
-
Creates a new instance of
Tunnel. - TunnelList - Class in com.ngrok.definitions
-
A class encapsulating the
TunnelListresource. - TunnelList(List<Tunnel>, URI, Optional<URI>) - Constructor for class com.ngrok.definitions.TunnelList
-
Creates a new instance of
TunnelList. - tunnels() - Method in class com.ngrok.Ngrok
-
Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.
- Tunnels - Class in 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) - Constructor for class com.ngrok.services.Tunnels
-
Creates a new sub-client for Tunnels.
- Tunnels.ListCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent List API call.
- TunnelSession - Class in com.ngrok.definitions
-
A class encapsulating the
TunnelSessionresource. - TunnelSession(String, Ref, String, String, String, String, String, OffsetDateTime, String, URI) - Constructor for class com.ngrok.definitions.TunnelSession
-
Creates a new instance of
TunnelSession. - TunnelSessionList - Class in com.ngrok.definitions
-
A class encapsulating the
TunnelSessionListresource. - TunnelSessionList(List<TunnelSession>, URI, Optional<URI>) - Constructor for class com.ngrok.definitions.TunnelSessionList
-
Creates a new instance of
TunnelSessionList. - tunnelSessions() - Method in class com.ngrok.Ngrok
-
Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service.
- TunnelSessions - Class in 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) - Constructor for class com.ngrok.services.TunnelSessions
-
Creates a new sub-client for TunnelSessions.
- TunnelSessions.GetCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Get API call.
- TunnelSessions.ListCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent List API call.
- TunnelSessions.RestartCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Restart API call.
- TunnelSessions.StopCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Stop API call.
- TunnelSessions.UpdateCallBuilder - Class in com.ngrok.services
-
A builder object encapsulating state for an unsent Update API call.
- type(String) - Method in class com.ngrok.definitions.EventSourceReplace.Builder
-
Type of event for which an event subscription will trigger
- type(String) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
they type of traffic this endpoint configuration can be applied to.
- type(String) - Method in class com.ngrok.services.EventSources.CreateCallBuilder
-
Type of event for which an event subscription will trigger
- type(Optional<String>) - Method in class com.ngrok.definitions.EventSourceReplace.Builder
-
Type of event for which an event subscription will trigger
- type(Optional<String>) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
they type of traffic this endpoint configuration can be applied to.
- type(Optional<String>) - Method in class com.ngrok.services.EventSources.CreateCallBuilder
-
Type of event for which an event subscription will trigger
U
- update(String) - Method in class com.ngrok.services.AgentIngresses
-
Update attributes of an Agent Ingress by ID.
- update(String) - Method in class com.ngrok.services.ApiKeys
-
Update attributes of an API key by ID.
- update(String) - Method in class com.ngrok.services.CertificateAuthorities
-
Update attributes of a Certificate Authority by ID See also https://ngrok.com/docs/api#api-certificate-authorities-update.
- update(String) - Method in class com.ngrok.services.Credentials
-
Update attributes of an tunnel authtoken credential by ID See also https://ngrok.com/docs/api#api-credentials-update.
- update(String) - Method in class com.ngrok.services.EndpointConfigurations
-
Updates an endpoint configuration.
- update(String) - Method in class com.ngrok.services.EventDestinations
-
Update attributes of an Event Destination.
- update(String) - Method in class com.ngrok.services.EventStreams
-
Update attributes of an Event Stream by ID.
- update(String) - Method in class com.ngrok.services.EventSubscriptions
-
Update an Event Subscription.
- update(String) - Method in class com.ngrok.services.IpPolicies
-
Update attributes of an IP policy by ID See also https://ngrok.com/docs/api#api-ip-policies-update.
- update(String) - Method in class com.ngrok.services.IpPolicyRules
-
Update attributes of an IP policy rule by ID See also https://ngrok.com/docs/api#api-ip-policy-rules-update.
- update(String) - Method in class com.ngrok.services.IpRestrictions
-
Update attributes of an IP restriction by ID See also https://ngrok.com/docs/api#api-ip-restrictions-update.
- update(String) - Method in class com.ngrok.services.ReservedAddrs
-
Update the attributes of a reserved address.
- update(String) - Method in class com.ngrok.services.ReservedDomains
-
Update the attributes of a reserved domain.
- update(String) - Method in class com.ngrok.services.SshCertificateAuthorities
-
Update an SSH Certificate Authority See also https://ngrok.com/docs/api#api-ssh-certificate-authorities-update.
- update(String) - Method in class com.ngrok.services.SshCredentials
-
Update attributes of an ssh_credential by ID See also https://ngrok.com/docs/api#api-ssh-credentials-update.
- update(String) - Method in class com.ngrok.services.SshHostCertificates
-
Update an SSH Host Certificate See also https://ngrok.com/docs/api#api-ssh-host-certificates-update.
- update(String) - Method in class com.ngrok.services.SshUserCertificates
-
Update an SSH User Certificate See also https://ngrok.com/docs/api#api-ssh-user-certificates-update.
- update(String) - Method in class com.ngrok.services.TlsCertificates
-
Update attributes of a TLS Certificate by ID See also https://ngrok.com/docs/api#api-tls-certificates-update.
- update(String) - Method in class com.ngrok.services.TunnelSessions
-
Issues a command instructing the ngrok agent to update itself to the latest version.
- update(String, String) - Method in class com.ngrok.services.EventSources
-
Update the type for which this event subscription will trigger See also https://ngrok.com/docs/api#api-event-sources-update.
V
- validAfter(OffsetDateTime) - Method in class com.ngrok.services.SshHostCertificates.CreateCallBuilder
-
The time when the host certificate becomes valid, in RFC 3339 format.
- validAfter(OffsetDateTime) - Method in class com.ngrok.services.SshUserCertificates.CreateCallBuilder
-
The time when the user certificate becomes valid, in RFC 3339 format.
- validAfter(Optional<OffsetDateTime>) - Method in class com.ngrok.services.SshHostCertificates.CreateCallBuilder
-
The time when the host certificate becomes valid, in RFC 3339 format.
- validAfter(Optional<OffsetDateTime>) - Method in class com.ngrok.services.SshUserCertificates.CreateCallBuilder
-
The time when the user certificate becomes valid, in RFC 3339 format.
- validUntil(OffsetDateTime) - Method in class com.ngrok.services.SshHostCertificates.CreateCallBuilder
-
The time when this host certificate becomes invalid, in RFC 3339 format.
- validUntil(OffsetDateTime) - Method in class com.ngrok.services.SshUserCertificates.CreateCallBuilder
-
The time when this host certificate becomes invalid, in RFC 3339 format.
- validUntil(Optional<OffsetDateTime>) - Method in class com.ngrok.services.SshHostCertificates.CreateCallBuilder
-
The time when this host certificate becomes invalid, in RFC 3339 format.
- validUntil(Optional<OffsetDateTime>) - Method in class com.ngrok.services.SshUserCertificates.CreateCallBuilder
-
The time when this host certificate becomes invalid, in RFC 3339 format.
- valueOf(String) - Static method in enum com.ngrok.NgrokApiClient.HttpMethod
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.ngrok.NgrokApiClient.HttpMethod
-
Returns an array containing the constants of this enum type, in the order they are declared.
- Version - Class in com.ngrok
-
Client version information
- volumeThreshold(long) - Method in class com.ngrok.definitions.EndpointCircuitBreaker.Builder
-
Integer number of requests in a rolling window that will trip the circuit.
- volumeThreshold(Optional<Long>) - Method in class com.ngrok.definitions.EndpointCircuitBreaker.Builder
-
Integer number of requests in a rolling window that will trip the circuit.
W
- webhookValidation() - Method in class com.ngrok.Ngrok.PointcfgModuleNamespace
-
Creates a service client for
EndpointWebhookValidationModule. - webhookValidation(EndpointWebhookValidation) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
webhook validation module configuration or
null - webhookValidation(EndpointWebhookValidation) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
webhook validation module configuration or
null - webhookValidation(Optional<EndpointWebhookValidation>) - Method in class com.ngrok.services.EndpointConfigurations.CreateCallBuilder
-
webhook validation module configuration or
null - webhookValidation(Optional<EndpointWebhookValidation>) - Method in class com.ngrok.services.EndpointConfigurations.UpdateCallBuilder
-
webhook validation module configuration or
null
All Classes|All Packages|Constant Field Values|Serialized Form