Package com.ngrok.services

Class EdgesTcp

java.lang.Object

com.ngrok.services.EdgesTcp

public class EdgesTcp
extends Object

An API client for EdgesTcp. See also https://ngrok.com/docs/api#api-edges-tcp.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
EdgesTcp.CreateCallBuilder	create()	Create a TCP Edge See also https://ngrok.com/docs/api#api-edges-tcp-create.
EdgesTcp.DeleteCallBuilder	delete(String id)	Delete a TCP Edge by ID See also https://ngrok.com/docs/api#api-edges-tcp-delete.
EdgesTcp.GetCallBuilder	get(String id)	Get a TCP Edge by ID See also https://ngrok.com/docs/api#api-edges-tcp-get.
EdgesTcp.ListCallBuilder	list()	Returns a list of all TCP Edges on this account See also https://ngrok.com/docs/api#api-edges-tcp-list.
EdgesTcp.UpdateCallBuilder	update(String id)	Updates a TCP Edge by ID.

Methods inherited from class java.lang.Object

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

Constructor Details

EdgesTcp

public EdgesTcp(NgrokApiClient apiClient)

Creates a new sub-client for EdgesTcp.

Parameters:

apiClient - an instance of NgrokApiClient

Method Details

create

public EdgesTcp.CreateCallBuilder create()

Create a TCP Edge See also https://ngrok.com/docs/api#api-edges-tcp-create.

Returns:

a call builder for this API call

get

public EdgesTcp.GetCallBuilder get(String id)

Get a TCP Edge by ID See also https://ngrok.com/docs/api#api-edges-tcp-get.

Parameters:

id - a resource identifier

Returns:

a call builder for this API call

list

public EdgesTcp.ListCallBuilder list()

Returns a list of all TCP Edges on this account See also https://ngrok.com/docs/api#api-edges-tcp-list.

Returns:

a call builder for this API call

update

public EdgesTcp.UpdateCallBuilder update(String id)

Updates a TCP Edge by ID. 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-edges-tcp-update.

Parameters:

id - unique identifier of this edge

Returns:

a call builder for this API call

delete

public EdgesTcp.DeleteCallBuilder delete(String id)

Delete a TCP Edge by ID See also https://ngrok.com/docs/api#api-edges-tcp-delete.

Parameters:

id - a resource identifier

Returns:

a call builder for this API call