Package com.launchdarkly.api.api

Class UserSegmentsApi

java.lang.Object

com.launchdarkly.api.api.UserSegmentsApi

public class UserSegmentsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
UserSegmentsApi()
UserSegmentsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteUserSegment(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey)	Delete a user segment.
com.squareup.okhttp.Call	deleteUserSegmentAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey, ApiCallback<java.lang.Void> callback)	Delete a user segment.
com.squareup.okhttp.Call	deleteUserSegmentCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for deleteUserSegment
ApiResponse<java.lang.Void>	deleteUserSegmentWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey)	Delete a user segment.
ApiClient	getApiClient()
UserTargetingExpirationForSegment	getExpiringUserTargetsOnSegment(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey)	Get expiring user targets for user segment
com.squareup.okhttp.Call	getExpiringUserTargetsOnSegmentAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey, ApiCallback<UserTargetingExpirationForSegment> callback)	Get expiring user targets for user segment (asynchronously)
com.squareup.okhttp.Call	getExpiringUserTargetsOnSegmentCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getExpiringUserTargetsOnSegment
ApiResponse<UserTargetingExpirationForSegment>	getExpiringUserTargetsOnSegmentWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey)	Get expiring user targets for user segment
UserSegment	getUserSegment(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey)	Get a single user segment by key.
com.squareup.okhttp.Call	getUserSegmentAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey, ApiCallback<UserSegment> callback)	Get a single user segment by key.
com.squareup.okhttp.Call	getUserSegmentCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getUserSegment
UserSegments	getUserSegments(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String tag)	Get a list of all user segments in the given project.
com.squareup.okhttp.Call	getUserSegmentsAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String tag, ApiCallback<UserSegments> callback)	Get a list of all user segments in the given project.
com.squareup.okhttp.Call	getUserSegmentsCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String tag, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getUserSegments
ApiResponse<UserSegments>	getUserSegmentsWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String tag)	Get a list of all user segments in the given project.
ApiResponse<UserSegment>	getUserSegmentWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey)	Get a single user segment by key.
UserTargetingExpirationForSegment	patchExpiringUserTargetsOnSegment(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey, java.lang.Object semanticPatchWithComment)	Update, add, or delete expiring user targets on user segment
com.squareup.okhttp.Call	patchExpiringUserTargetsOnSegmentAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey, java.lang.Object semanticPatchWithComment, ApiCallback<UserTargetingExpirationForSegment> callback)	Update, add, or delete expiring user targets on user segment (asynchronously)
com.squareup.okhttp.Call	patchExpiringUserTargetsOnSegmentCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey, java.lang.Object semanticPatchWithComment, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for patchExpiringUserTargetsOnSegment
ApiResponse<UserTargetingExpirationForSegment>	patchExpiringUserTargetsOnSegmentWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey, java.lang.Object semanticPatchWithComment)	Update, add, or delete expiring user targets on user segment
UserSegment	patchUserSegment(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey, java.util.List<PatchOperation> patchOnly)	Perform a partial update to a user segment.
com.squareup.okhttp.Call	patchUserSegmentAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey, java.util.List<PatchOperation> patchOnly, ApiCallback<UserSegment> callback)	Perform a partial update to a user segment.
com.squareup.okhttp.Call	patchUserSegmentCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey, java.util.List<PatchOperation> patchOnly, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for patchUserSegment
ApiResponse<UserSegment>	patchUserSegmentWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey, java.util.List<PatchOperation> patchOnly)	Perform a partial update to a user segment.
UserSegment	postUserSegment(java.lang.String projectKey, java.lang.String environmentKey, UserSegmentBody userSegmentBody)	Creates a new user segment.
com.squareup.okhttp.Call	postUserSegmentAsync(java.lang.String projectKey, java.lang.String environmentKey, UserSegmentBody userSegmentBody, ApiCallback<UserSegment> callback)	Creates a new user segment.
com.squareup.okhttp.Call	postUserSegmentCall(java.lang.String projectKey, java.lang.String environmentKey, UserSegmentBody userSegmentBody, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for postUserSegment
ApiResponse<UserSegment>	postUserSegmentWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, UserSegmentBody userSegmentBody)	Creates a new user segment.
void	setApiClient(ApiClient apiClient)
void	updateBigSegmentTargets(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey, BigSegmentTargetsBody bigSegmentTargetsBody)	Update targets included or excluded in a big segment
com.squareup.okhttp.Call	updateBigSegmentTargetsAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey, BigSegmentTargetsBody bigSegmentTargetsBody, ApiCallback<java.lang.Void> callback)	Update targets included or excluded in a big segment (asynchronously)
com.squareup.okhttp.Call	updateBigSegmentTargetsCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey, BigSegmentTargetsBody bigSegmentTargetsBody, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for updateBigSegmentTargets
ApiResponse<java.lang.Void>	updateBigSegmentTargetsWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userSegmentKey, BigSegmentTargetsBody bigSegmentTargetsBody)	Update targets included or excluded in a big segment

Methods inherited from class java.lang.Object

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

Constructor Detail

UserSegmentsApi

public UserSegmentsApi()

UserSegmentsApi

public UserSegmentsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

deleteUserSegmentCall

public com.squareup.okhttp.Call deleteUserSegmentCall(java.lang.String projectKey,
                                                      java.lang.String environmentKey,
                                                      java.lang.String userSegmentKey,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException

Build call for deleteUserSegment

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteUserSegment

public void deleteUserSegment(java.lang.String projectKey,
                              java.lang.String environmentKey,
                              java.lang.String userSegmentKey)
                       throws ApiException

Delete a user segment.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (required)

Throws:

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

deleteUserSegmentWithHttpInfo

public ApiResponse<java.lang.Void> deleteUserSegmentWithHttpInfo(java.lang.String projectKey,
                                                                 java.lang.String environmentKey,
                                                                 java.lang.String userSegmentKey)
                                                          throws ApiException

Delete a user segment.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteUserSegmentAsync

public com.squareup.okhttp.Call deleteUserSegmentAsync(java.lang.String projectKey,
                                                       java.lang.String environmentKey,
                                                       java.lang.String userSegmentKey,
                                                       ApiCallback<java.lang.Void> callback)
                                                throws ApiException

Delete a user segment. (asynchronously)

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (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

getExpiringUserTargetsOnSegmentCall

public com.squareup.okhttp.Call getExpiringUserTargetsOnSegmentCall(java.lang.String projectKey,
                                                                    java.lang.String environmentKey,
                                                                    java.lang.String userSegmentKey,
                                                                    ProgressResponseBody.ProgressListener progressListener,
                                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                             throws ApiException

Build call for getExpiringUserTargetsOnSegment

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getExpiringUserTargetsOnSegment

public UserTargetingExpirationForSegment getExpiringUserTargetsOnSegment(java.lang.String projectKey,
                                                                         java.lang.String environmentKey,
                                                                         java.lang.String userSegmentKey)
                                                                  throws ApiException

Get expiring user targets for user segment

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (required)

Returns:

UserTargetingExpirationForSegment

Throws:

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

getExpiringUserTargetsOnSegmentWithHttpInfo

public ApiResponse<UserTargetingExpirationForSegment> getExpiringUserTargetsOnSegmentWithHttpInfo(java.lang.String projectKey,
                                                                                                  java.lang.String environmentKey,
                                                                                                  java.lang.String userSegmentKey)
                                                                                           throws ApiException

Get expiring user targets for user segment

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (required)

Returns:

ApiResponse<UserTargetingExpirationForSegment>

Throws:

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

getExpiringUserTargetsOnSegmentAsync

public com.squareup.okhttp.Call getExpiringUserTargetsOnSegmentAsync(java.lang.String projectKey,
                                                                     java.lang.String environmentKey,
                                                                     java.lang.String userSegmentKey,
                                                                     ApiCallback<UserTargetingExpirationForSegment> callback)
                                                              throws ApiException

Get expiring user targets for user segment (asynchronously)

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (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

getUserSegmentCall

public com.squareup.okhttp.Call getUserSegmentCall(java.lang.String projectKey,
                                                   java.lang.String environmentKey,
                                                   java.lang.String userSegmentKey,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for getUserSegment

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getUserSegment

public UserSegment getUserSegment(java.lang.String projectKey,
                                  java.lang.String environmentKey,
                                  java.lang.String userSegmentKey)
                           throws ApiException

Get a single user segment by key.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (required)

Returns:

UserSegment

Throws:

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

getUserSegmentWithHttpInfo

public ApiResponse<UserSegment> getUserSegmentWithHttpInfo(java.lang.String projectKey,
                                                           java.lang.String environmentKey,
                                                           java.lang.String userSegmentKey)
                                                    throws ApiException

Get a single user segment by key.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (required)

Returns:

ApiResponse<UserSegment>

Throws:

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

getUserSegmentAsync

public com.squareup.okhttp.Call getUserSegmentAsync(java.lang.String projectKey,
                                                    java.lang.String environmentKey,
                                                    java.lang.String userSegmentKey,
                                                    ApiCallback<UserSegment> callback)
                                             throws ApiException

Get a single user segment by key. (asynchronously)

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (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

getUserSegmentsCall

public com.squareup.okhttp.Call getUserSegmentsCall(java.lang.String projectKey,
                                                    java.lang.String environmentKey,
                                                    java.lang.String tag,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for getUserSegments

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

tag - Filter by tag. A tag can be used to group flags across projects. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getUserSegments

public UserSegments getUserSegments(java.lang.String projectKey,
                                    java.lang.String environmentKey,
                                    java.lang.String tag)
                             throws ApiException

Get a list of all user segments in the given project.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

tag - Filter by tag. A tag can be used to group flags across projects. (optional)

Returns:

UserSegments

Throws:

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

getUserSegmentsWithHttpInfo

public ApiResponse<UserSegments> getUserSegmentsWithHttpInfo(java.lang.String projectKey,
                                                             java.lang.String environmentKey,
                                                             java.lang.String tag)
                                                      throws ApiException

Get a list of all user segments in the given project.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

tag - Filter by tag. A tag can be used to group flags across projects. (optional)

Returns:

ApiResponse<UserSegments>

Throws:

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

getUserSegmentsAsync

public com.squareup.okhttp.Call getUserSegmentsAsync(java.lang.String projectKey,
                                                     java.lang.String environmentKey,
                                                     java.lang.String tag,
                                                     ApiCallback<UserSegments> callback)
                                              throws ApiException

Get a list of all user segments in the given project. (asynchronously)

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

tag - Filter by tag. A tag can be used to group flags across projects. (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

patchExpiringUserTargetsOnSegmentCall

public com.squareup.okhttp.Call patchExpiringUserTargetsOnSegmentCall(java.lang.String projectKey,
                                                                      java.lang.String environmentKey,
                                                                      java.lang.String userSegmentKey,
                                                                      java.lang.Object semanticPatchWithComment,
                                                                      ProgressResponseBody.ProgressListener progressListener,
                                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                               throws ApiException

Build call for patchExpiringUserTargetsOnSegment

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (required)

semanticPatchWithComment - Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

patchExpiringUserTargetsOnSegment

public UserTargetingExpirationForSegment patchExpiringUserTargetsOnSegment(java.lang.String projectKey,
                                                                           java.lang.String environmentKey,
                                                                           java.lang.String userSegmentKey,
                                                                           java.lang.Object semanticPatchWithComment)
                                                                    throws ApiException

Update, add, or delete expiring user targets on user segment

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (required)

semanticPatchWithComment - Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported. (required)

Returns:

UserTargetingExpirationForSegment

Throws:

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

patchExpiringUserTargetsOnSegmentWithHttpInfo

public ApiResponse<UserTargetingExpirationForSegment> patchExpiringUserTargetsOnSegmentWithHttpInfo(java.lang.String projectKey,
                                                                                                    java.lang.String environmentKey,
                                                                                                    java.lang.String userSegmentKey,
                                                                                                    java.lang.Object semanticPatchWithComment)
                                                                                             throws ApiException

Update, add, or delete expiring user targets on user segment

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (required)

semanticPatchWithComment - Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported. (required)

Returns:

ApiResponse<UserTargetingExpirationForSegment>

Throws:

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

patchExpiringUserTargetsOnSegmentAsync

public com.squareup.okhttp.Call patchExpiringUserTargetsOnSegmentAsync(java.lang.String projectKey,
                                                                       java.lang.String environmentKey,
                                                                       java.lang.String userSegmentKey,
                                                                       java.lang.Object semanticPatchWithComment,
                                                                       ApiCallback<UserTargetingExpirationForSegment> callback)
                                                                throws ApiException

Update, add, or delete expiring user targets on user segment (asynchronously)

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (required)

semanticPatchWithComment - Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported. (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

patchUserSegmentCall

public com.squareup.okhttp.Call patchUserSegmentCall(java.lang.String projectKey,
                                                     java.lang.String environmentKey,
                                                     java.lang.String userSegmentKey,
                                                     java.util.List<PatchOperation> patchOnly,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for patchUserSegment

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (required)

patchOnly - Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/' Feature flag patches also support JSON Merge Patch format. 'https://tools.ietf.org/html/rfc7386' The addition of comments is also supported. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

patchUserSegment

public UserSegment patchUserSegment(java.lang.String projectKey,
                                    java.lang.String environmentKey,
                                    java.lang.String userSegmentKey,
                                    java.util.List<PatchOperation> patchOnly)
                             throws ApiException

Perform a partial update to a user segment.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (required)

patchOnly - Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/' Feature flag patches also support JSON Merge Patch format. 'https://tools.ietf.org/html/rfc7386' The addition of comments is also supported. (required)

Returns:

UserSegment

Throws:

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

patchUserSegmentWithHttpInfo

public ApiResponse<UserSegment> patchUserSegmentWithHttpInfo(java.lang.String projectKey,
                                                             java.lang.String environmentKey,
                                                             java.lang.String userSegmentKey,
                                                             java.util.List<PatchOperation> patchOnly)
                                                      throws ApiException

Perform a partial update to a user segment.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (required)

patchOnly - Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/' Feature flag patches also support JSON Merge Patch format. 'https://tools.ietf.org/html/rfc7386' The addition of comments is also supported. (required)

Returns:

ApiResponse<UserSegment>

Throws:

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

patchUserSegmentAsync

public com.squareup.okhttp.Call patchUserSegmentAsync(java.lang.String projectKey,
                                                      java.lang.String environmentKey,
                                                      java.lang.String userSegmentKey,
                                                      java.util.List<PatchOperation> patchOnly,
                                                      ApiCallback<UserSegment> callback)
                                               throws ApiException

Perform a partial update to a user segment. (asynchronously)

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (required)

patchOnly - Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/' Feature flag patches also support JSON Merge Patch format. 'https://tools.ietf.org/html/rfc7386' The addition of comments is also supported. (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

postUserSegmentCall

public com.squareup.okhttp.Call postUserSegmentCall(java.lang.String projectKey,
                                                    java.lang.String environmentKey,
                                                    UserSegmentBody userSegmentBody,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for postUserSegment

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentBody - Create a new user segment. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

postUserSegment

public UserSegment postUserSegment(java.lang.String projectKey,
                                   java.lang.String environmentKey,
                                   UserSegmentBody userSegmentBody)
                            throws ApiException

Creates a new user segment.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentBody - Create a new user segment. (required)

Returns:

UserSegment

Throws:

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

postUserSegmentWithHttpInfo

public ApiResponse<UserSegment> postUserSegmentWithHttpInfo(java.lang.String projectKey,
                                                            java.lang.String environmentKey,
                                                            UserSegmentBody userSegmentBody)
                                                     throws ApiException

Creates a new user segment.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentBody - Create a new user segment. (required)

Returns:

ApiResponse<UserSegment>

Throws:

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

postUserSegmentAsync

public com.squareup.okhttp.Call postUserSegmentAsync(java.lang.String projectKey,
                                                     java.lang.String environmentKey,
                                                     UserSegmentBody userSegmentBody,
                                                     ApiCallback<UserSegment> callback)
                                              throws ApiException

Creates a new user segment. (asynchronously)

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentBody - Create a new user 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

updateBigSegmentTargetsCall

public com.squareup.okhttp.Call updateBigSegmentTargetsCall(java.lang.String projectKey,
                                                            java.lang.String environmentKey,
                                                            java.lang.String userSegmentKey,
                                                            BigSegmentTargetsBody bigSegmentTargetsBody,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for updateBigSegmentTargets

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (required)

bigSegmentTargetsBody - Add or remove user targets to the included or excluded lists on a big segment. Contact your account manager for early access to this feature. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateBigSegmentTargets

public void updateBigSegmentTargets(java.lang.String projectKey,
                                    java.lang.String environmentKey,
                                    java.lang.String userSegmentKey,
                                    BigSegmentTargetsBody bigSegmentTargetsBody)
                             throws ApiException

Update targets included or excluded in a big segment

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (required)

bigSegmentTargetsBody - Add or remove user targets to the included or excluded lists on a big segment. Contact your account manager for early access to this feature. (required)

Throws:

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

updateBigSegmentTargetsWithHttpInfo

public ApiResponse<java.lang.Void> updateBigSegmentTargetsWithHttpInfo(java.lang.String projectKey,
                                                                       java.lang.String environmentKey,
                                                                       java.lang.String userSegmentKey,
                                                                       BigSegmentTargetsBody bigSegmentTargetsBody)
                                                                throws ApiException

Update targets included or excluded in a big segment

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (required)

bigSegmentTargetsBody - Add or remove user targets to the included or excluded lists on a big segment. Contact your account manager for early access to this feature. (required)

Returns:

ApiResponse<Void>

Throws:

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

updateBigSegmentTargetsAsync

public com.squareup.okhttp.Call updateBigSegmentTargetsAsync(java.lang.String projectKey,
                                                             java.lang.String environmentKey,
                                                             java.lang.String userSegmentKey,
                                                             BigSegmentTargetsBody bigSegmentTargetsBody,
                                                             ApiCallback<java.lang.Void> callback)
                                                      throws ApiException

Update targets included or excluded in a big segment (asynchronously)

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userSegmentKey - The user segment's key. The key identifies the user segment in your code. (required)

bigSegmentTargetsBody - Add or remove user targets to the included or excluded lists on a big segment. Contact your account manager for early access to this feature. (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