Class FeatureFlagSettingValuesApi
- java.lang.Object
-
- com.configcat.publicapi.java.client.api.FeatureFlagSettingValuesApi
-
public class FeatureFlagSettingValuesApi extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description FeatureFlagSettingValuesApi()FeatureFlagSettingValuesApi(ApiClient apiClient)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ApiClientgetApiClient()java.lang.StringgetCustomBaseUrl()intgetHostIndex()SettingValueModelgetSettingValue(java.util.UUID environmentId, java.lang.Integer settingId)Get value This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter.okhttp3.CallgetSettingValueAsync(java.util.UUID environmentId, java.lang.Integer settingId, ApiCallback<SettingValueModel> _callback)Get value (asynchronously) This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter.okhttp3.CallgetSettingValueCall(java.util.UUID environmentId, java.lang.Integer settingId, ApiCallback _callback)Build call for getSettingValueConfigSettingValuesModelgetSettingValues(java.util.UUID configId, java.util.UUID environmentId)Get values This endpoint returns the value of a specified Config's Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter.okhttp3.CallgetSettingValuesAsync(java.util.UUID configId, java.util.UUID environmentId, ApiCallback<ConfigSettingValuesModel> _callback)Get values (asynchronously) This endpoint returns the value of a specified Config's Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter.okhttp3.CallgetSettingValuesCall(java.util.UUID configId, java.util.UUID environmentId, ApiCallback _callback)Build call for getSettingValuesApiResponse<ConfigSettingValuesModel>getSettingValuesWithHttpInfo(java.util.UUID configId, java.util.UUID environmentId)Get values This endpoint returns the value of a specified Config's Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter.ApiResponse<SettingValueModel>getSettingValueWithHttpInfo(java.util.UUID environmentId, java.lang.Integer settingId)Get value This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter.ConfigSettingValuesModelpostSettingValues(java.util.UUID configId, java.util.UUID environmentId, UpdateSettingValuesWithIdModel updateSettingValuesWithIdModel, java.lang.String reason)Post values This endpoint replaces the values of a specified Config's Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter.okhttp3.CallpostSettingValuesAsync(java.util.UUID configId, java.util.UUID environmentId, UpdateSettingValuesWithIdModel updateSettingValuesWithIdModel, java.lang.String reason, ApiCallback<ConfigSettingValuesModel> _callback)Post values (asynchronously) This endpoint replaces the values of a specified Config's Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter.okhttp3.CallpostSettingValuesCall(java.util.UUID configId, java.util.UUID environmentId, UpdateSettingValuesWithIdModel updateSettingValuesWithIdModel, java.lang.String reason, ApiCallback _callback)Build call for postSettingValuesApiResponse<ConfigSettingValuesModel>postSettingValuesWithHttpInfo(java.util.UUID configId, java.util.UUID environmentId, UpdateSettingValuesWithIdModel updateSettingValuesWithIdModel, java.lang.String reason)Post values This endpoint replaces the values of a specified Config's Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter.SettingValueModelreplaceSettingValue(java.util.UUID environmentId, java.lang.Integer settingId, UpdateSettingValueModel updateSettingValueModel, java.lang.String reason)Replace value This endpoint replaces the whole value of a Feature Flag or Setting in a specified Environment.okhttp3.CallreplaceSettingValueAsync(java.util.UUID environmentId, java.lang.Integer settingId, UpdateSettingValueModel updateSettingValueModel, java.lang.String reason, ApiCallback<SettingValueModel> _callback)Replace value (asynchronously) This endpoint replaces the whole value of a Feature Flag or Setting in a specified Environment.okhttp3.CallreplaceSettingValueCall(java.util.UUID environmentId, java.lang.Integer settingId, UpdateSettingValueModel updateSettingValueModel, java.lang.String reason, ApiCallback _callback)Build call for replaceSettingValueApiResponse<SettingValueModel>replaceSettingValueWithHttpInfo(java.util.UUID environmentId, java.lang.Integer settingId, UpdateSettingValueModel updateSettingValueModel, java.lang.String reason)Replace value This endpoint replaces the whole value of a Feature Flag or Setting in a specified Environment.voidsetApiClient(ApiClient apiClient)voidsetCustomBaseUrl(java.lang.String customBaseUrl)voidsetHostIndex(int hostIndex)SettingValueModelupdateSettingValue(java.util.UUID environmentId, java.lang.Integer settingId, java.util.List<JsonPatchOperation> jsonPatchOperation, java.lang.String reason)Update value This endpoint updates the value of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Environment.okhttp3.CallupdateSettingValueAsync(java.util.UUID environmentId, java.lang.Integer settingId, java.util.List<JsonPatchOperation> jsonPatchOperation, java.lang.String reason, ApiCallback<SettingValueModel> _callback)Update value (asynchronously) This endpoint updates the value of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Environment.okhttp3.CallupdateSettingValueCall(java.util.UUID environmentId, java.lang.Integer settingId, java.util.List<JsonPatchOperation> jsonPatchOperation, java.lang.String reason, ApiCallback _callback)Build call for updateSettingValueApiResponse<SettingValueModel>updateSettingValueWithHttpInfo(java.util.UUID environmentId, java.lang.Integer settingId, java.util.List<JsonPatchOperation> jsonPatchOperation, java.lang.String reason)Update value This endpoint updates the value of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Environment.
-
-
-
Constructor Detail
-
FeatureFlagSettingValuesApi
public FeatureFlagSettingValuesApi()
-
FeatureFlagSettingValuesApi
public FeatureFlagSettingValuesApi(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)
-
getSettingValueCall
public okhttp3.Call getSettingValueCall(java.util.UUID environmentId, java.lang.Integer settingId, ApiCallback _callback) throws ApiExceptionBuild call for getSettingValue- Parameters:
environmentId- The identifier of the Environment. (required)settingId- The id of the Setting. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- Http Response Details
Status Code Description Response Headers 200 When everything is ok, the setting value data returned. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
getSettingValue
public SettingValueModel getSettingValue(java.util.UUID environmentId, java.lang.Integer settingId) throws ApiException
Get value This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview).- Parameters:
environmentId- The identifier of the Environment. (required)settingId- The id of the Setting. (required)- Returns:
- SettingValueModel
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 200 When everything is ok, the setting value data returned. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
getSettingValueWithHttpInfo
public ApiResponse<SettingValueModel> getSettingValueWithHttpInfo(java.util.UUID environmentId, java.lang.Integer settingId) throws ApiException
Get value This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview).- Parameters:
environmentId- The identifier of the Environment. (required)settingId- The id of the Setting. (required)- Returns:
- ApiResponse<SettingValueModel>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 200 When everything is ok, the setting value data returned. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
getSettingValueAsync
public okhttp3.Call getSettingValueAsync(java.util.UUID environmentId, java.lang.Integer settingId, ApiCallback<SettingValueModel> _callback) throws ApiExceptionGet value (asynchronously) This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview).- Parameters:
environmentId- The identifier of the Environment. (required)settingId- The id of the Setting. (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- Http Response Details
Status Code Description Response Headers 200 When everything is ok, the setting value data returned. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
getSettingValuesCall
public okhttp3.Call getSettingValuesCall(java.util.UUID configId, java.util.UUID environmentId, ApiCallback _callback) throws ApiExceptionBuild call for getSettingValues- Parameters:
configId- The identifier of the Config. (required)environmentId- The identifier of the Environment. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- Http Response Details
Status Code Description Response Headers 200 When everything is ok, the setting values returned. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
getSettingValues
public ConfigSettingValuesModel getSettingValues(java.util.UUID configId, java.util.UUID environmentId) throws ApiException
Get values This endpoint returns the value of a specified Config's Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/).- Parameters:
configId- The identifier of the Config. (required)environmentId- The identifier of the Environment. (required)- Returns:
- ConfigSettingValuesModel
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 200 When everything is ok, the setting values returned. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
getSettingValuesWithHttpInfo
public ApiResponse<ConfigSettingValuesModel> getSettingValuesWithHttpInfo(java.util.UUID configId, java.util.UUID environmentId) throws ApiException
Get values This endpoint returns the value of a specified Config's Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/).- Parameters:
configId- The identifier of the Config. (required)environmentId- The identifier of the Environment. (required)- Returns:
- ApiResponse<ConfigSettingValuesModel>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 200 When everything is ok, the setting values returned. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
getSettingValuesAsync
public okhttp3.Call getSettingValuesAsync(java.util.UUID configId, java.util.UUID environmentId, ApiCallback<ConfigSettingValuesModel> _callback) throws ApiExceptionGet values (asynchronously) This endpoint returns the value of a specified Config's Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/).- Parameters:
configId- The identifier of the Config. (required)environmentId- The identifier of the Environment. (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- Http Response Details
Status Code Description Response Headers 200 When everything is ok, the setting values returned. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
postSettingValuesCall
public okhttp3.Call postSettingValuesCall(java.util.UUID configId, java.util.UUID environmentId, UpdateSettingValuesWithIdModel updateSettingValuesWithIdModel, java.lang.String reason, ApiCallback _callback) throws ApiExceptionBuild call for postSettingValues- Parameters:
configId- The identifier of the Config. (required)environmentId- The identifier of the Environment. (required)updateSettingValuesWithIdModel- (required)reason- The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- Http Response Details
Status Code Description Response Headers 200 When everything is ok, the updated setting values returned. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
postSettingValues
public ConfigSettingValuesModel postSettingValues(java.util.UUID configId, java.util.UUID environmentId, UpdateSettingValuesWithIdModel updateSettingValuesWithIdModel, java.lang.String reason) throws ApiException
Post values This endpoint replaces the values of a specified Config's Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it's important to set every other attribute that you don't want to change in its original state. Not listing one means it will reset. For example: We have the following resource. ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false, \"settingId\": 1 } ] } ``` If we send a replace request body as below: ```json { \"settingValues\": [ { \"value\": true, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true, \"setting\": { \"settingId\": 1 } } ] } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required.- Parameters:
configId- The identifier of the Config. (required)environmentId- The identifier of the Environment. (required)updateSettingValuesWithIdModel- (required)reason- The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)- Returns:
- ConfigSettingValuesModel
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 200 When everything is ok, the updated setting values returned. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
postSettingValuesWithHttpInfo
public ApiResponse<ConfigSettingValuesModel> postSettingValuesWithHttpInfo(java.util.UUID configId, java.util.UUID environmentId, UpdateSettingValuesWithIdModel updateSettingValuesWithIdModel, java.lang.String reason) throws ApiException
Post values This endpoint replaces the values of a specified Config's Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it's important to set every other attribute that you don't want to change in its original state. Not listing one means it will reset. For example: We have the following resource. ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false, \"settingId\": 1 } ] } ``` If we send a replace request body as below: ```json { \"settingValues\": [ { \"value\": true, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true, \"setting\": { \"settingId\": 1 } } ] } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required.- Parameters:
configId- The identifier of the Config. (required)environmentId- The identifier of the Environment. (required)updateSettingValuesWithIdModel- (required)reason- The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)- Returns:
- ApiResponse<ConfigSettingValuesModel>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 200 When everything is ok, the updated setting values returned. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
postSettingValuesAsync
public okhttp3.Call postSettingValuesAsync(java.util.UUID configId, java.util.UUID environmentId, UpdateSettingValuesWithIdModel updateSettingValuesWithIdModel, java.lang.String reason, ApiCallback<ConfigSettingValuesModel> _callback) throws ApiExceptionPost values (asynchronously) This endpoint replaces the values of a specified Config's Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it's important to set every other attribute that you don't want to change in its original state. Not listing one means it will reset. For example: We have the following resource. ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false, \"settingId\": 1 } ] } ``` If we send a replace request body as below: ```json { \"settingValues\": [ { \"value\": true, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true, \"setting\": { \"settingId\": 1 } } ] } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required.- Parameters:
configId- The identifier of the Config. (required)environmentId- The identifier of the Environment. (required)updateSettingValuesWithIdModel- (required)reason- The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (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- Http Response Details
Status Code Description Response Headers 200 When everything is ok, the updated setting values returned. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
replaceSettingValueCall
public okhttp3.Call replaceSettingValueCall(java.util.UUID environmentId, java.lang.Integer settingId, UpdateSettingValueModel updateSettingValueModel, java.lang.String reason, ApiCallback _callback) throws ApiExceptionBuild call for replaceSettingValue- Parameters:
environmentId- The identifier of the Environment. (required)settingId- The id of the Setting. (required)updateSettingValueModel- (required)reason- The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- Http Response Details
Status Code Description Response Headers 200 - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
replaceSettingValue
public SettingValueModel replaceSettingValue(java.util.UUID environmentId, java.lang.Integer settingId, UpdateSettingValueModel updateSettingValueModel, java.lang.String reason) throws ApiException
Replace value This endpoint replaces the whole value of a Feature Flag or Setting in a specified Environment. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it's important to set every other attribute that you don't want to change in its original state. Not listing one means it will reset. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required.- Parameters:
environmentId- The identifier of the Environment. (required)settingId- The id of the Setting. (required)updateSettingValueModel- (required)reason- The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)- Returns:
- SettingValueModel
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 200 - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
replaceSettingValueWithHttpInfo
public ApiResponse<SettingValueModel> replaceSettingValueWithHttpInfo(java.util.UUID environmentId, java.lang.Integer settingId, UpdateSettingValueModel updateSettingValueModel, java.lang.String reason) throws ApiException
Replace value This endpoint replaces the whole value of a Feature Flag or Setting in a specified Environment. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it's important to set every other attribute that you don't want to change in its original state. Not listing one means it will reset. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required.- Parameters:
environmentId- The identifier of the Environment. (required)settingId- The id of the Setting. (required)updateSettingValueModel- (required)reason- The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)- Returns:
- ApiResponse<SettingValueModel>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 200 - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
replaceSettingValueAsync
public okhttp3.Call replaceSettingValueAsync(java.util.UUID environmentId, java.lang.Integer settingId, UpdateSettingValueModel updateSettingValueModel, java.lang.String reason, ApiCallback<SettingValueModel> _callback) throws ApiExceptionReplace value (asynchronously) This endpoint replaces the whole value of a Feature Flag or Setting in a specified Environment. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it's important to set every other attribute that you don't want to change in its original state. Not listing one means it will reset. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required.- Parameters:
environmentId- The identifier of the Environment. (required)settingId- The id of the Setting. (required)updateSettingValueModel- (required)reason- The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (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- Http Response Details
Status Code Description Response Headers 200 - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
updateSettingValueCall
public okhttp3.Call updateSettingValueCall(java.util.UUID environmentId, java.lang.Integer settingId, java.util.List<JsonPatchOperation> jsonPatchOperation, java.lang.String reason, ApiCallback _callback) throws ApiExceptionBuild call for updateSettingValue- Parameters:
environmentId- The identifier of the Environment. (required)settingId- The id of the Setting. (required)jsonPatchOperation- (required)reason- The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- Http Response Details
Status Code Description Response Headers 200 When the patch was successful. - 204 When no change applied on the resource. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
updateSettingValue
public SettingValueModel updateSettingValue(java.util.UUID environmentId, java.lang.Integer settingId, java.util.List<JsonPatchOperation> jsonPatchOperation, java.lang.String reason) throws ApiException
Update value This endpoint updates the value of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Environment. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change. It supports collection reordering, so it also can be used for reordering the targeting rules of a Feature Flag or Setting. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send an update request body as below: ```json [ { \"op\": \"replace\", \"path\": \"/value\", \"value\": true } ] ``` Only the default value is going to be set to `true` and all the Percentage Rules are remaining unchanged. So we get a response like this: ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": true } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required.- Parameters:
environmentId- The identifier of the Environment. (required)settingId- The id of the Setting. (required)jsonPatchOperation- (required)reason- The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)- Returns:
- SettingValueModel
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 200 When the patch was successful. - 204 When no change applied on the resource. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
updateSettingValueWithHttpInfo
public ApiResponse<SettingValueModel> updateSettingValueWithHttpInfo(java.util.UUID environmentId, java.lang.Integer settingId, java.util.List<JsonPatchOperation> jsonPatchOperation, java.lang.String reason) throws ApiException
Update value This endpoint updates the value of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Environment. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change. It supports collection reordering, so it also can be used for reordering the targeting rules of a Feature Flag or Setting. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send an update request body as below: ```json [ { \"op\": \"replace\", \"path\": \"/value\", \"value\": true } ] ``` Only the default value is going to be set to `true` and all the Percentage Rules are remaining unchanged. So we get a response like this: ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": true } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required.- Parameters:
environmentId- The identifier of the Environment. (required)settingId- The id of the Setting. (required)jsonPatchOperation- (required)reason- The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)- Returns:
- ApiResponse<SettingValueModel>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 200 When the patch was successful. - 204 When no change applied on the resource. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
updateSettingValueAsync
public okhttp3.Call updateSettingValueAsync(java.util.UUID environmentId, java.lang.Integer settingId, java.util.List<JsonPatchOperation> jsonPatchOperation, java.lang.String reason, ApiCallback<SettingValueModel> _callback) throws ApiExceptionUpdate value (asynchronously) This endpoint updates the value of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Environment. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change. It supports collection reordering, so it also can be used for reordering the targeting rules of a Feature Flag or Setting. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send an update request body as below: ```json [ { \"op\": \"replace\", \"path\": \"/value\", \"value\": true } ] ``` Only the default value is going to be set to `true` and all the Percentage Rules are remaining unchanged. So we get a response like this: ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": true } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required.- Parameters:
environmentId- The identifier of the Environment. (required)settingId- The id of the Setting. (required)jsonPatchOperation- (required)reason- The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (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- Http Response Details
Status Code Description Response Headers 200 When the patch was successful. - 204 When no change applied on the resource. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
-