org.wso2.carbon.apimgt.rest.integration.tests.publisher.api

Class EndpointCollectionApi

java.lang.Object

org.wso2.carbon.apimgt.rest.integration.tests.publisher.api.EndpointCollectionApi

public class EndpointCollectionApi
extends Object

Constructor Summary

Constructors

Constructor and Description
EndpointCollectionApi()
EndpointCollectionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
EndPointList	endpointsGet(String ifNoneMatch, String ifModifiedSince) Get all endpoints This operation can be used to retrieve the list of endpoints available.
com.squareup.okhttp.Call	endpointsGetAsync(String ifNoneMatch, String ifModifiedSince, ApiCallback<EndPointList> callback) Get all endpoints (asynchronously) This operation can be used to retrieve the list of endpoints available.
com.squareup.okhttp.Call	endpointsGetCall(String ifNoneMatch, String ifModifiedSince, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for endpointsGet
ApiResponse<EndPointList>	endpointsGetWithHttpInfo(String ifNoneMatch, String ifModifiedSince) Get all endpoints This operation can be used to retrieve the list of endpoints available.
void	endpointsHead(String name, String ifNoneMatch) Check given Endpoint is already exist Using this operation, you can check a given Endpoint name is already used.
com.squareup.okhttp.Call	endpointsHeadAsync(String name, String ifNoneMatch, ApiCallback<Void> callback) Check given Endpoint is already exist (asynchronously) Using this operation, you can check a given Endpoint name is already used.
com.squareup.okhttp.Call	endpointsHeadCall(String name, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for endpointsHead
ApiResponse<Void>	endpointsHeadWithHttpInfo(String name, String ifNoneMatch) Check given Endpoint is already exist Using this operation, you can check a given Endpoint name is already used.
EndPoint	endpointsPost(EndPoint body, String ifNoneMatch, String ifModifiedSince) Add a new endpoint This operation can be used to add a new endpoint.
com.squareup.okhttp.Call	endpointsPostAsync(EndPoint body, String ifNoneMatch, String ifModifiedSince, ApiCallback<EndPoint> callback) Add a new endpoint (asynchronously) This operation can be used to add a new endpoint.
com.squareup.okhttp.Call	endpointsPostCall(EndPoint body, String ifNoneMatch, String ifModifiedSince, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for endpointsPost
ApiResponse<EndPoint>	endpointsPostWithHttpInfo(EndPoint body, String ifNoneMatch, String ifModifiedSince) Add a new endpoint This operation can be used to add a new endpoint.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointCollectionApi

public EndpointCollectionApi()

EndpointCollectionApi

public EndpointCollectionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

endpointsGetCall

public com.squareup.okhttp.Call endpointsGetCall(String ifNoneMatch,
                                                 String ifModifiedSince,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException

Build call for endpointsGet

Parameters:

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

endpointsGet

public EndPointList endpointsGet(String ifNoneMatch,
                                 String ifModifiedSince)
                          throws ApiException

Get all endpoints This operation can be used to retrieve the list of endpoints available.

Parameters:

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource. (optional)

Returns:

EndPointList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

endpointsGetWithHttpInfo

public ApiResponse<EndPointList> endpointsGetWithHttpInfo(String ifNoneMatch,
                                                          String ifModifiedSince)
                                                   throws ApiException

Get all endpoints This operation can be used to retrieve the list of endpoints available.

Parameters:

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource. (optional)

Returns:

ApiResponse<EndPointList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

endpointsGetAsync

public com.squareup.okhttp.Call endpointsGetAsync(String ifNoneMatch,
                                                  String ifModifiedSince,
                                                  ApiCallback<EndPointList> callback)
                                           throws ApiException

Get all endpoints (asynchronously) This operation can be used to retrieve the list of endpoints available.

Parameters:

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource. (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

endpointsHeadCall

public com.squareup.okhttp.Call endpointsHeadCall(String name,
                                                  String ifNoneMatch,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for endpointsHead

Parameters:

name - (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

endpointsHead

public void endpointsHead(String name,
                          String ifNoneMatch)
                   throws ApiException

Check given Endpoint is already exist Using this operation, you can check a given Endpoint name is already used. You need to provide the name you want to check.

Parameters:

name - (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

endpointsHeadWithHttpInfo

public ApiResponse<Void> endpointsHeadWithHttpInfo(String name,
                                                   String ifNoneMatch)
                                            throws ApiException

Check given Endpoint is already exist Using this operation, you can check a given Endpoint name is already used. You need to provide the name you want to check.

Parameters:

name - (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

endpointsHeadAsync

public com.squareup.okhttp.Call endpointsHeadAsync(String name,
                                                   String ifNoneMatch,
                                                   ApiCallback<Void> callback)
                                            throws ApiException

Check given Endpoint is already exist (asynchronously) Using this operation, you can check a given Endpoint name is already used. You need to provide the name you want to check.

Parameters:

name - (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

endpointsPostCall

public com.squareup.okhttp.Call endpointsPostCall(EndPoint body,
                                                  String ifNoneMatch,
                                                  String ifModifiedSince,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for endpointsPost

Parameters:

body - EndPoint object that needs to be added (required)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

endpointsPost

public EndPoint endpointsPost(EndPoint body,
                              String ifNoneMatch,
                              String ifModifiedSince)
                       throws ApiException

Add a new endpoint This operation can be used to add a new endpoint.

Parameters:

body - EndPoint object that needs to be added (required)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource. (optional)

Returns:

EndPoint

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

endpointsPostWithHttpInfo

public ApiResponse<EndPoint> endpointsPostWithHttpInfo(EndPoint body,
                                                       String ifNoneMatch,
                                                       String ifModifiedSince)
                                                throws ApiException

Add a new endpoint This operation can be used to add a new endpoint.

Parameters:

body - EndPoint object that needs to be added (required)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource. (optional)

Returns:

ApiResponse<EndPoint>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

endpointsPostAsync

public com.squareup.okhttp.Call endpointsPostAsync(EndPoint body,
                                                   String ifNoneMatch,
                                                   String ifModifiedSince,
                                                   ApiCallback<EndPoint> callback)
                                            throws ApiException

Add a new endpoint (asynchronously) This operation can be used to add a new endpoint.

Parameters:

body - EndPoint object that needs to be added (required)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource. (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object