Package com.ngrok.services

Class EndpointConfigurations

java.lang.Object

com.ngrok.services.EndpointConfigurations

public class EndpointConfigurations
extends Object

Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled. Endpoint configurations are only applied to Domains and TCP Addresses they have been attached to. See also https://ngrok.com/docs/api#api-endpoint-configurations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	EndpointConfigurations.CreateCallBuilder	A builder object encapsulating state for an unsent Create API call.
class	EndpointConfigurations.DeleteCallBuilder	A builder object encapsulating state for an unsent Delete API call.
class	EndpointConfigurations.GetCallBuilder	A builder object encapsulating state for an unsent Get API call.
class	EndpointConfigurations.ListCallBuilder	A builder object encapsulating state for an unsent List API call.
class	EndpointConfigurations.UpdateCallBuilder	A builder object encapsulating state for an unsent Update API call.

Constructor Summary

Constructors

Constructor	Description
EndpointConfigurations(NgrokApiClient apiClient)	Creates a new sub-client for EndpointConfigurations.

Method Summary

Modifier and Type	Method	Description
EndpointConfigurations.CreateCallBuilder	create()	Create a new endpoint configuration See also https://ngrok.com/docs/api#api-endpoint-configurations-create.
EndpointConfigurations.DeleteCallBuilder	delete(String id)	Delete an endpoint configuration.
EndpointConfigurations.GetCallBuilder	get(String id)	Returns detailed information about an endpoint configuration See also https://ngrok.com/docs/api#api-endpoint-configurations-get.
EndpointConfigurations.ListCallBuilder	list()	Returns a list of all endpoint configurations on this account See also https://ngrok.com/docs/api#api-endpoint-configurations-list.
EndpointConfigurations.UpdateCallBuilder	update(String id)	Updates an endpoint configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EndpointConfigurations

public EndpointConfigurations(NgrokApiClient apiClient)

Creates a new sub-client for EndpointConfigurations.

Parameters:

apiClient - an instance of NgrokApiClient

Method Details

create

public EndpointConfigurations.CreateCallBuilder create()

Create a new endpoint configuration See also https://ngrok.com/docs/api#api-endpoint-configurations-create.

Returns:

a call builder for this API call

delete

public EndpointConfigurations.DeleteCallBuilder delete(String id)

Delete an endpoint configuration. This operation will fail if the endpoint configuration is still referenced by any reserved domain or reserved address. See also https://ngrok.com/docs/api#api-endpoint-configurations-delete.

Parameters:

id - a resource identifier

Returns:

a call builder for this API call

get

public EndpointConfigurations.GetCallBuilder get(String id)

Returns detailed information about an endpoint configuration See also https://ngrok.com/docs/api#api-endpoint-configurations-get.

Parameters:

id - a resource identifier

Returns:

a call builder for this API call

list

public EndpointConfigurations.ListCallBuilder list()

Returns a list of all endpoint configurations on this account See also https://ngrok.com/docs/api#api-endpoint-configurations-list.

Returns:

a call builder for this API call

update

public EndpointConfigurations.UpdateCallBuilder update(String id)

Updates an endpoint configuration. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API. See also https://ngrok.com/docs/api#api-endpoint-configurations-update.

Parameters:

id - unique identifier of this endpoint configuration

Returns:

a call builder for this API call