Package com.configcat.publicapi.java.client.api

Class SegmentsApi

java.lang.Object

com.configcat.publicapi.java.client.api.SegmentsApi

public class SegmentsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
SegmentsApi()
SegmentsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
SegmentModel	createSegment(java.util.UUID productId, CreateSegmentModel createSegmentModel)	Create Segment This endpoint creates a new Segment in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
okhttp3.Call	createSegmentAsync(java.util.UUID productId, CreateSegmentModel createSegmentModel, ApiCallback<SegmentModel> _callback)	Create Segment (asynchronously) This endpoint creates a new Segment in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
okhttp3.Call	createSegmentCall(java.util.UUID productId, CreateSegmentModel createSegmentModel, ApiCallback _callback)	Build call for createSegment
ApiResponse<SegmentModel>	createSegmentWithHttpInfo(java.util.UUID productId, CreateSegmentModel createSegmentModel)	Create Segment This endpoint creates a new Segment in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
void	deleteSegment(java.util.UUID segmentId)	Delete Segment This endpoint removes a Segment identified by the `segmentId` parameter.
okhttp3.Call	deleteSegmentAsync(java.util.UUID segmentId, ApiCallback<java.lang.Void> _callback)	Delete Segment (asynchronously) This endpoint removes a Segment identified by the `segmentId` parameter.
okhttp3.Call	deleteSegmentCall(java.util.UUID segmentId, ApiCallback _callback)	Build call for deleteSegment
ApiResponse<java.lang.Void>	deleteSegmentWithHttpInfo(java.util.UUID segmentId)	Delete Segment This endpoint removes a Segment identified by the `segmentId` parameter.
ApiClient	getApiClient()
java.lang.String	getCustomBaseUrl()
int	getHostIndex()
SegmentModel	getSegment(java.util.UUID segmentId)	Get Segment This endpoint returns the metadata of a Segment identified by the `segmentId`.
okhttp3.Call	getSegmentAsync(java.util.UUID segmentId, ApiCallback<SegmentModel> _callback)	Get Segment (asynchronously) This endpoint returns the metadata of a Segment identified by the `segmentId`.
okhttp3.Call	getSegmentCall(java.util.UUID segmentId, ApiCallback _callback)	Build call for getSegment
java.util.List<SegmentListModel>	getSegments(java.util.UUID productId)	List Segments This endpoint returns the list of the Segments that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
okhttp3.Call	getSegmentsAsync(java.util.UUID productId, ApiCallback<java.util.List<SegmentListModel>> _callback)	List Segments (asynchronously) This endpoint returns the list of the Segments that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
okhttp3.Call	getSegmentsCall(java.util.UUID productId, ApiCallback _callback)	Build call for getSegments
ApiResponse<java.util.List<SegmentListModel>>	getSegmentsWithHttpInfo(java.util.UUID productId)	List Segments This endpoint returns the list of the Segments that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
ApiResponse<SegmentModel>	getSegmentWithHttpInfo(java.util.UUID segmentId)	Get Segment This endpoint returns the metadata of a Segment identified by the `segmentId`.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(java.lang.String customBaseUrl)
void	setHostIndex(int hostIndex)
SegmentModel	updateSegment(java.util.UUID segmentId, UpdateSegmentModel updateSegmentModel)	Update Segment This endpoint updates a Segment identified by the `segmentId` parameter.
okhttp3.Call	updateSegmentAsync(java.util.UUID segmentId, UpdateSegmentModel updateSegmentModel, ApiCallback<SegmentModel> _callback)	Update Segment (asynchronously) This endpoint updates a Segment identified by the `segmentId` parameter.
okhttp3.Call	updateSegmentCall(java.util.UUID segmentId, UpdateSegmentModel updateSegmentModel, ApiCallback _callback)	Build call for updateSegment
ApiResponse<SegmentModel>	updateSegmentWithHttpInfo(java.util.UUID segmentId, UpdateSegmentModel updateSegmentModel)	Update Segment This endpoint updates a Segment identified by the `segmentId` parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

SegmentsApi

public SegmentsApi()

SegmentsApi

public SegmentsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public java.lang.String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(java.lang.String customBaseUrl)

createSegmentCall

public okhttp3.Call createSegmentCall(java.util.UUID productId,
                                      CreateSegmentModel createSegmentModel,
                                      ApiCallback _callback)
                               throws ApiException

Build call for createSegment

Parameters:

productId - The identifier of the Product. (required)

createSegmentModel - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
201	When the creation was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

createSegment

public SegmentModel createSegment(java.util.UUID productId,
                                  CreateSegmentModel createSegmentModel)
                           throws ApiException

Create Segment This endpoint creates a new Segment in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

Parameters:

productId - The identifier of the Product. (required)

createSegmentModel - (required)

Returns:

SegmentModel

Throws:

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

Http Response Details

Status Code	Description	Response Headers
201	When the creation was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

createSegmentWithHttpInfo

public ApiResponse<SegmentModel> createSegmentWithHttpInfo(java.util.UUID productId,
                                                           CreateSegmentModel createSegmentModel)
                                                    throws ApiException

Create Segment This endpoint creates a new Segment in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

Parameters:

productId - The identifier of the Product. (required)

createSegmentModel - (required)

Returns:

ApiResponse<SegmentModel>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
201	When the creation was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

createSegmentAsync

public okhttp3.Call createSegmentAsync(java.util.UUID productId,
                                       CreateSegmentModel createSegmentModel,
                                       ApiCallback<SegmentModel> _callback)
                                throws ApiException

Create Segment (asynchronously) This endpoint creates a new Segment in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

Parameters:

productId - The identifier of the Product. (required)

createSegmentModel - (required)

_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

Http Response Details

Status Code	Description	Response Headers
201	When the creation was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteSegmentCall

public okhttp3.Call deleteSegmentCall(java.util.UUID segmentId,
                                      ApiCallback _callback)
                               throws ApiException

Build call for deleteSegment

Parameters:

segmentId - The identifier of the Segment. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteSegment

public void deleteSegment(java.util.UUID segmentId)
                   throws ApiException

Delete Segment This endpoint removes a Segment identified by the `segmentId` parameter.

Parameters:

segmentId - The identifier of the Segment. (required)

Throws:

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

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteSegmentWithHttpInfo

public ApiResponse<java.lang.Void> deleteSegmentWithHttpInfo(java.util.UUID segmentId)
                                                      throws ApiException

Delete Segment This endpoint removes a Segment identified by the `segmentId` parameter.

Parameters:

segmentId - The identifier of the Segment. (required)

Returns:

ApiResponse<Void>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteSegmentAsync

public okhttp3.Call deleteSegmentAsync(java.util.UUID segmentId,
                                       ApiCallback<java.lang.Void> _callback)
                                throws ApiException

Delete Segment (asynchronously) This endpoint removes a Segment identified by the `segmentId` parameter.

Parameters:

segmentId - The identifier of the Segment. (required)

_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

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getSegmentCall

public okhttp3.Call getSegmentCall(java.util.UUID segmentId,
                                   ApiCallback _callback)
                            throws ApiException

Build call for getSegment

Parameters:

segmentId - The identifier of the Segment. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	When everything is ok, the config data returned.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getSegment

public SegmentModel getSegment(java.util.UUID segmentId)
                        throws ApiException

Get Segment This endpoint returns the metadata of a Segment identified by the `segmentId`.

Parameters:

segmentId - The identifier of the Segment. (required)

Returns:

SegmentModel

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	When everything is ok, the config data returned.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getSegmentWithHttpInfo

public ApiResponse<SegmentModel> getSegmentWithHttpInfo(java.util.UUID segmentId)
                                                 throws ApiException

Get Segment This endpoint returns the metadata of a Segment identified by the `segmentId`.

Parameters:

segmentId - The identifier of the Segment. (required)

Returns:

ApiResponse<SegmentModel>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	When everything is ok, the config data returned.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getSegmentAsync

public okhttp3.Call getSegmentAsync(java.util.UUID segmentId,
                                    ApiCallback<SegmentModel> _callback)
                             throws ApiException

Get Segment (asynchronously) This endpoint returns the metadata of a Segment identified by the `segmentId`.

Parameters:

segmentId - The identifier of the Segment. (required)

_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

Http Response Details

Status Code	Description	Response Headers
200	When everything is ok, the config data returned.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getSegmentsCall

public okhttp3.Call getSegmentsCall(java.util.UUID productId,
                                    ApiCallback _callback)
                             throws ApiException

Build call for getSegments

Parameters:

productId - The identifier of the Product. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getSegments

public java.util.List<SegmentListModel> getSegments(java.util.UUID productId)
                                             throws ApiException

List Segments This endpoint returns the list of the Segments that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

Parameters:

productId - The identifier of the Product. (required)

Returns:

List<SegmentListModel>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getSegmentsWithHttpInfo

public ApiResponse<java.util.List<SegmentListModel>> getSegmentsWithHttpInfo(java.util.UUID productId)
                                                                      throws ApiException

List Segments This endpoint returns the list of the Segments that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

Parameters:

productId - The identifier of the Product. (required)

Returns:

ApiResponse<List<SegmentListModel>>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getSegmentsAsync

public okhttp3.Call getSegmentsAsync(java.util.UUID productId,
                                     ApiCallback<java.util.List<SegmentListModel>> _callback)
                              throws ApiException

List Segments (asynchronously) This endpoint returns the list of the Segments that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

Parameters:

productId - The identifier of the Product. (required)

_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

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updateSegmentCall

public okhttp3.Call updateSegmentCall(java.util.UUID segmentId,
                                      UpdateSegmentModel updateSegmentModel,
                                      ApiCallback _callback)
                               throws ApiException

Build call for updateSegment

Parameters:

segmentId - The identifier of the Segment. (required)

updateSegmentModel - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updateSegment

public SegmentModel updateSegment(java.util.UUID segmentId,
                                  UpdateSegmentModel updateSegmentModel)
                           throws ApiException

Update Segment This endpoint updates a Segment identified by the `segmentId` parameter.

Parameters:

segmentId - The identifier of the Segment. (required)

updateSegmentModel - (required)

Returns:

SegmentModel

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updateSegmentWithHttpInfo

public ApiResponse<SegmentModel> updateSegmentWithHttpInfo(java.util.UUID segmentId,
                                                           UpdateSegmentModel updateSegmentModel)
                                                    throws ApiException

Update Segment This endpoint updates a Segment identified by the `segmentId` parameter.

Parameters:

segmentId - The identifier of the Segment. (required)

updateSegmentModel - (required)

Returns:

ApiResponse<SegmentModel>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updateSegmentAsync

public okhttp3.Call updateSegmentAsync(java.util.UUID segmentId,
                                       UpdateSegmentModel updateSegmentModel,
                                       ApiCallback<SegmentModel> _callback)
                                throws ApiException

Update Segment (asynchronously) This endpoint updates a Segment identified by the `segmentId` parameter.

Parameters:

segmentId - The identifier of the Segment. (required)

updateSegmentModel - (required)

_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

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-