Package com.launchdarkly.api.api

Class CustomRolesApi

java.lang.Object

com.launchdarkly.api.api.CustomRolesApi

public class CustomRolesApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
CustomRolesApi()
CustomRolesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteCustomRole(java.lang.String customRoleKey)	Delete a custom role by key.
com.squareup.okhttp.Call	deleteCustomRoleAsync(java.lang.String customRoleKey, ApiCallback<java.lang.Void> callback)	Delete a custom role by key.
com.squareup.okhttp.Call	deleteCustomRoleCall(java.lang.String customRoleKey, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for deleteCustomRole
ApiResponse<java.lang.Void>	deleteCustomRoleWithHttpInfo(java.lang.String customRoleKey)	Delete a custom role by key.
ApiClient	getApiClient()
CustomRole	getCustomRole(java.lang.String customRoleKey)	Get one custom role by key.
com.squareup.okhttp.Call	getCustomRoleAsync(java.lang.String customRoleKey, ApiCallback<CustomRole> callback)	Get one custom role by key.
com.squareup.okhttp.Call	getCustomRoleCall(java.lang.String customRoleKey, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getCustomRole
CustomRoles	getCustomRoles()	Return a complete list of custom roles.
com.squareup.okhttp.Call	getCustomRolesAsync(ApiCallback<CustomRoles> callback)	Return a complete list of custom roles.
com.squareup.okhttp.Call	getCustomRolesCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getCustomRoles
ApiResponse<CustomRoles>	getCustomRolesWithHttpInfo()	Return a complete list of custom roles.
ApiResponse<CustomRole>	getCustomRoleWithHttpInfo(java.lang.String customRoleKey)	Get one custom role by key.
CustomRole	patchCustomRole(java.lang.String customRoleKey, java.util.List<PatchOperation> patchDelta)	Modify a custom role by key.
com.squareup.okhttp.Call	patchCustomRoleAsync(java.lang.String customRoleKey, java.util.List<PatchOperation> patchDelta, ApiCallback<CustomRole> callback)	Modify a custom role by key.
com.squareup.okhttp.Call	patchCustomRoleCall(java.lang.String customRoleKey, java.util.List<PatchOperation> patchDelta, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for patchCustomRole
ApiResponse<CustomRole>	patchCustomRoleWithHttpInfo(java.lang.String customRoleKey, java.util.List<PatchOperation> patchDelta)	Modify a custom role by key.
CustomRole	postCustomRole(CustomRoleBody customRoleBody)	Create a new custom role.
com.squareup.okhttp.Call	postCustomRoleAsync(CustomRoleBody customRoleBody, ApiCallback<CustomRole> callback)	Create a new custom role.
com.squareup.okhttp.Call	postCustomRoleCall(CustomRoleBody customRoleBody, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for postCustomRole
ApiResponse<CustomRole>	postCustomRoleWithHttpInfo(CustomRoleBody customRoleBody)	Create a new custom role.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomRolesApi

public CustomRolesApi()

CustomRolesApi

public CustomRolesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

deleteCustomRoleCall

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

Build call for deleteCustomRole

Parameters:

customRoleKey - The custom role key. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteCustomRole

public void deleteCustomRole(java.lang.String customRoleKey)
                      throws ApiException

Delete a custom role by key.

Parameters:

customRoleKey - The custom role key. (required)

Throws:

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

deleteCustomRoleWithHttpInfo

public ApiResponse<java.lang.Void> deleteCustomRoleWithHttpInfo(java.lang.String customRoleKey)
                                                         throws ApiException

Delete a custom role by key.

Parameters:

customRoleKey - The custom role key. (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteCustomRoleAsync

public com.squareup.okhttp.Call deleteCustomRoleAsync(java.lang.String customRoleKey,
                                                      ApiCallback<java.lang.Void> callback)
                                               throws ApiException

Delete a custom role by key. (asynchronously)

Parameters:

customRoleKey - The custom role 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

getCustomRoleCall

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

Build call for getCustomRole

Parameters:

customRoleKey - The custom role key. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getCustomRole

public CustomRole getCustomRole(java.lang.String customRoleKey)
                         throws ApiException

Get one custom role by key.

Parameters:

customRoleKey - The custom role key. (required)

Returns:

CustomRole

Throws:

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

getCustomRoleWithHttpInfo

public ApiResponse<CustomRole> getCustomRoleWithHttpInfo(java.lang.String customRoleKey)
                                                  throws ApiException

Get one custom role by key.

Parameters:

customRoleKey - The custom role key. (required)

Returns:

ApiResponse<CustomRole>

Throws:

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

getCustomRoleAsync

public com.squareup.okhttp.Call getCustomRoleAsync(java.lang.String customRoleKey,
                                                   ApiCallback<CustomRole> callback)
                                            throws ApiException

Get one custom role by key. (asynchronously)

Parameters:

customRoleKey - The custom role 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

getCustomRolesCall

public com.squareup.okhttp.Call getCustomRolesCall(ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for getCustomRoles

Parameters:

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getCustomRoles

public CustomRoles getCustomRoles()
                           throws ApiException

Return a complete list of custom roles.

Returns:

CustomRoles

Throws:

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

getCustomRolesWithHttpInfo

public ApiResponse<CustomRoles> getCustomRolesWithHttpInfo()
                                                    throws ApiException

Return a complete list of custom roles.

Returns:

ApiResponse<CustomRoles>

Throws:

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

getCustomRolesAsync

public com.squareup.okhttp.Call getCustomRolesAsync(ApiCallback<CustomRoles> callback)
                                             throws ApiException

Return a complete list of custom roles. (asynchronously)

Parameters:

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

patchCustomRoleCall

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

Build call for patchCustomRole

Parameters:

customRoleKey - The custom role key. (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

patchCustomRole

public CustomRole patchCustomRole(java.lang.String customRoleKey,
                                  java.util.List<PatchOperation> patchDelta)
                           throws ApiException

Modify a custom role by key.

Parameters:

customRoleKey - The custom role key. (required)

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

Returns:

CustomRole

Throws:

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

patchCustomRoleWithHttpInfo

public ApiResponse<CustomRole> patchCustomRoleWithHttpInfo(java.lang.String customRoleKey,
                                                           java.util.List<PatchOperation> patchDelta)
                                                    throws ApiException

Modify a custom role by key.

Parameters:

customRoleKey - The custom role key. (required)

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

Returns:

ApiResponse<CustomRole>

Throws:

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

patchCustomRoleAsync

public com.squareup.okhttp.Call patchCustomRoleAsync(java.lang.String customRoleKey,
                                                     java.util.List<PatchOperation> patchDelta,
                                                     ApiCallback<CustomRole> callback)
                                              throws ApiException

Modify a custom role by key. (asynchronously)

Parameters:

customRoleKey - The custom role key. (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

postCustomRoleCall

public com.squareup.okhttp.Call postCustomRoleCall(CustomRoleBody customRoleBody,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for postCustomRole

Parameters:

customRoleBody - New role or roles to create. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

postCustomRole

public CustomRole postCustomRole(CustomRoleBody customRoleBody)
                          throws ApiException

Create a new custom role.

Parameters:

customRoleBody - New role or roles to create. (required)

Returns:

CustomRole

Throws:

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

postCustomRoleWithHttpInfo

public ApiResponse<CustomRole> postCustomRoleWithHttpInfo(CustomRoleBody customRoleBody)
                                                   throws ApiException

Create a new custom role.

Parameters:

customRoleBody - New role or roles to create. (required)

Returns:

ApiResponse<CustomRole>

Throws:

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

postCustomRoleAsync

public com.squareup.okhttp.Call postCustomRoleAsync(CustomRoleBody customRoleBody,
                                                    ApiCallback<CustomRole> callback)
                                             throws ApiException

Create a new custom role. (asynchronously)

Parameters:

customRoleBody - New role or roles to create. (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