Apache NiFi REST API

REST API definition for Apache NiFi web services

OpenAPI spec version: 2.7.2 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.policies_api.PoliciesApi(api_client=None)[source]

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

__init__(api_client=None)[source]
create_access_policy(body, **kwargs)[source]

Creates an access policy. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding create_access_policy_with_http_info() method instead.

Parameters:

body (AccessPolicyEntity) – The access policy configuration details. (required)

Returns:

The response data.

Return type:

AccessPolicyEntity

create_access_policy_with_http_info(body, **kwargs)[source]

Creates an access policy. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding create_access_policy() method instead.

Parameters:

body (AccessPolicyEntity) – The access policy configuration details. (required)

Returns:

(AccessPolicyEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_access_policy(id, **kwargs)[source]

Gets an access policy. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_access_policy_with_http_info() method instead.

Parameters:

id (str) – The access policy id. (required)

Returns:

The response data.

Return type:

AccessPolicyEntity

get_access_policy_for_resource(action, resource, **kwargs)[source]

Gets an access policy for the specified action and resource.

Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_access_policy_for_resource_with_http_info() method instead.

Parameters:

  • action (str) – The request action. (required)

  • resource (str) – The resource of the policy. (required)

Returns:

The response data.

Return type:

AccessPolicyEntity

get_access_policy_for_resource_with_http_info(action, resource, **kwargs)[source]

Gets an access policy for the specified action and resource.

Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_access_policy_for_resource() method instead.

Parameters:

  • action (str) – The request action. (required)

  • resource (str) – The resource of the policy. (required)

Returns:

(AccessPolicyEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_access_policy_with_http_info(id, **kwargs)[source]

Gets an access policy. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_access_policy() method instead.

Parameters:

id (str) – The access policy id. (required)

Returns:

(AccessPolicyEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

remove_access_policy(id, **kwargs)[source]

Deletes an access policy. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding remove_access_policy_with_http_info() method instead.

Parameters:

  • id (str) – The access policy id. (required)

  • version (LongParameter) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (ClientIdParameter) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

The response data.

Return type:

AccessPolicyEntity

remove_access_policy_with_http_info(id, **kwargs)[source]

Deletes an access policy. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding remove_access_policy() method instead.

Parameters:

  • id (str) – The access policy id. (required)

  • version (LongParameter) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (ClientIdParameter) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

(AccessPolicyEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

update_access_policy(body, id, **kwargs)[source]

Updates a access policy. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding update_access_policy_with_http_info() method instead.

Parameters:

  • body (AccessPolicyEntity) – The access policy configuration details. (required)

  • id (str) – The access policy id. (required)

Returns:

The response data.

Return type:

AccessPolicyEntity

update_access_policy_with_http_info(body, id, **kwargs)[source]

Updates a access policy. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding update_access_policy() method instead.

Parameters:

  • body (AccessPolicyEntity) – The access policy configuration details. (required)

  • id (str) – The access policy id. (required)

Returns:

(AccessPolicyEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple