Package com.launchdarkly.api.api

Class EnvironmentsApi

java.lang.Object

com.launchdarkly.api.api.EnvironmentsApi

public class EnvironmentsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
EnvironmentsApi()
EnvironmentsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteEnvironment(java.lang.String projectKey, java.lang.String environmentKey)	Delete an environment in a specific project.
com.squareup.okhttp.Call	deleteEnvironmentAsync(java.lang.String projectKey, java.lang.String environmentKey, ApiCallback<java.lang.Void> callback)	Delete an environment in a specific project.
com.squareup.okhttp.Call	deleteEnvironmentCall(java.lang.String projectKey, java.lang.String environmentKey, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for deleteEnvironment
ApiResponse<java.lang.Void>	deleteEnvironmentWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey)	Delete an environment in a specific project.
ApiClient	getApiClient()
Environment	getEnvironment(java.lang.String projectKey, java.lang.String environmentKey)	Get an environment given a project and key.
com.squareup.okhttp.Call	getEnvironmentAsync(java.lang.String projectKey, java.lang.String environmentKey, ApiCallback<Environment> callback)	Get an environment given a project and key.
com.squareup.okhttp.Call	getEnvironmentCall(java.lang.String projectKey, java.lang.String environmentKey, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getEnvironment
ApiResponse<Environment>	getEnvironmentWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey)	Get an environment given a project and key.
Environment	patchEnvironment(java.lang.String projectKey, java.lang.String environmentKey, java.util.List<PatchOperation> patchDelta)	Modify an environment by ID.
com.squareup.okhttp.Call	patchEnvironmentAsync(java.lang.String projectKey, java.lang.String environmentKey, java.util.List<PatchOperation> patchDelta, ApiCallback<Environment> callback)	Modify an environment by ID.
com.squareup.okhttp.Call	patchEnvironmentCall(java.lang.String projectKey, java.lang.String environmentKey, java.util.List<PatchOperation> patchDelta, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for patchEnvironment
ApiResponse<Environment>	patchEnvironmentWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.util.List<PatchOperation> patchDelta)	Modify an environment by ID.
Environment	postEnvironment(java.lang.String projectKey, EnvironmentPost environmentBody)	Create a new environment in a specified project with a given name, key, and swatch color.
com.squareup.okhttp.Call	postEnvironmentAsync(java.lang.String projectKey, EnvironmentPost environmentBody, ApiCallback<Environment> callback)	Create a new environment in a specified project with a given name, key, and swatch color.
com.squareup.okhttp.Call	postEnvironmentCall(java.lang.String projectKey, EnvironmentPost environmentBody, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for postEnvironment
ApiResponse<Environment>	postEnvironmentWithHttpInfo(java.lang.String projectKey, EnvironmentPost environmentBody)	Create a new environment in a specified project with a given name, key, and swatch color.
Environment	resetEnvironmentMobileKey(java.lang.String projectKey, java.lang.String environmentKey, java.lang.Long expiry)	Reset an environment's mobile key.
com.squareup.okhttp.Call	resetEnvironmentMobileKeyAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.Long expiry, ApiCallback<Environment> callback)	Reset an environment's mobile key.
com.squareup.okhttp.Call	resetEnvironmentMobileKeyCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.Long expiry, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for resetEnvironmentMobileKey
ApiResponse<Environment>	resetEnvironmentMobileKeyWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.Long expiry)	Reset an environment's mobile key.
Environment	resetEnvironmentSDKKey(java.lang.String projectKey, java.lang.String environmentKey, java.lang.Long expiry)	Reset an environment's SDK key with an optional expiry time for the old key.
com.squareup.okhttp.Call	resetEnvironmentSDKKeyAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.Long expiry, ApiCallback<Environment> callback)	Reset an environment's SDK key with an optional expiry time for the old key.
com.squareup.okhttp.Call	resetEnvironmentSDKKeyCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.Long expiry, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for resetEnvironmentSDKKey
ApiResponse<Environment>	resetEnvironmentSDKKeyWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.Long expiry)	Reset an environment's SDK key with an optional expiry time for the old key.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvironmentsApi

public EnvironmentsApi()

EnvironmentsApi

public EnvironmentsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

deleteEnvironmentCall

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

Build call for deleteEnvironment

Parameters:

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

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteEnvironment

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

Delete an environment in a specific project.

Parameters:

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

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

Throws:

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

deleteEnvironmentWithHttpInfo

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

Delete an environment in a specific project.

Parameters:

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

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

Returns:

ApiResponse<Void>

Throws:

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

deleteEnvironmentAsync

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

Delete an environment in a specific project. (asynchronously)

Parameters:

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

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

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

getEnvironmentCall

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

Build call for getEnvironment

Parameters:

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

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getEnvironment

public Environment getEnvironment(java.lang.String projectKey,
                                  java.lang.String environmentKey)
                           throws ApiException

Get an environment given a project and key.

Parameters:

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

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

Returns:

Environment

Throws:

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

getEnvironmentWithHttpInfo

public ApiResponse<Environment> getEnvironmentWithHttpInfo(java.lang.String projectKey,
                                                           java.lang.String environmentKey)
                                                    throws ApiException

Get an environment given a project and key.

Parameters:

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

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

Returns:

ApiResponse<Environment>

Throws:

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

getEnvironmentAsync

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

Get an environment given a project and key. (asynchronously)

Parameters:

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

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

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

patchEnvironmentCall

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

Build call for patchEnvironment

Parameters:

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

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

patchDelta - Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/' (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

patchEnvironment

public Environment patchEnvironment(java.lang.String projectKey,
                                    java.lang.String environmentKey,
                                    java.util.List<PatchOperation> patchDelta)
                             throws ApiException

Modify an environment by ID. If you try to patch the environment by setting both required and requiredApprovalTags, it will result in an error. Users can specify either required approvals for all flags in an environment or those with specific tags, but not both. Only customers on an Enterprise plan can require approval for flag updates with either mechanism.

Parameters:

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

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

patchDelta - Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/' (required)

Returns:

Environment

Throws:

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

patchEnvironmentWithHttpInfo

public ApiResponse<Environment> patchEnvironmentWithHttpInfo(java.lang.String projectKey,
                                                             java.lang.String environmentKey,
                                                             java.util.List<PatchOperation> patchDelta)
                                                      throws ApiException

Modify an environment by ID. If you try to patch the environment by setting both required and requiredApprovalTags, it will result in an error. Users can specify either required approvals for all flags in an environment or those with specific tags, but not both. Only customers on an Enterprise plan can require approval for flag updates with either mechanism.

Parameters:

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

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

patchDelta - Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/' (required)

Returns:

ApiResponse<Environment>

Throws:

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

patchEnvironmentAsync

public com.squareup.okhttp.Call patchEnvironmentAsync(java.lang.String projectKey,
                                                      java.lang.String environmentKey,
                                                      java.util.List<PatchOperation> patchDelta,
                                                      ApiCallback<Environment> callback)
                                               throws ApiException

Modify an environment by ID. If you try to patch the environment by setting both required and requiredApprovalTags, it will result in an error. Users can specify either required approvals for all flags in an environment or those with specific tags, but not both. Only customers on an Enterprise plan can require approval for flag updates with either mechanism. (asynchronously)

Parameters:

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

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

patchDelta - Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/' (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

postEnvironmentCall

public com.squareup.okhttp.Call postEnvironmentCall(java.lang.String projectKey,
                                                    EnvironmentPost environmentBody,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for postEnvironment

Parameters:

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

environmentBody - New environment. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

postEnvironment

public Environment postEnvironment(java.lang.String projectKey,
                                   EnvironmentPost environmentBody)
                            throws ApiException

Create a new environment in a specified project with a given name, key, and swatch color.

Parameters:

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

environmentBody - New environment. (required)

Returns:

Environment

Throws:

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

postEnvironmentWithHttpInfo

public ApiResponse<Environment> postEnvironmentWithHttpInfo(java.lang.String projectKey,
                                                            EnvironmentPost environmentBody)
                                                     throws ApiException

Create a new environment in a specified project with a given name, key, and swatch color.

Parameters:

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

environmentBody - New environment. (required)

Returns:

ApiResponse<Environment>

Throws:

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

postEnvironmentAsync

public com.squareup.okhttp.Call postEnvironmentAsync(java.lang.String projectKey,
                                                     EnvironmentPost environmentBody,
                                                     ApiCallback<Environment> callback)
                                              throws ApiException

Create a new environment in a specified project with a given name, key, and swatch color. (asynchronously)

Parameters:

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

environmentBody - New 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

resetEnvironmentMobileKeyCall

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

Build call for resetEnvironmentMobileKey

Parameters:

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

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

expiry - The expiry parameter is deprecated for this endpoint, so the old mobile key will always expire immediately. This parameter will be removed in an upcoming major API client version. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

resetEnvironmentMobileKey

public Environment resetEnvironmentMobileKey(java.lang.String projectKey,
                                             java.lang.String environmentKey,
                                             java.lang.Long expiry)
                                      throws ApiException

Reset an environment's mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately.

Parameters:

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

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

expiry - The expiry parameter is deprecated for this endpoint, so the old mobile key will always expire immediately. This parameter will be removed in an upcoming major API client version. (optional)

Returns:

Environment

Throws:

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

resetEnvironmentMobileKeyWithHttpInfo

public ApiResponse<Environment> resetEnvironmentMobileKeyWithHttpInfo(java.lang.String projectKey,
                                                                      java.lang.String environmentKey,
                                                                      java.lang.Long expiry)
                                                               throws ApiException

Reset an environment's mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately.

Parameters:

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

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

expiry - The expiry parameter is deprecated for this endpoint, so the old mobile key will always expire immediately. This parameter will be removed in an upcoming major API client version. (optional)

Returns:

ApiResponse<Environment>

Throws:

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

resetEnvironmentMobileKeyAsync

public com.squareup.okhttp.Call resetEnvironmentMobileKeyAsync(java.lang.String projectKey,
                                                               java.lang.String environmentKey,
                                                               java.lang.Long expiry,
                                                               ApiCallback<Environment> callback)
                                                        throws ApiException

Reset an environment's mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately. (asynchronously)

Parameters:

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

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

expiry - The expiry parameter is deprecated for this endpoint, so the old mobile key will always expire immediately. This parameter will be removed in an upcoming major API client version. (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

resetEnvironmentSDKKeyCall

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

Build call for resetEnvironmentSDKKey

Parameters:

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

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

expiry - An expiration time for the old environment SDK key, expressed as a Unix epoch time in milliseconds. By default, the key will expire immediately. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

resetEnvironmentSDKKey

public Environment resetEnvironmentSDKKey(java.lang.String projectKey,
                                          java.lang.String environmentKey,
                                          java.lang.Long expiry)
                                   throws ApiException

Reset an environment's SDK key with an optional expiry time for the old key.

Parameters:

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

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

expiry - An expiration time for the old environment SDK key, expressed as a Unix epoch time in milliseconds. By default, the key will expire immediately. (optional)

Returns:

Environment

Throws:

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

resetEnvironmentSDKKeyWithHttpInfo

public ApiResponse<Environment> resetEnvironmentSDKKeyWithHttpInfo(java.lang.String projectKey,
                                                                   java.lang.String environmentKey,
                                                                   java.lang.Long expiry)
                                                            throws ApiException

Reset an environment's SDK key with an optional expiry time for the old key.

Parameters:

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

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

expiry - An expiration time for the old environment SDK key, expressed as a Unix epoch time in milliseconds. By default, the key will expire immediately. (optional)

Returns:

ApiResponse<Environment>

Throws:

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

resetEnvironmentSDKKeyAsync

public com.squareup.okhttp.Call resetEnvironmentSDKKeyAsync(java.lang.String projectKey,
                                                            java.lang.String environmentKey,
                                                            java.lang.Long expiry,
                                                            ApiCallback<Environment> callback)
                                                     throws ApiException

Reset an environment's SDK key with an optional expiry time for the old key. (asynchronously)

Parameters:

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

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

expiry - An expiration time for the old environment SDK key, expressed as a Unix epoch time in milliseconds. By default, the key will expire immediately. (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