Package com.launchdarkly.api.api

Class ContextsApi

java.lang.Object

com.launchdarkly.api.api.ContextsApi

public class ContextsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
ContextsApi()
ContextsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteContextInstances(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String id)	Delete context instances Delete context instances by ID.
okhttp3.Call	deleteContextInstancesAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String id, ApiCallback<java.lang.Void> _callback)	Delete context instances (asynchronously) Delete context instances by ID.
okhttp3.Call	deleteContextInstancesCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String id, ApiCallback _callback)	Build call for deleteContextInstances
ApiResponse<java.lang.Void>	deleteContextInstancesWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String id)	Delete context instances Delete context instances by ID.
ContextInstanceEvaluations	evaluateContextInstance(java.lang.String projectKey, java.lang.String environmentKey, java.util.Map<java.lang.String,java.lang.Object> requestBody, java.lang.Long limit, java.lang.Long offset, java.lang.String sort, java.lang.String filter)	Evaluate flags for context instance Evaluate flags for a context instance, for example, to determine the expected flag variation.
okhttp3.Call	evaluateContextInstanceAsync(java.lang.String projectKey, java.lang.String environmentKey, java.util.Map<java.lang.String,java.lang.Object> requestBody, java.lang.Long limit, java.lang.Long offset, java.lang.String sort, java.lang.String filter, ApiCallback<ContextInstanceEvaluations> _callback)	Evaluate flags for context instance (asynchronously) Evaluate flags for a context instance, for example, to determine the expected flag variation.
okhttp3.Call	evaluateContextInstanceCall(java.lang.String projectKey, java.lang.String environmentKey, java.util.Map<java.lang.String,java.lang.Object> requestBody, java.lang.Long limit, java.lang.Long offset, java.lang.String sort, java.lang.String filter, ApiCallback _callback)	Build call for evaluateContextInstance
ApiResponse<ContextInstanceEvaluations>	evaluateContextInstanceWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.util.Map<java.lang.String,java.lang.Object> requestBody, java.lang.Long limit, java.lang.Long offset, java.lang.String sort, java.lang.String filter)	Evaluate flags for context instance Evaluate flags for a context instance, for example, to determine the expected flag variation.
ApiClient	getApiClient()
ContextAttributeNamesCollection	getContextAttributeNames(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String filter)	Get context attribute names Get context attribute names.
okhttp3.Call	getContextAttributeNamesAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String filter, ApiCallback<ContextAttributeNamesCollection> _callback)	Get context attribute names (asynchronously) Get context attribute names.
okhttp3.Call	getContextAttributeNamesCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String filter, ApiCallback _callback)	Build call for getContextAttributeNames
ApiResponse<ContextAttributeNamesCollection>	getContextAttributeNamesWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String filter)	Get context attribute names Get context attribute names.
ContextAttributeValuesCollection	getContextAttributeValues(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String attributeName, java.lang.String filter)	Get context attribute values Get context attribute values.
okhttp3.Call	getContextAttributeValuesAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String attributeName, java.lang.String filter, ApiCallback<ContextAttributeValuesCollection> _callback)	Get context attribute values (asynchronously) Get context attribute values.
okhttp3.Call	getContextAttributeValuesCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String attributeName, java.lang.String filter, ApiCallback _callback)	Build call for getContextAttributeValues
ApiResponse<ContextAttributeValuesCollection>	getContextAttributeValuesWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String attributeName, java.lang.String filter)	Get context attribute values Get context attribute values.
ContextInstances	getContextInstances(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String id, java.lang.Long limit, java.lang.String continuationToken, java.lang.String sort, java.lang.String filter, java.lang.Boolean includeTotalCount)	Get context instances Get context instances by ID.
okhttp3.Call	getContextInstancesAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String id, java.lang.Long limit, java.lang.String continuationToken, java.lang.String sort, java.lang.String filter, java.lang.Boolean includeTotalCount, ApiCallback<ContextInstances> _callback)	Get context instances (asynchronously) Get context instances by ID.
okhttp3.Call	getContextInstancesCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String id, java.lang.Long limit, java.lang.String continuationToken, java.lang.String sort, java.lang.String filter, java.lang.Boolean includeTotalCount, ApiCallback _callback)	Build call for getContextInstances
ApiResponse<ContextInstances>	getContextInstancesWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String id, java.lang.Long limit, java.lang.String continuationToken, java.lang.String sort, java.lang.String filter, java.lang.Boolean includeTotalCount)	Get context instances Get context instances by ID.
ContextKindsCollectionRep	getContextKindsByProjectKey(java.lang.String projectKey)	Get context kinds Get all context kinds for a given project.
okhttp3.Call	getContextKindsByProjectKeyAsync(java.lang.String projectKey, ApiCallback<ContextKindsCollectionRep> _callback)	Get context kinds (asynchronously) Get all context kinds for a given project.
okhttp3.Call	getContextKindsByProjectKeyCall(java.lang.String projectKey, ApiCallback _callback)	Build call for getContextKindsByProjectKey
ApiResponse<ContextKindsCollectionRep>	getContextKindsByProjectKeyWithHttpInfo(java.lang.String projectKey)	Get context kinds Get all context kinds for a given project.
Contexts	getContexts(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String kind, java.lang.String key, java.lang.Long limit, java.lang.String continuationToken, java.lang.String sort, java.lang.String filter, java.lang.Boolean includeTotalCount)	Get contexts Get contexts based on kind and key.
okhttp3.Call	getContextsAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String kind, java.lang.String key, java.lang.Long limit, java.lang.String continuationToken, java.lang.String sort, java.lang.String filter, java.lang.Boolean includeTotalCount, ApiCallback<Contexts> _callback)	Get contexts (asynchronously) Get contexts based on kind and key.
okhttp3.Call	getContextsCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String kind, java.lang.String key, java.lang.Long limit, java.lang.String continuationToken, java.lang.String sort, java.lang.String filter, java.lang.Boolean includeTotalCount, ApiCallback _callback)	Build call for getContexts
ApiResponse<Contexts>	getContextsWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String kind, java.lang.String key, java.lang.Long limit, java.lang.String continuationToken, java.lang.String sort, java.lang.String filter, java.lang.Boolean includeTotalCount)	Get contexts Get contexts based on kind and key.
java.lang.String	getCustomBaseUrl()
int	getHostIndex()
UpsertResponseRep	putContextKind(java.lang.String projectKey, java.lang.String key, UpsertContextKindPayload upsertContextKindPayload)	Create or update context kind Create or update a context kind by key.
okhttp3.Call	putContextKindAsync(java.lang.String projectKey, java.lang.String key, UpsertContextKindPayload upsertContextKindPayload, ApiCallback<UpsertResponseRep> _callback)	Create or update context kind (asynchronously) Create or update a context kind by key.
okhttp3.Call	putContextKindCall(java.lang.String projectKey, java.lang.String key, UpsertContextKindPayload upsertContextKindPayload, ApiCallback _callback)	Build call for putContextKind
ApiResponse<UpsertResponseRep>	putContextKindWithHttpInfo(java.lang.String projectKey, java.lang.String key, UpsertContextKindPayload upsertContextKindPayload)	Create or update context kind Create or update a context kind by key.
ContextInstances	searchContextInstances(java.lang.String projectKey, java.lang.String environmentKey, ContextInstanceSearch contextInstanceSearch, java.lang.Long limit, java.lang.String continuationToken, java.lang.String sort, java.lang.String filter, java.lang.Boolean includeTotalCount)	Search for context instances Search for context instances.
okhttp3.Call	searchContextInstancesAsync(java.lang.String projectKey, java.lang.String environmentKey, ContextInstanceSearch contextInstanceSearch, java.lang.Long limit, java.lang.String continuationToken, java.lang.String sort, java.lang.String filter, java.lang.Boolean includeTotalCount, ApiCallback<ContextInstances> _callback)	Search for context instances (asynchronously) Search for context instances.
okhttp3.Call	searchContextInstancesCall(java.lang.String projectKey, java.lang.String environmentKey, ContextInstanceSearch contextInstanceSearch, java.lang.Long limit, java.lang.String continuationToken, java.lang.String sort, java.lang.String filter, java.lang.Boolean includeTotalCount, ApiCallback _callback)	Build call for searchContextInstances
ApiResponse<ContextInstances>	searchContextInstancesWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, ContextInstanceSearch contextInstanceSearch, java.lang.Long limit, java.lang.String continuationToken, java.lang.String sort, java.lang.String filter, java.lang.Boolean includeTotalCount)	Search for context instances Search for context instances.
Contexts	searchContexts(java.lang.String projectKey, java.lang.String environmentKey, ContextSearch contextSearch, java.lang.Long limit, java.lang.String continuationToken, java.lang.String sort, java.lang.String filter, java.lang.Boolean includeTotalCount)	Search for contexts Search for contexts.
okhttp3.Call	searchContextsAsync(java.lang.String projectKey, java.lang.String environmentKey, ContextSearch contextSearch, java.lang.Long limit, java.lang.String continuationToken, java.lang.String sort, java.lang.String filter, java.lang.Boolean includeTotalCount, ApiCallback<Contexts> _callback)	Search for contexts (asynchronously) Search for contexts.
okhttp3.Call	searchContextsCall(java.lang.String projectKey, java.lang.String environmentKey, ContextSearch contextSearch, java.lang.Long limit, java.lang.String continuationToken, java.lang.String sort, java.lang.String filter, java.lang.Boolean includeTotalCount, ApiCallback _callback)	Build call for searchContexts
ApiResponse<Contexts>	searchContextsWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, ContextSearch contextSearch, java.lang.Long limit, java.lang.String continuationToken, java.lang.String sort, java.lang.String filter, java.lang.Boolean includeTotalCount)	Search for contexts Search for contexts.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(java.lang.String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextsApi

public ContextsApi()

ContextsApi

public ContextsApi(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)

deleteContextInstancesCall

public okhttp3.Call deleteContextInstancesCall(java.lang.String projectKey,
                                               java.lang.String environmentKey,
                                               java.lang.String id,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for deleteContextInstances

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

id - The context instance ID (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteContextInstances

public void deleteContextInstances(java.lang.String projectKey,
                                   java.lang.String environmentKey,
                                   java.lang.String id)
                            throws ApiException

Delete context instances Delete context instances by ID.

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

id - The context instance ID (required)

Throws:

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

deleteContextInstancesWithHttpInfo

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

Delete context instances Delete context instances by ID.

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

id - The context instance ID (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteContextInstancesAsync

public okhttp3.Call deleteContextInstancesAsync(java.lang.String projectKey,
                                                java.lang.String environmentKey,
                                                java.lang.String id,
                                                ApiCallback<java.lang.Void> _callback)
                                         throws ApiException

Delete context instances (asynchronously) Delete context instances by ID.

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

id - The context instance ID (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

evaluateContextInstanceCall

public okhttp3.Call evaluateContextInstanceCall(java.lang.String projectKey,
                                                java.lang.String environmentKey,
                                                java.util.Map<java.lang.String,java.lang.Object> requestBody,
                                                java.lang.Long limit,
                                                java.lang.Long offset,
                                                java.lang.String sort,
                                                java.lang.String filter,
                                                ApiCallback _callback)
                                         throws ApiException

Build call for evaluateContextInstance

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

requestBody - (required)

limit - The number of feature flags to return. Defaults to -1, which returns all flags (optional)

offset - Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)

sort - A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order (optional)

filter - A comma-separated list of filters. Each filter is of the form `field operator value`. Supported fields are explained above. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

evaluateContextInstance

public ContextInstanceEvaluations evaluateContextInstance(java.lang.String projectKey,
                                                          java.lang.String environmentKey,
                                                          java.util.Map<java.lang.String,java.lang.Object> requestBody,
                                                          java.lang.Long limit,
                                                          java.lang.Long offset,
                                                          java.lang.String sort,
                                                          java.lang.String filter)
                                                   throws ApiException

Evaluate flags for context instance Evaluate flags for a context instance, for example, to determine the expected flag variation. **Do not use this API instead of an SDK.** The LaunchDarkly SDKs are specialized for the tasks of evaluating feature flags in your application at scale and generating analytics events based on those evaluations. This API is not designed for that use case. Any evaluations you perform with this API will not be reflected in features such as flag statuses and flag insights. Context instances evaluated by this API will not appear in the Contexts list. To learn more, read [Comparing LaunchDarkly's SDKs and REST API](https://docs.launchdarkly.com/guide/api/comparing-sdk-rest-api). ### Filtering LaunchDarkly supports the `filter` query param for filtering, with the following fields: - `query` filters for a string that matches against the flags' keys and names. It is not case sensitive. For example: `filter=query equals dark-mode`. - `tags` filters the list to flags that have all of the tags in the list. For example: `filter=tags contains [\"beta\",\"q1\"]`. You can also apply multiple filters at once. For example, setting `filter=query equals dark-mode, tags contains [\"beta\",\"q1\"]` matches flags which match the key or name `dark-mode` and are tagged `beta` and `q1`.

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

requestBody - (required)

limit - The number of feature flags to return. Defaults to -1, which returns all flags (optional)

offset - Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)

sort - A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order (optional)

filter - A comma-separated list of filters. Each filter is of the form `field operator value`. Supported fields are explained above. (optional)

Returns:

ContextInstanceEvaluations

Throws:

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

evaluateContextInstanceWithHttpInfo

public ApiResponse<ContextInstanceEvaluations> evaluateContextInstanceWithHttpInfo(java.lang.String projectKey,
                                                                                   java.lang.String environmentKey,
                                                                                   java.util.Map<java.lang.String,java.lang.Object> requestBody,
                                                                                   java.lang.Long limit,
                                                                                   java.lang.Long offset,
                                                                                   java.lang.String sort,
                                                                                   java.lang.String filter)
                                                                            throws ApiException

Evaluate flags for context instance Evaluate flags for a context instance, for example, to determine the expected flag variation. **Do not use this API instead of an SDK.** The LaunchDarkly SDKs are specialized for the tasks of evaluating feature flags in your application at scale and generating analytics events based on those evaluations. This API is not designed for that use case. Any evaluations you perform with this API will not be reflected in features such as flag statuses and flag insights. Context instances evaluated by this API will not appear in the Contexts list. To learn more, read [Comparing LaunchDarkly's SDKs and REST API](https://docs.launchdarkly.com/guide/api/comparing-sdk-rest-api). ### Filtering LaunchDarkly supports the `filter` query param for filtering, with the following fields: - `query` filters for a string that matches against the flags' keys and names. It is not case sensitive. For example: `filter=query equals dark-mode`. - `tags` filters the list to flags that have all of the tags in the list. For example: `filter=tags contains [\"beta\",\"q1\"]`. You can also apply multiple filters at once. For example, setting `filter=query equals dark-mode, tags contains [\"beta\",\"q1\"]` matches flags which match the key or name `dark-mode` and are tagged `beta` and `q1`.

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

requestBody - (required)

limit - The number of feature flags to return. Defaults to -1, which returns all flags (optional)

offset - Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)

sort - A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order (optional)

filter - A comma-separated list of filters. Each filter is of the form `field operator value`. Supported fields are explained above. (optional)

Returns:

ApiResponse<ContextInstanceEvaluations>

Throws:

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

evaluateContextInstanceAsync

public okhttp3.Call evaluateContextInstanceAsync(java.lang.String projectKey,
                                                 java.lang.String environmentKey,
                                                 java.util.Map<java.lang.String,java.lang.Object> requestBody,
                                                 java.lang.Long limit,
                                                 java.lang.Long offset,
                                                 java.lang.String sort,
                                                 java.lang.String filter,
                                                 ApiCallback<ContextInstanceEvaluations> _callback)
                                          throws ApiException

Evaluate flags for context instance (asynchronously) Evaluate flags for a context instance, for example, to determine the expected flag variation. **Do not use this API instead of an SDK.** The LaunchDarkly SDKs are specialized for the tasks of evaluating feature flags in your application at scale and generating analytics events based on those evaluations. This API is not designed for that use case. Any evaluations you perform with this API will not be reflected in features such as flag statuses and flag insights. Context instances evaluated by this API will not appear in the Contexts list. To learn more, read [Comparing LaunchDarkly's SDKs and REST API](https://docs.launchdarkly.com/guide/api/comparing-sdk-rest-api). ### Filtering LaunchDarkly supports the `filter` query param for filtering, with the following fields: - `query` filters for a string that matches against the flags' keys and names. It is not case sensitive. For example: `filter=query equals dark-mode`. - `tags` filters the list to flags that have all of the tags in the list. For example: `filter=tags contains [\"beta\",\"q1\"]`. You can also apply multiple filters at once. For example, setting `filter=query equals dark-mode, tags contains [\"beta\",\"q1\"]` matches flags which match the key or name `dark-mode` and are tagged `beta` and `q1`.

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

requestBody - (required)

limit - The number of feature flags to return. Defaults to -1, which returns all flags (optional)

offset - Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)

sort - A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order (optional)

filter - A comma-separated list of filters. Each filter is of the form `field operator value`. Supported fields are explained above. (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

getContextAttributeNamesCall

public okhttp3.Call getContextAttributeNamesCall(java.lang.String projectKey,
                                                 java.lang.String environmentKey,
                                                 java.lang.String filter,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for getContextAttributeNames

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

filter - A comma-separated list of context filters. This endpoint only accepts `kind` filters, with the `equals` operator, and `name` filters, with the `startsWith` operator. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getContextAttributeNames

public ContextAttributeNamesCollection getContextAttributeNames(java.lang.String projectKey,
                                                                java.lang.String environmentKey,
                                                                java.lang.String filter)
                                                         throws ApiException

Get context attribute names Get context attribute names.

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

filter - A comma-separated list of context filters. This endpoint only accepts `kind` filters, with the `equals` operator, and `name` filters, with the `startsWith` operator. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

Returns:

ContextAttributeNamesCollection

Throws:

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

getContextAttributeNamesWithHttpInfo

public ApiResponse<ContextAttributeNamesCollection> getContextAttributeNamesWithHttpInfo(java.lang.String projectKey,
                                                                                         java.lang.String environmentKey,
                                                                                         java.lang.String filter)
                                                                                  throws ApiException

Get context attribute names Get context attribute names.

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

filter - A comma-separated list of context filters. This endpoint only accepts `kind` filters, with the `equals` operator, and `name` filters, with the `startsWith` operator. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

Returns:

ApiResponse<ContextAttributeNamesCollection>

Throws:

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

getContextAttributeNamesAsync

public okhttp3.Call getContextAttributeNamesAsync(java.lang.String projectKey,
                                                  java.lang.String environmentKey,
                                                  java.lang.String filter,
                                                  ApiCallback<ContextAttributeNamesCollection> _callback)
                                           throws ApiException

Get context attribute names (asynchronously) Get context attribute names.

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

filter - A comma-separated list of context filters. This endpoint only accepts `kind` filters, with the `equals` operator, and `name` filters, with the `startsWith` operator. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (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

getContextAttributeValuesCall

public okhttp3.Call getContextAttributeValuesCall(java.lang.String projectKey,
                                                  java.lang.String environmentKey,
                                                  java.lang.String attributeName,
                                                  java.lang.String filter,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for getContextAttributeValues

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

attributeName - The attribute name (required)

filter - A comma-separated list of context filters. This endpoint only accepts `kind` filters, with the `equals` operator, and `value` filters, with the `startsWith` operator. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getContextAttributeValues

public ContextAttributeValuesCollection getContextAttributeValues(java.lang.String projectKey,
                                                                  java.lang.String environmentKey,
                                                                  java.lang.String attributeName,
                                                                  java.lang.String filter)
                                                           throws ApiException

Get context attribute values Get context attribute values.

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

attributeName - The attribute name (required)

filter - A comma-separated list of context filters. This endpoint only accepts `kind` filters, with the `equals` operator, and `value` filters, with the `startsWith` operator. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

Returns:

ContextAttributeValuesCollection

Throws:

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

getContextAttributeValuesWithHttpInfo

public ApiResponse<ContextAttributeValuesCollection> getContextAttributeValuesWithHttpInfo(java.lang.String projectKey,
                                                                                           java.lang.String environmentKey,
                                                                                           java.lang.String attributeName,
                                                                                           java.lang.String filter)
                                                                                    throws ApiException

Get context attribute values Get context attribute values.

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

attributeName - The attribute name (required)

filter - A comma-separated list of context filters. This endpoint only accepts `kind` filters, with the `equals` operator, and `value` filters, with the `startsWith` operator. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

Returns:

ApiResponse<ContextAttributeValuesCollection>

Throws:

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

getContextAttributeValuesAsync

public okhttp3.Call getContextAttributeValuesAsync(java.lang.String projectKey,
                                                   java.lang.String environmentKey,
                                                   java.lang.String attributeName,
                                                   java.lang.String filter,
                                                   ApiCallback<ContextAttributeValuesCollection> _callback)
                                            throws ApiException

Get context attribute values (asynchronously) Get context attribute values.

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

attributeName - The attribute name (required)

filter - A comma-separated list of context filters. This endpoint only accepts `kind` filters, with the `equals` operator, and `value` filters, with the `startsWith` operator. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (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

getContextInstancesCall

public okhttp3.Call getContextInstancesCall(java.lang.String projectKey,
                                            java.lang.String environmentKey,
                                            java.lang.String id,
                                            java.lang.Long limit,
                                            java.lang.String continuationToken,
                                            java.lang.String sort,
                                            java.lang.String filter,
                                            java.lang.Boolean includeTotalCount,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for getContextInstances

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

id - The context instance ID (required)

limit - Specifies the maximum number of context instances to return (max: 50, default: 20) (optional)

continuationToken - Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. (optional)

sort - Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. (optional)

filter - A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

includeTotalCount - Specifies whether to include or omit the total count of matching context instances. Defaults to true. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getContextInstances

public ContextInstances getContextInstances(java.lang.String projectKey,
                                            java.lang.String environmentKey,
                                            java.lang.String id,
                                            java.lang.Long limit,
                                            java.lang.String continuationToken,
                                            java.lang.String sort,
                                            java.lang.String filter,
                                            java.lang.Boolean includeTotalCount)
                                     throws ApiException

Get context instances Get context instances by ID.

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

id - The context instance ID (required)

limit - Specifies the maximum number of context instances to return (max: 50, default: 20) (optional)

continuationToken - Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. (optional)

sort - Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. (optional)

filter - A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

includeTotalCount - Specifies whether to include or omit the total count of matching context instances. Defaults to true. (optional)

Returns:

ContextInstances

Throws:

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

getContextInstancesWithHttpInfo

public ApiResponse<ContextInstances> getContextInstancesWithHttpInfo(java.lang.String projectKey,
                                                                     java.lang.String environmentKey,
                                                                     java.lang.String id,
                                                                     java.lang.Long limit,
                                                                     java.lang.String continuationToken,
                                                                     java.lang.String sort,
                                                                     java.lang.String filter,
                                                                     java.lang.Boolean includeTotalCount)
                                                              throws ApiException

Get context instances Get context instances by ID.

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

id - The context instance ID (required)

limit - Specifies the maximum number of context instances to return (max: 50, default: 20) (optional)

continuationToken - Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. (optional)

sort - Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. (optional)

filter - A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

includeTotalCount - Specifies whether to include or omit the total count of matching context instances. Defaults to true. (optional)

Returns:

ApiResponse<ContextInstances>

Throws:

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

getContextInstancesAsync

public okhttp3.Call getContextInstancesAsync(java.lang.String projectKey,
                                             java.lang.String environmentKey,
                                             java.lang.String id,
                                             java.lang.Long limit,
                                             java.lang.String continuationToken,
                                             java.lang.String sort,
                                             java.lang.String filter,
                                             java.lang.Boolean includeTotalCount,
                                             ApiCallback<ContextInstances> _callback)
                                      throws ApiException

Get context instances (asynchronously) Get context instances by ID.

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

id - The context instance ID (required)

limit - Specifies the maximum number of context instances to return (max: 50, default: 20) (optional)

continuationToken - Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. (optional)

sort - Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. (optional)

filter - A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

includeTotalCount - Specifies whether to include or omit the total count of matching context instances. Defaults to true. (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

getContextKindsByProjectKeyCall

public okhttp3.Call getContextKindsByProjectKeyCall(java.lang.String projectKey,
                                                    ApiCallback _callback)
                                             throws ApiException

Build call for getContextKindsByProjectKey

Parameters:

projectKey - The project key (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getContextKindsByProjectKey

public ContextKindsCollectionRep getContextKindsByProjectKey(java.lang.String projectKey)
                                                      throws ApiException

Get context kinds Get all context kinds for a given project.

Parameters:

projectKey - The project key (required)

Returns:

ContextKindsCollectionRep

Throws:

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

getContextKindsByProjectKeyWithHttpInfo

public ApiResponse<ContextKindsCollectionRep> getContextKindsByProjectKeyWithHttpInfo(java.lang.String projectKey)
                                                                               throws ApiException

Get context kinds Get all context kinds for a given project.

Parameters:

projectKey - The project key (required)

Returns:

ApiResponse<ContextKindsCollectionRep>

Throws:

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

getContextKindsByProjectKeyAsync

public okhttp3.Call getContextKindsByProjectKeyAsync(java.lang.String projectKey,
                                                     ApiCallback<ContextKindsCollectionRep> _callback)
                                              throws ApiException

Get context kinds (asynchronously) Get all context kinds for a given project.

Parameters:

projectKey - The project key (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

getContextsCall

public okhttp3.Call getContextsCall(java.lang.String projectKey,
                                    java.lang.String environmentKey,
                                    java.lang.String kind,
                                    java.lang.String key,
                                    java.lang.Long limit,
                                    java.lang.String continuationToken,
                                    java.lang.String sort,
                                    java.lang.String filter,
                                    java.lang.Boolean includeTotalCount,
                                    ApiCallback _callback)
                             throws ApiException

Build call for getContexts

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

kind - The context kind (required)

key - The context key (required)

limit - Specifies the maximum number of items in the collection to return (max: 50, default: 20) (optional)

continuationToken - Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. (optional)

sort - Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. (optional)

filter - A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

includeTotalCount - Specifies whether to include or omit the total count of matching contexts. Defaults to true. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getContexts

public Contexts getContexts(java.lang.String projectKey,
                            java.lang.String environmentKey,
                            java.lang.String kind,
                            java.lang.String key,
                            java.lang.Long limit,
                            java.lang.String continuationToken,
                            java.lang.String sort,
                            java.lang.String filter,
                            java.lang.Boolean includeTotalCount)
                     throws ApiException

Get contexts Get contexts based on kind and key.

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

kind - The context kind (required)

key - The context key (required)

limit - Specifies the maximum number of items in the collection to return (max: 50, default: 20) (optional)

continuationToken - Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. (optional)

sort - Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. (optional)

filter - A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

includeTotalCount - Specifies whether to include or omit the total count of matching contexts. Defaults to true. (optional)

Returns:

Contexts

Throws:

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

getContextsWithHttpInfo

public ApiResponse<Contexts> getContextsWithHttpInfo(java.lang.String projectKey,
                                                     java.lang.String environmentKey,
                                                     java.lang.String kind,
                                                     java.lang.String key,
                                                     java.lang.Long limit,
                                                     java.lang.String continuationToken,
                                                     java.lang.String sort,
                                                     java.lang.String filter,
                                                     java.lang.Boolean includeTotalCount)
                                              throws ApiException

Get contexts Get contexts based on kind and key.

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

kind - The context kind (required)

key - The context key (required)

limit - Specifies the maximum number of items in the collection to return (max: 50, default: 20) (optional)

continuationToken - Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. (optional)

sort - Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. (optional)

filter - A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

includeTotalCount - Specifies whether to include or omit the total count of matching contexts. Defaults to true. (optional)

Returns:

ApiResponse<Contexts>

Throws:

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

getContextsAsync

public okhttp3.Call getContextsAsync(java.lang.String projectKey,
                                     java.lang.String environmentKey,
                                     java.lang.String kind,
                                     java.lang.String key,
                                     java.lang.Long limit,
                                     java.lang.String continuationToken,
                                     java.lang.String sort,
                                     java.lang.String filter,
                                     java.lang.Boolean includeTotalCount,
                                     ApiCallback<Contexts> _callback)
                              throws ApiException

Get contexts (asynchronously) Get contexts based on kind and key.

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

kind - The context kind (required)

key - The context key (required)

limit - Specifies the maximum number of items in the collection to return (max: 50, default: 20) (optional)

continuationToken - Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. (optional)

sort - Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. (optional)

filter - A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

includeTotalCount - Specifies whether to include or omit the total count of matching contexts. Defaults to true. (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

putContextKindCall

public okhttp3.Call putContextKindCall(java.lang.String projectKey,
                                       java.lang.String key,
                                       UpsertContextKindPayload upsertContextKindPayload,
                                       ApiCallback _callback)
                                throws ApiException

Build call for putContextKind

Parameters:

projectKey - The project key (required)

key - The context kind key (required)

upsertContextKindPayload - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

putContextKind

public UpsertResponseRep putContextKind(java.lang.String projectKey,
                                        java.lang.String key,
                                        UpsertContextKindPayload upsertContextKindPayload)
                                 throws ApiException

Create or update context kind Create or update a context kind by key. Only the included fields will be updated.

Parameters:

projectKey - The project key (required)

key - The context kind key (required)

upsertContextKindPayload - (required)

Returns:

UpsertResponseRep

Throws:

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

putContextKindWithHttpInfo

public ApiResponse<UpsertResponseRep> putContextKindWithHttpInfo(java.lang.String projectKey,
                                                                 java.lang.String key,
                                                                 UpsertContextKindPayload upsertContextKindPayload)
                                                          throws ApiException

Create or update context kind Create or update a context kind by key. Only the included fields will be updated.

Parameters:

projectKey - The project key (required)

key - The context kind key (required)

upsertContextKindPayload - (required)

Returns:

ApiResponse<UpsertResponseRep>

Throws:

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

putContextKindAsync

public okhttp3.Call putContextKindAsync(java.lang.String projectKey,
                                        java.lang.String key,
                                        UpsertContextKindPayload upsertContextKindPayload,
                                        ApiCallback<UpsertResponseRep> _callback)
                                 throws ApiException

Create or update context kind (asynchronously) Create or update a context kind by key. Only the included fields will be updated.

Parameters:

projectKey - The project key (required)

key - The context kind key (required)

upsertContextKindPayload - (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

searchContextInstancesCall

public okhttp3.Call searchContextInstancesCall(java.lang.String projectKey,
                                               java.lang.String environmentKey,
                                               ContextInstanceSearch contextInstanceSearch,
                                               java.lang.Long limit,
                                               java.lang.String continuationToken,
                                               java.lang.String sort,
                                               java.lang.String filter,
                                               java.lang.Boolean includeTotalCount,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for searchContextInstances

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

contextInstanceSearch - (required)

limit - Specifies the maximum number of items in the collection to return (max: 50, default: 20) (optional)

continuationToken - Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. (optional)

sort - Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. (optional)

filter - A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

includeTotalCount - Specifies whether to include or omit the total count of matching context instances. Defaults to true. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

searchContextInstances

public ContextInstances searchContextInstances(java.lang.String projectKey,
                                               java.lang.String environmentKey,
                                               ContextInstanceSearch contextInstanceSearch,
                                               java.lang.Long limit,
                                               java.lang.String continuationToken,
                                               java.lang.String sort,
                                               java.lang.String filter,
                                               java.lang.Boolean includeTotalCount)
                                        throws ApiException

Search for context instances Search for context instances. You can use either the query parameters or the request body parameters. If both are provided, there is an error. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). To learn more about context instances, read [Understanding context instances](https://docs.launchdarkly.com/home/contexts#understanding-context-instances).

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

contextInstanceSearch - (required)

limit - Specifies the maximum number of items in the collection to return (max: 50, default: 20) (optional)

continuationToken - Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. (optional)

sort - Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. (optional)

filter - A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

includeTotalCount - Specifies whether to include or omit the total count of matching context instances. Defaults to true. (optional)

Returns:

ContextInstances

Throws:

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

searchContextInstancesWithHttpInfo

public ApiResponse<ContextInstances> searchContextInstancesWithHttpInfo(java.lang.String projectKey,
                                                                        java.lang.String environmentKey,
                                                                        ContextInstanceSearch contextInstanceSearch,
                                                                        java.lang.Long limit,
                                                                        java.lang.String continuationToken,
                                                                        java.lang.String sort,
                                                                        java.lang.String filter,
                                                                        java.lang.Boolean includeTotalCount)
                                                                 throws ApiException

Search for context instances Search for context instances. You can use either the query parameters or the request body parameters. If both are provided, there is an error. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). To learn more about context instances, read [Understanding context instances](https://docs.launchdarkly.com/home/contexts#understanding-context-instances).

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

contextInstanceSearch - (required)

limit - Specifies the maximum number of items in the collection to return (max: 50, default: 20) (optional)

continuationToken - Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. (optional)

sort - Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. (optional)

filter - A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

includeTotalCount - Specifies whether to include or omit the total count of matching context instances. Defaults to true. (optional)

Returns:

ApiResponse<ContextInstances>

Throws:

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

searchContextInstancesAsync

public okhttp3.Call searchContextInstancesAsync(java.lang.String projectKey,
                                                java.lang.String environmentKey,
                                                ContextInstanceSearch contextInstanceSearch,
                                                java.lang.Long limit,
                                                java.lang.String continuationToken,
                                                java.lang.String sort,
                                                java.lang.String filter,
                                                java.lang.Boolean includeTotalCount,
                                                ApiCallback<ContextInstances> _callback)
                                         throws ApiException

Search for context instances (asynchronously) Search for context instances. You can use either the query parameters or the request body parameters. If both are provided, there is an error. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). To learn more about context instances, read [Understanding context instances](https://docs.launchdarkly.com/home/contexts#understanding-context-instances).

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

contextInstanceSearch - (required)

limit - Specifies the maximum number of items in the collection to return (max: 50, default: 20) (optional)

continuationToken - Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. (optional)

sort - Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. (optional)

filter - A comma-separated list of context filters. This endpoint only accepts an `applicationId` filter. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

includeTotalCount - Specifies whether to include or omit the total count of matching context instances. Defaults to true. (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

searchContextsCall

public okhttp3.Call searchContextsCall(java.lang.String projectKey,
                                       java.lang.String environmentKey,
                                       ContextSearch contextSearch,
                                       java.lang.Long limit,
                                       java.lang.String continuationToken,
                                       java.lang.String sort,
                                       java.lang.String filter,
                                       java.lang.Boolean includeTotalCount,
                                       ApiCallback _callback)
                                throws ApiException

Build call for searchContexts

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

contextSearch - (required)

limit - Specifies the maximum number of items in the collection to return (max: 50, default: 20) (optional)

continuationToken - Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. (optional)

sort - Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. (optional)

filter - A comma-separated list of context filters. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

includeTotalCount - Specifies whether to include or omit the total count of matching contexts. Defaults to true. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

searchContexts

public Contexts searchContexts(java.lang.String projectKey,
                               java.lang.String environmentKey,
                               ContextSearch contextSearch,
                               java.lang.Long limit,
                               java.lang.String continuationToken,
                               java.lang.String sort,
                               java.lang.String filter,
                               java.lang.Boolean includeTotalCount)
                        throws ApiException

Search for contexts Search for contexts. You can use either the query parameters or the request body parameters. If both are provided, there is an error. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). To learn more about contexts, read [Understanding contexts and context kinds](https://docs.launchdarkly.com/home/contexts#understanding-contexts-and-context-kinds).

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

contextSearch - (required)

limit - Specifies the maximum number of items in the collection to return (max: 50, default: 20) (optional)

continuationToken - Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. (optional)

sort - Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. (optional)

filter - A comma-separated list of context filters. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

includeTotalCount - Specifies whether to include or omit the total count of matching contexts. Defaults to true. (optional)

Returns:

Contexts

Throws:

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

searchContextsWithHttpInfo

public ApiResponse<Contexts> searchContextsWithHttpInfo(java.lang.String projectKey,
                                                        java.lang.String environmentKey,
                                                        ContextSearch contextSearch,
                                                        java.lang.Long limit,
                                                        java.lang.String continuationToken,
                                                        java.lang.String sort,
                                                        java.lang.String filter,
                                                        java.lang.Boolean includeTotalCount)
                                                 throws ApiException

Search for contexts Search for contexts. You can use either the query parameters or the request body parameters. If both are provided, there is an error. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). To learn more about contexts, read [Understanding contexts and context kinds](https://docs.launchdarkly.com/home/contexts#understanding-contexts-and-context-kinds).

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

contextSearch - (required)

limit - Specifies the maximum number of items in the collection to return (max: 50, default: 20) (optional)

continuationToken - Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. (optional)

sort - Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. (optional)

filter - A comma-separated list of context filters. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

includeTotalCount - Specifies whether to include or omit the total count of matching contexts. Defaults to true. (optional)

Returns:

ApiResponse<Contexts>

Throws:

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

searchContextsAsync

public okhttp3.Call searchContextsAsync(java.lang.String projectKey,
                                        java.lang.String environmentKey,
                                        ContextSearch contextSearch,
                                        java.lang.Long limit,
                                        java.lang.String continuationToken,
                                        java.lang.String sort,
                                        java.lang.String filter,
                                        java.lang.Boolean includeTotalCount,
                                        ApiCallback<Contexts> _callback)
                                 throws ApiException

Search for contexts (asynchronously) Search for contexts. You can use either the query parameters or the request body parameters. If both are provided, there is an error. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). To learn more about contexts, read [Understanding contexts and context kinds](https://docs.launchdarkly.com/home/contexts#understanding-contexts-and-context-kinds).

Parameters:

projectKey - The project key (required)

environmentKey - The environment key (required)

contextSearch - (required)

limit - Specifies the maximum number of items in the collection to return (max: 50, default: 20) (optional)

continuationToken - Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the `next` link we provide instead. (optional)

sort - Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying `ts` for this value, or descending order by specifying `-ts`. (optional)

filter - A comma-separated list of context filters. To learn more about the filter syntax, read [Filtering contexts and context instances](/tag/Contexts#filtering-contexts-and-context-instances). (optional)

includeTotalCount - Specifies whether to include or omit the total count of matching contexts. Defaults to true. (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