ControllerServicesApi

All URIs are relative to http://localhost/nifi-api

Method	HTTP request	Description
clearState	POST /controller-services/{id}/state/clear-requests	Clears the state for a controller service
getControllerService	GET /controller-services/{id}	Gets a controller service
getControllerServiceReferences	GET /controller-services/{id}/references	Gets a controller service
getPropertyDescriptor	GET /controller-services/{id}/descriptors	Gets a controller service property descriptor
getState	GET /controller-services/{id}/state	Gets the state for a controller service
removeControllerService	DELETE /controller-services/{id}	Deletes a controller service
updateControllerService	PUT /controller-services/{id}	Updates a controller service
updateControllerServiceReferences	PUT /controller-services/{id}/references	Updates a controller services references

clearState

ComponentStateEntity clearState(id)

Clears the state for a controller service

Example

// Import classes:
//import com.github.hermannpencole.nifi.swagger.ApiClient;
//import com.github.hermannpencole.nifi.swagger.ApiException;
//import com.github.hermannpencole.nifi.swagger.Configuration;
//import com.github.hermannpencole.nifi.swagger.auth.*;
//import com.github.hermannpencole.nifi.swagger.client.ControllerServicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: auth
OAuth auth = (OAuth) defaultClient.getAuthentication("auth");
auth.setAccessToken("YOUR ACCESS TOKEN");

ControllerServicesApi apiInstance = new ControllerServicesApi();
String id = "id_example"; // String | The controller service id.
try {
    ComponentStateEntity result = apiInstance.clearState(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerServicesApi#clearState");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The controller service id.

Return type

ComponentStateEntity

Authorization

auth

HTTP request headers

Content-Type: /
Accept: application/json

getControllerService

ControllerServiceEntity getControllerService(id)

Gets a controller service

Example

// Import classes:
//import com.github.hermannpencole.nifi.swagger.ApiClient;
//import com.github.hermannpencole.nifi.swagger.ApiException;
//import com.github.hermannpencole.nifi.swagger.Configuration;
//import com.github.hermannpencole.nifi.swagger.auth.*;
//import com.github.hermannpencole.nifi.swagger.client.ControllerServicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: auth
OAuth auth = (OAuth) defaultClient.getAuthentication("auth");
auth.setAccessToken("YOUR ACCESS TOKEN");

ControllerServicesApi apiInstance = new ControllerServicesApi();
String id = "id_example"; // String | The controller service id.
try {
    ControllerServiceEntity result = apiInstance.getControllerService(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerServicesApi#getControllerService");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The controller service id.

Return type

ControllerServiceEntity

Authorization

auth

HTTP request headers

Content-Type: /
Accept: application/json

getControllerServiceReferences

ControllerServiceReferencingComponentsEntity getControllerServiceReferences(id)

Gets a controller service

Example

// Import classes:
//import com.github.hermannpencole.nifi.swagger.ApiClient;
//import com.github.hermannpencole.nifi.swagger.ApiException;
//import com.github.hermannpencole.nifi.swagger.Configuration;
//import com.github.hermannpencole.nifi.swagger.auth.*;
//import com.github.hermannpencole.nifi.swagger.client.ControllerServicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: auth
OAuth auth = (OAuth) defaultClient.getAuthentication("auth");
auth.setAccessToken("YOUR ACCESS TOKEN");

ControllerServicesApi apiInstance = new ControllerServicesApi();
String id = "id_example"; // String | The controller service id.
try {
    ControllerServiceReferencingComponentsEntity result = apiInstance.getControllerServiceReferences(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerServicesApi#getControllerServiceReferences");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The controller service id.

Return type

ControllerServiceReferencingComponentsEntity

Authorization

auth

HTTP request headers

Content-Type: /
Accept: application/json

getPropertyDescriptor

PropertyDescriptorEntity getPropertyDescriptor(id, propertyName)

Gets a controller service property descriptor

Example

// Import classes:
//import com.github.hermannpencole.nifi.swagger.ApiClient;
//import com.github.hermannpencole.nifi.swagger.ApiException;
//import com.github.hermannpencole.nifi.swagger.Configuration;
//import com.github.hermannpencole.nifi.swagger.auth.*;
//import com.github.hermannpencole.nifi.swagger.client.ControllerServicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: auth
OAuth auth = (OAuth) defaultClient.getAuthentication("auth");
auth.setAccessToken("YOUR ACCESS TOKEN");

ControllerServicesApi apiInstance = new ControllerServicesApi();
String id = "id_example"; // String | The controller service id.
String propertyName = "propertyName_example"; // String | The property name to return the descriptor for.
try {
    PropertyDescriptorEntity result = apiInstance.getPropertyDescriptor(id, propertyName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerServicesApi#getPropertyDescriptor");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The controller service id.
propertyName	String	The property name to return the descriptor for.

Return type

PropertyDescriptorEntity

Authorization

auth

HTTP request headers

Content-Type: /
Accept: application/json

getState

ComponentStateEntity getState(id)

Gets the state for a controller service

Example

// Import classes:
//import com.github.hermannpencole.nifi.swagger.ApiClient;
//import com.github.hermannpencole.nifi.swagger.ApiException;
//import com.github.hermannpencole.nifi.swagger.Configuration;
//import com.github.hermannpencole.nifi.swagger.auth.*;
//import com.github.hermannpencole.nifi.swagger.client.ControllerServicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: auth
OAuth auth = (OAuth) defaultClient.getAuthentication("auth");
auth.setAccessToken("YOUR ACCESS TOKEN");

ControllerServicesApi apiInstance = new ControllerServicesApi();
String id = "id_example"; // String | The controller service id.
try {
    ComponentStateEntity result = apiInstance.getState(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerServicesApi#getState");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The controller service id.

Return type

ComponentStateEntity

Authorization

auth

HTTP request headers

Content-Type: /
Accept: application/json

removeControllerService

ControllerServiceEntity removeControllerService(id, version, clientId)

Deletes a controller service

Example

// Import classes:
//import com.github.hermannpencole.nifi.swagger.ApiClient;
//import com.github.hermannpencole.nifi.swagger.ApiException;
//import com.github.hermannpencole.nifi.swagger.Configuration;
//import com.github.hermannpencole.nifi.swagger.auth.*;
//import com.github.hermannpencole.nifi.swagger.client.ControllerServicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: auth
OAuth auth = (OAuth) defaultClient.getAuthentication("auth");
auth.setAccessToken("YOUR ACCESS TOKEN");

ControllerServicesApi apiInstance = new ControllerServicesApi();
String id = "id_example"; // String | The controller service id.
String version = "version_example"; // String | The revision is used to verify the client is working with the latest version of the flow.
String clientId = "clientId_example"; // String | If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
try {
    ControllerServiceEntity result = apiInstance.removeControllerService(id, version, clientId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerServicesApi#removeControllerService");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The controller service id.
version	String	The revision is used to verify the client is working with the latest version of the flow.	[optional]
clientId	String	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.	[optional]

Return type

ControllerServiceEntity

Authorization

auth

HTTP request headers

Content-Type: /
Accept: application/json

updateControllerService

ControllerServiceEntity updateControllerService(id, body)

Updates a controller service

Example

// Import classes:
//import com.github.hermannpencole.nifi.swagger.ApiClient;
//import com.github.hermannpencole.nifi.swagger.ApiException;
//import com.github.hermannpencole.nifi.swagger.Configuration;
//import com.github.hermannpencole.nifi.swagger.auth.*;
//import com.github.hermannpencole.nifi.swagger.client.ControllerServicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: auth
OAuth auth = (OAuth) defaultClient.getAuthentication("auth");
auth.setAccessToken("YOUR ACCESS TOKEN");

ControllerServicesApi apiInstance = new ControllerServicesApi();
String id = "id_example"; // String | The controller service id.
ControllerServiceEntity body = new ControllerServiceEntity(); // ControllerServiceEntity | The controller service configuration details.
try {
    ControllerServiceEntity result = apiInstance.updateControllerService(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerServicesApi#updateControllerService");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The controller service id.
body	ControllerServiceEntity	The controller service configuration details.

Return type

ControllerServiceEntity

Authorization

auth

HTTP request headers

Content-Type: application/json
Accept: application/json

updateControllerServiceReferences

ControllerServiceReferencingComponentsEntity updateControllerServiceReferences(id, body)

Updates a controller services references

Example

// Import classes:
//import com.github.hermannpencole.nifi.swagger.ApiClient;
//import com.github.hermannpencole.nifi.swagger.ApiException;
//import com.github.hermannpencole.nifi.swagger.Configuration;
//import com.github.hermannpencole.nifi.swagger.auth.*;
//import com.github.hermannpencole.nifi.swagger.client.ControllerServicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: auth
OAuth auth = (OAuth) defaultClient.getAuthentication("auth");
auth.setAccessToken("YOUR ACCESS TOKEN");

ControllerServicesApi apiInstance = new ControllerServicesApi();
String id = "id_example"; // String | The controller service id.
UpdateControllerServiceReferenceRequestEntity body = new UpdateControllerServiceReferenceRequestEntity(); // UpdateControllerServiceReferenceRequestEntity | The controller service request update request.
try {
    ControllerServiceReferencingComponentsEntity result = apiInstance.updateControllerServiceReferences(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerServicesApi#updateControllerServiceReferences");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The controller service id.
body	UpdateControllerServiceReferenceRequestEntity	The controller service request update request.

Return type

ControllerServiceReferencingComponentsEntity

Authorization

auth

HTTP request headers

Content-Type: application/json
Accept: application/json

Files

ControllerServicesApi.md

Latest commit

History

ControllerServicesApi.md

File metadata and controls

ControllerServicesApi

clearState

Example

Parameters

Return type

Authorization

HTTP request headers

getControllerService

Example

Parameters

Return type

Authorization

HTTP request headers

getControllerServiceReferences

Example

Parameters

Return type

Authorization

HTTP request headers

getPropertyDescriptor

Example

Parameters

Return type

Authorization

HTTP request headers

getState

Example

Parameters

Return type

Authorization

HTTP request headers

removeControllerService

Example

Parameters

Return type

Authorization

HTTP request headers

updateControllerService

Example

Parameters

Return type

Authorization

HTTP request headers

updateControllerServiceReferences

Example

Parameters

Return type

Authorization

HTTP request headers