Package com.ngrok.services

Class EdgeRouteOAuthModule

java.lang.Object

com.ngrok.services.EdgeRouteOAuthModule

public class EdgeRouteOAuthModule
extends Object

An API client for EdgeRouteOAuthModule. See also https://ngrok.com/docs/api#api-edge-route-o-auth-module.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	EdgeRouteOAuthModule.DeleteCallBuilder	A builder object encapsulating state for an unsent Delete API call.
class	EdgeRouteOAuthModule.GetCallBuilder	A builder object encapsulating state for an unsent Get API call.
class	EdgeRouteOAuthModule.ReplaceCallBuilder	A builder object encapsulating state for an unsent Replace API call.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
EdgeRouteOAuthModule.DeleteCallBuilder	delete(String edgeId, String id)	Creates a call builder for the Delete API operation.
EdgeRouteOAuthModule.GetCallBuilder	get(String edgeId, String id)	Creates a call builder for the Get API operation.
EdgeRouteOAuthModule.ReplaceCallBuilder	replace(String edgeId, String id)	Creates a call builder for the Replace API operation.

Methods inherited from class java.lang.Object

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

Constructor Details

EdgeRouteOAuthModule

public EdgeRouteOAuthModule(NgrokApiClient apiClient)

Creates a new sub-client for EdgeRouteOAuthModule.

Parameters:

apiClient - an instance of NgrokApiClient

Method Details

replace

public EdgeRouteOAuthModule.ReplaceCallBuilder replace(String edgeId,
 String id)

Creates a call builder for the Replace API operation. See also https://ngrok.com/docs/api#api-edge-route-o-auth-module-replace.

Parameters:

edgeId - the value of the edge_id parameter as a String

id - the value of the id parameter as a String

Returns:

a call builder for this API call

get

public EdgeRouteOAuthModule.GetCallBuilder get(String edgeId,
 String id)

Creates a call builder for the Get API operation. See also https://ngrok.com/docs/api#api-edge-route-o-auth-module-get.

Parameters:

edgeId - unique identifier of this edge

id - unique identifier of this edge route

Returns:

a call builder for this API call

delete

public EdgeRouteOAuthModule.DeleteCallBuilder delete(String edgeId,
 String id)

Creates a call builder for the Delete API operation. See also https://ngrok.com/docs/api#api-edge-route-o-auth-module-delete.

Parameters:

edgeId - unique identifier of this edge

id - unique identifier of this edge route

Returns:

a call builder for this API call