Package com.ngrok.services

Class EdgesHttps

java.lang.Object

com.ngrok.services.EdgesHttps

public class EdgesHttps
extends Object

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

EdgesHttps

public EdgesHttps(NgrokApiClient apiClient)

Creates a new sub-client for EdgesHttps.

Parameters:

apiClient - an instance of NgrokApiClient

Method Details

create

public EdgesHttps.CreateCallBuilder create()

Create an HTTPS Edge See also https://ngrok.com/docs/api#api-edges-https-create.

Returns:

a call builder for this API call

get

public EdgesHttps.GetCallBuilder get(String id)

Get an HTTPS Edge by ID See also https://ngrok.com/docs/api#api-edges-https-get.

Parameters:

id - a resource identifier

Returns:

a call builder for this API call

list

public EdgesHttps.ListCallBuilder list()

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

Returns:

a call builder for this API call

update

public EdgesHttps.UpdateCallBuilder update(String id)

Updates an HTTPS 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-https-update.

Parameters:

id - unique identifier of this edge

Returns:

a call builder for this API call

delete

public EdgesHttps.DeleteCallBuilder delete(String id)

Delete an HTTPS Edge by ID See also https://ngrok.com/docs/api#api-edges-https-delete.

Parameters:

id - a resource identifier

Returns:

a call builder for this API call