nipyapi.registry.apis package

Submodules

nipyapi.registry.apis.access_api module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.apis.access_api.AccessApi(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

create_access_token_by_trying_all_providers(**kwargs)[source]

Create token trying all providers Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format ‘Authorization: Bearer <token>’. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_by_trying_all_providers(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:str If the method is called asynchronously, returns the request thread.
create_access_token_by_trying_all_providers_with_http_info(**kwargs)[source]

Create token trying all providers Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format ‘Authorization: Bearer <token>’. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_by_trying_all_providers_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:str If the method is called asynchronously, returns the request thread.
create_access_token_using_basic_auth_credentials(**kwargs)[source]

Create token using basic auth Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: ‘Authorization: Basic <credentials>’, where <credentials> is the base64 encoded value of ‘<username>:<password>’. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format ‘Authorization: Bearer <token>’. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_using_basic_auth_credentials(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:str If the method is called asynchronously, returns the request thread.
create_access_token_using_basic_auth_credentials_with_http_info(**kwargs)[source]

Create token using basic auth Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: ‘Authorization: Basic <credentials>’, where <credentials> is the base64 encoded value of ‘<username>:<password>’. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format ‘Authorization: Bearer <token>’. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_using_basic_auth_credentials_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:str If the method is called asynchronously, returns the request thread.
create_access_token_using_identity_provider_credentials(**kwargs)[source]

Create token using identity provider Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by ‘GET /access/token/identity-provider/usage’. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format ‘Authorization: Bearer <token>’. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_using_identity_provider_credentials(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:str If the method is called asynchronously, returns the request thread.
create_access_token_using_identity_provider_credentials_with_http_info(**kwargs)[source]

Create token using identity provider Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by ‘GET /access/token/identity-provider/usage’. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format ‘Authorization: Bearer <token>’. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_using_identity_provider_credentials_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:str If the method is called asynchronously, returns the request thread.
create_access_token_using_kerberos_ticket(**kwargs)[source]

Create token using kerberos Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format ‘Authorization: Bearer <token>’. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_using_kerberos_ticket(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:str If the method is called asynchronously, returns the request thread.
create_access_token_using_kerberos_ticket_with_http_info(**kwargs)[source]

Create token using kerberos Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format ‘Authorization: Bearer <token>’. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_using_kerberos_ticket_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:str If the method is called asynchronously, returns the request thread.
get_access_status(**kwargs)[source]

Get access status Returns the current client’s authenticated identity and permissions to top-level resources This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_status(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:CurrentUser If the method is called asynchronously, returns the request thread.
get_access_status_with_http_info(**kwargs)[source]

Get access status Returns the current client’s authenticated identity and permissions to top-level resources This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_status_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:CurrentUser If the method is called asynchronously, returns the request thread.
get_identity_provider_usage_instructions(**kwargs)[source]

Get identity provider usage Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_identity_provider_usage_instructions(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:str If the method is called asynchronously, returns the request thread.
get_identity_provider_usage_instructions_with_http_info(**kwargs)[source]

Get identity provider usage Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_identity_provider_usage_instructions_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:str If the method is called asynchronously, returns the request thread.
log_out(**kwargs)[source]
Performs a logout for other providers that have been issued a JWT.
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.log_out(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:None If the method is called asynchronously, returns the request thread.
log_out_with_http_info(**kwargs)[source]
Performs a logout for other providers that have been issued a JWT.
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.log_out_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:None If the method is called asynchronously, returns the request thread.
oidc_callback(**kwargs)[source]
Redirect/callback URI for processing the result of the OpenId Connect login sequence.
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.oidc_callback(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:None If the method is called asynchronously, returns the request thread.
oidc_callback_with_http_info(**kwargs)[source]
Redirect/callback URI for processing the result of the OpenId Connect login sequence.
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.oidc_callback_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:None If the method is called asynchronously, returns the request thread.
oidc_exchange(**kwargs)[source]
Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.oidc_exchange(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:str If the method is called asynchronously, returns the request thread.
oidc_exchange_with_http_info(**kwargs)[source]
Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.oidc_exchange_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:str If the method is called asynchronously, returns the request thread.
oidc_logout(**kwargs)[source]
Performs a logout in the OpenId Provider.
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.oidc_logout(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:None If the method is called asynchronously, returns the request thread.
oidc_logout_with_http_info(**kwargs)[source]
Performs a logout in the OpenId Provider.
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.oidc_logout_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:None If the method is called asynchronously, returns the request thread.
oidc_request(**kwargs)[source]
Initiates a request to authenticate through the configured OpenId Connect provider.
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.oidc_request(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:None If the method is called asynchronously, returns the request thread.
oidc_request_with_http_info(**kwargs)[source]
Initiates a request to authenticate through the configured OpenId Connect provider.
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.oidc_request_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:None If the method is called asynchronously, returns the request thread.
test_identity_provider_recognizes_credentials_format(**kwargs)[source]

Test identity provider Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by ‘GET /access/token/identity-provider/usage’. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.test_identity_provider_recognizes_credentials_format(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:str If the method is called asynchronously, returns the request thread.
test_identity_provider_recognizes_credentials_format_with_http_info(**kwargs)[source]

Test identity provider Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by ‘GET /access/token/identity-provider/usage’. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.test_identity_provider_recognizes_credentials_format_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:str If the method is called asynchronously, returns the request thread.

nipyapi.registry.apis.bucket_flows_api module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.apis.bucket_flows_api.BucketFlowsApi(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

create_flow(bucket_id, body, **kwargs)[source]

Create flow Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_flow(bucket_id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • body (VersionedFlow) – The details of the flow to create. (required)
Returns:

VersionedFlow If the method is called asynchronously, returns the request thread.

create_flow_version(bucket_id, flow_id, body, **kwargs)[source]

Create flow version Creates the next version of a flow. The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_flow_version(bucket_id, flow_id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
  • body (VersionedFlowSnapshot) – The new versioned flow snapshot. (required)
Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

create_flow_version_with_http_info(bucket_id, flow_id, body, **kwargs)[source]

Create flow version Creates the next version of a flow. The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_flow_version_with_http_info(bucket_id, flow_id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
  • body (VersionedFlowSnapshot) – The new versioned flow snapshot. (required)
Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

create_flow_with_http_info(bucket_id, body, **kwargs)[source]

Create flow Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_flow_with_http_info(bucket_id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • body (VersionedFlow) – The details of the flow to create. (required)
Returns:

VersionedFlow If the method is called asynchronously, returns the request thread.

delete_flow(version, bucket_id, flow_id, **kwargs)[source]

Delete bucket flow Deletes a flow, including all saved versions of that flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_flow(version, bucket_id, flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • version (str) – The version is used to verify the client is working with the latest version of the entity. (required)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
Returns:

VersionedFlow If the method is called asynchronously, returns the request thread.

delete_flow_with_http_info(version, bucket_id, flow_id, **kwargs)[source]

Delete bucket flow Deletes a flow, including all saved versions of that flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_flow_with_http_info(version, bucket_id, flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • version (str) – The version is used to verify the client is working with the latest version of the entity. (required)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
Returns:

VersionedFlow If the method is called asynchronously, returns the request thread.

export_versioned_flow(bucket_id, flow_id, version_number, **kwargs)[source]

Exports specified bucket flow version content Exports the specified version of a flow, including the metadata and content of the flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.export_versioned_flow(bucket_id, flow_id, version_number, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
  • version_number (int) – The version number (required)
Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

export_versioned_flow_with_http_info(bucket_id, flow_id, version_number, **kwargs)[source]

Exports specified bucket flow version content Exports the specified version of a flow, including the metadata and content of the flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.export_versioned_flow_with_http_info(bucket_id, flow_id, version_number, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
  • version_number (int) – The version number (required)
Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

get_flow(bucket_id, flow_id, **kwargs)[source]

Get bucket flow Retrieves the flow with the given id in the given bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow(bucket_id, flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
Returns:

VersionedFlow If the method is called asynchronously, returns the request thread.

get_flow_diff(bucket_id, flow_id, version_a, version_b, **kwargs)[source]

Get bucket flow diff Computes the differences between two given versions of a flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_diff(bucket_id, flow_id, version_a, version_b, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
  • version_a (int) – The first version number (required)
  • version_b (int) – The second version number (required)
Returns:

VersionedFlowDifference If the method is called asynchronously, returns the request thread.

get_flow_diff_with_http_info(bucket_id, flow_id, version_a, version_b, **kwargs)[source]

Get bucket flow diff Computes the differences between two given versions of a flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_diff_with_http_info(bucket_id, flow_id, version_a, version_b, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
  • version_a (int) – The first version number (required)
  • version_b (int) – The second version number (required)
Returns:

VersionedFlowDifference If the method is called asynchronously, returns the request thread.

get_flow_version(bucket_id, flow_id, version_number, **kwargs)[source]

Get bucket flow version Gets the given version of a flow, including the metadata and content for the version. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_version(bucket_id, flow_id, version_number, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
  • version_number (int) – The version number (required)
Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

get_flow_version_with_http_info(bucket_id, flow_id, version_number, **kwargs)[source]

Get bucket flow version Gets the given version of a flow, including the metadata and content for the version. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_version_with_http_info(bucket_id, flow_id, version_number, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
  • version_number (int) – The version number (required)
Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

get_flow_versions(bucket_id, flow_id, **kwargs)[source]

Get bucket flow versions Gets summary information for all versions of a flow. Versions are ordered newest->oldest. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_versions(bucket_id, flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
Returns:

list[VersionedFlowSnapshotMetadata] If the method is called asynchronously, returns the request thread.

get_flow_versions_with_http_info(bucket_id, flow_id, **kwargs)[source]

Get bucket flow versions Gets summary information for all versions of a flow. Versions are ordered newest->oldest. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_versions_with_http_info(bucket_id, flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
Returns:

list[VersionedFlowSnapshotMetadata] If the method is called asynchronously, returns the request thread.

get_flow_with_http_info(bucket_id, flow_id, **kwargs)[source]

Get bucket flow Retrieves the flow with the given id in the given bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_with_http_info(bucket_id, flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
Returns:

VersionedFlow If the method is called asynchronously, returns the request thread.

get_flows(bucket_id, **kwargs)[source]

Get bucket flows Retrieves all flows in the given bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flows(bucket_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
Returns:

list[VersionedFlow] If the method is called asynchronously, returns the request thread.

get_flows_with_http_info(bucket_id, **kwargs)[source]

Get bucket flows Retrieves all flows in the given bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flows_with_http_info(bucket_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
Returns:

list[VersionedFlow] If the method is called asynchronously, returns the request thread.

get_latest_flow_version(bucket_id, flow_id, **kwargs)[source]

Get latest bucket flow version content Gets the latest version of a flow, including the metadata and content of the flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_latest_flow_version(bucket_id, flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

get_latest_flow_version_metadata(bucket_id, flow_id, **kwargs)[source]

Get latest bucket flow version metadata Gets the metadata for the latest version of a flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_latest_flow_version_metadata(bucket_id, flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
Returns:

VersionedFlowSnapshotMetadata If the method is called asynchronously, returns the request thread.

get_latest_flow_version_metadata_with_http_info(bucket_id, flow_id, **kwargs)[source]

Get latest bucket flow version metadata Gets the metadata for the latest version of a flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_latest_flow_version_metadata_with_http_info(bucket_id, flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
Returns:

VersionedFlowSnapshotMetadata If the method is called asynchronously, returns the request thread.

get_latest_flow_version_with_http_info(bucket_id, flow_id, **kwargs)[source]

Get latest bucket flow version content Gets the latest version of a flow, including the metadata and content of the flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_latest_flow_version_with_http_info(bucket_id, flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

import_versioned_flow(bucket_id, flow_id, **kwargs)[source]

Import flow version Import the next version of a flow. The version number of the object being created will be the next available version integer. Flow versions are immutable after they are created. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.import_versioned_flow(bucket_id, flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
  • body (VersionedFlowSnapshot) – file
  • comments (str) –
Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

import_versioned_flow_with_http_info(bucket_id, flow_id, **kwargs)[source]

Import flow version Import the next version of a flow. The version number of the object being created will be the next available version integer. Flow versions are immutable after they are created. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.import_versioned_flow_with_http_info(bucket_id, flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
  • body (VersionedFlowSnapshot) – file
  • comments (str) –
Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

update_flow(bucket_id, flow_id, body, **kwargs)[source]

Update bucket flow Updates the flow with the given id in the given bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_flow(bucket_id, flow_id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
  • body (VersionedFlow) – The updated flow (required)
Returns:

VersionedFlow If the method is called asynchronously, returns the request thread.

update_flow_with_http_info(bucket_id, flow_id, body, **kwargs)[source]

Update bucket flow Updates the flow with the given id in the given bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_flow_with_http_info(bucket_id, flow_id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • flow_id (str) – The flow identifier (required)
  • body (VersionedFlow) – The updated flow (required)
Returns:

VersionedFlow If the method is called asynchronously, returns the request thread.

nipyapi.registry.apis.buckets_api module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.apis.buckets_api.BucketsApi(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

create_bucket(body, **kwargs)[source]

Create bucket

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_bucket(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • body (Bucket) – The bucket to create (required)
Returns:

Bucket If the method is called asynchronously, returns the request thread.

create_bucket_with_http_info(body, **kwargs)[source]

Create bucket

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_bucket_with_http_info(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • body (Bucket) – The bucket to create (required)
Returns:

Bucket If the method is called asynchronously, returns the request thread.

delete_bucket(version, bucket_id, **kwargs)[source]

Delete bucket Deletes the bucket with the given id, along with all objects stored in the bucket This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_bucket(version, bucket_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • version (str) – The version is used to verify the client is working with the latest version of the entity. (required)
  • bucket_id (str) – The bucket identifier (required)
  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
Returns:

Bucket If the method is called asynchronously, returns the request thread.

delete_bucket_with_http_info(version, bucket_id, **kwargs)[source]

Delete bucket Deletes the bucket with the given id, along with all objects stored in the bucket This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_bucket_with_http_info(version, bucket_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • version (str) – The version is used to verify the client is working with the latest version of the entity. (required)
  • bucket_id (str) – The bucket identifier (required)
  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
Returns:

Bucket If the method is called asynchronously, returns the request thread.

get_available_bucket_fields(**kwargs)[source]

Get bucket fields Retrieves bucket field names for searching or sorting on buckets. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_available_bucket_fields(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:Fields If the method is called asynchronously, returns the request thread.
get_available_bucket_fields_with_http_info(**kwargs)[source]

Get bucket fields Retrieves bucket field names for searching or sorting on buckets. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_available_bucket_fields_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:Fields If the method is called asynchronously, returns the request thread.
get_bucket(bucket_id, **kwargs)[source]

Get bucket Gets the bucket with the given id. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_bucket(bucket_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
Returns:

Bucket If the method is called asynchronously, returns the request thread.

get_bucket_with_http_info(bucket_id, **kwargs)[source]

Get bucket Gets the bucket with the given id. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_bucket_with_http_info(bucket_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
Returns:

Bucket If the method is called asynchronously, returns the request thread.

get_buckets(**kwargs)[source]

Get all buckets The returned list will include only buckets for which the user is authorized.If the user is not authorized for any buckets, this returns an empty list. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_buckets(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:list[Bucket] If the method is called asynchronously, returns the request thread.
get_buckets_with_http_info(**kwargs)[source]

Get all buckets The returned list will include only buckets for which the user is authorized.If the user is not authorized for any buckets, this returns an empty list. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_buckets_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:list[Bucket] If the method is called asynchronously, returns the request thread.
update_bucket(bucket_id, body, **kwargs)[source]

Update bucket Updates the bucket with the given id. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_bucket(bucket_id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • body (Bucket) – The updated bucket (required)
Returns:

Bucket If the method is called asynchronously, returns the request thread.

update_bucket_with_http_info(bucket_id, body, **kwargs)[source]

Update bucket Updates the bucket with the given id. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_bucket_with_http_info(bucket_id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
  • body (Bucket) – The updated bucket (required)
Returns:

Bucket If the method is called asynchronously, returns the request thread.

nipyapi.registry.apis.flows_api module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.apis.flows_api.FlowsApi(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

get_available_flow_fields(**kwargs)[source]

Get flow fields Retrieves the flow field names that can be used for searching or sorting on flows. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_available_flow_fields(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:Fields If the method is called asynchronously, returns the request thread.
get_available_flow_fields_with_http_info(**kwargs)[source]

Get flow fields Retrieves the flow field names that can be used for searching or sorting on flows. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_available_flow_fields_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:Fields If the method is called asynchronously, returns the request thread.
global_get_flow(flow_id, **kwargs)[source]

Get flow Gets a flow by id. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.global_get_flow(flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • flow_id (str) – The flow identifier (required)
Returns:

VersionedFlow If the method is called asynchronously, returns the request thread.

global_get_flow_version(flow_id, version_number, **kwargs)[source]

Get flow version Gets the given version of a flow, including metadata and flow content. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.global_get_flow_version(flow_id, version_number, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • flow_id (str) – The flow identifier (required)
  • version_number (int) – The version number (required)
Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

global_get_flow_version_with_http_info(flow_id, version_number, **kwargs)[source]

Get flow version Gets the given version of a flow, including metadata and flow content. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.global_get_flow_version_with_http_info(flow_id, version_number, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • flow_id (str) – The flow identifier (required)
  • version_number (int) – The version number (required)
Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

global_get_flow_versions(flow_id, **kwargs)[source]

Get flow versions Gets summary information for all versions of a given flow. Versions are ordered newest->oldest. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.global_get_flow_versions(flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • flow_id (str) – The flow identifier (required)
Returns:

list[VersionedFlowSnapshotMetadata] If the method is called asynchronously, returns the request thread.

global_get_flow_versions_with_http_info(flow_id, **kwargs)[source]

Get flow versions Gets summary information for all versions of a given flow. Versions are ordered newest->oldest. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.global_get_flow_versions_with_http_info(flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • flow_id (str) – The flow identifier (required)
Returns:

list[VersionedFlowSnapshotMetadata] If the method is called asynchronously, returns the request thread.

global_get_flow_with_http_info(flow_id, **kwargs)[source]

Get flow Gets a flow by id. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.global_get_flow_with_http_info(flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • flow_id (str) – The flow identifier (required)
Returns:

VersionedFlow If the method is called asynchronously, returns the request thread.

global_get_latest_flow_version(flow_id, **kwargs)[source]

Get latest flow version Gets the latest version of a flow, including metadata and flow content. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.global_get_latest_flow_version(flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • flow_id (str) – The flow identifier (required)
Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

global_get_latest_flow_version_metadata(flow_id, **kwargs)[source]

Get latest flow version metadata Gets the metadata for the latest version of a flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.global_get_latest_flow_version_metadata(flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • flow_id (str) – The flow identifier (required)
Returns:

VersionedFlowSnapshotMetadata If the method is called asynchronously, returns the request thread.

global_get_latest_flow_version_metadata_with_http_info(flow_id, **kwargs)[source]

Get latest flow version metadata Gets the metadata for the latest version of a flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.global_get_latest_flow_version_metadata_with_http_info(flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • flow_id (str) – The flow identifier (required)
Returns:

VersionedFlowSnapshotMetadata If the method is called asynchronously, returns the request thread.

global_get_latest_flow_version_with_http_info(flow_id, **kwargs)[source]

Get latest flow version Gets the latest version of a flow, including metadata and flow content. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.global_get_latest_flow_version_with_http_info(flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • flow_id (str) – The flow identifier (required)
Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

nipyapi.registry.apis.items_api module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.apis.items_api.ItemsApi(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

get_available_bucket_item_fields(**kwargs)[source]

Get item fields Retrieves the item field names for searching or sorting on bucket items. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_available_bucket_item_fields(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:Fields If the method is called asynchronously, returns the request thread.
get_available_bucket_item_fields_with_http_info(**kwargs)[source]

Get item fields Retrieves the item field names for searching or sorting on bucket items. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_available_bucket_item_fields_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:Fields If the method is called asynchronously, returns the request thread.
get_items(**kwargs)[source]

Get all items Get items across all buckets. The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_items(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:list[BucketItem] If the method is called asynchronously, returns the request thread.
get_items_in_bucket(bucket_id, **kwargs)[source]

Get bucket items Gets the items located in the given bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_items_in_bucket(bucket_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
Returns:

list[BucketItem] If the method is called asynchronously, returns the request thread.

get_items_in_bucket_with_http_info(bucket_id, **kwargs)[source]

Get bucket items Gets the items located in the given bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_items_in_bucket_with_http_info(bucket_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • bucket_id (str) – The bucket identifier (required)
Returns:

list[BucketItem] If the method is called asynchronously, returns the request thread.

get_items_with_http_info(**kwargs)[source]

Get all items Get items across all buckets. The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_items_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:list[BucketItem] If the method is called asynchronously, returns the request thread.

nipyapi.registry.apis.policies_api module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.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

create_access_policy(body, **kwargs)[source]

Create access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_policy(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • body (AccessPolicy) – The access policy configuration details. (required)
Returns:

AccessPolicy If the method is called asynchronously, returns the request thread.

create_access_policy_with_http_info(body, **kwargs)[source]

Create access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_policy_with_http_info(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • body (AccessPolicy) – The access policy configuration details. (required)
Returns:

AccessPolicy If the method is called asynchronously, returns the request thread.

get_access_policies(**kwargs)[source]

Get all access policies

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_policies(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:list[AccessPolicy] If the method is called asynchronously, returns the request thread.
get_access_policies_with_http_info(**kwargs)[source]

Get all access policies

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_policies_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:list[AccessPolicy] If the method is called asynchronously, returns the request thread.
get_access_policy(id, **kwargs)[source]

Get access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_policy(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • id (str) – The access policy id. (required)
Returns:

AccessPolicy If the method is called asynchronously, returns the request thread.

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

Get access policy for resource Gets an access policy for the specified action and resource This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_policy_for_resource(action, resource, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • action (str) – The request action. (required)
  • resource (str) – The resource of the policy. (required)
Returns:

AccessPolicy If the method is called asynchronously, returns the request thread.

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

Get access policy for resource Gets an access policy for the specified action and resource This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_policy_for_resource_with_http_info(action, resource, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • action (str) – The request action. (required)
  • resource (str) – The resource of the policy. (required)
Returns:

AccessPolicy If the method is called asynchronously, returns the request thread.

get_access_policy_with_http_info(id, **kwargs)[source]

Get access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_policy_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • id (str) – The access policy id. (required)
Returns:

AccessPolicy If the method is called asynchronously, returns the request thread.

get_resources(**kwargs)[source]

Get available resources Gets the available resources that support access/authorization policies This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_resources(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:list[Resource] If the method is called asynchronously, returns the request thread.
get_resources_with_http_info(**kwargs)[source]

Get available resources Gets the available resources that support access/authorization policies This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_resources_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:list[Resource] If the method is called asynchronously, returns the request thread.
remove_access_policy(version, id, **kwargs)[source]

Delete access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_access_policy(version, id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • version (str) – The version is used to verify the client is working with the latest version of the entity. (required)
  • id (str) – The access policy id. (required)
  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
Returns:

AccessPolicy If the method is called asynchronously, returns the request thread.

remove_access_policy_with_http_info(version, id, **kwargs)[source]

Delete access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_access_policy_with_http_info(version, id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • version (str) – The version is used to verify the client is working with the latest version of the entity. (required)
  • id (str) – The access policy id. (required)
  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
Returns:

AccessPolicy If the method is called asynchronously, returns the request thread.

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

Update access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_access_policy(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • id (str) – The access policy id. (required)
  • body (AccessPolicy) – The access policy configuration details. (required)
Returns:

AccessPolicy If the method is called asynchronously, returns the request thread.

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

Update access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_access_policy_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • id (str) – The access policy id. (required)
  • body (AccessPolicy) – The access policy configuration details. (required)
Returns:

AccessPolicy If the method is called asynchronously, returns the request thread.

nipyapi.registry.apis.tenants_api module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.apis.tenants_api.TenantsApi(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

create_user(body, **kwargs)[source]
Create user
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_user(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • body (User) – The user configuration details. (required)
Returns:

User If the method is called asynchronously, returns the request thread.

create_user_group(body, **kwargs)[source]
Create user group
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_user_group(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • body (UserGroup) – The user group configuration details. (required)
Returns:

UserGroup If the method is called asynchronously, returns the request thread.

create_user_group_with_http_info(body, **kwargs)[source]
Create user group
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_user_group_with_http_info(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • body (UserGroup) – The user group configuration details. (required)
Returns:

UserGroup If the method is called asynchronously, returns the request thread.

create_user_with_http_info(body, **kwargs)[source]
Create user
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_user_with_http_info(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • body (User) – The user configuration details. (required)
Returns:

User If the method is called asynchronously, returns the request thread.

get_user(id, **kwargs)[source]
Get user
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_user(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • id (str) – The user id. (required)
Returns:

User If the method is called asynchronously, returns the request thread.

get_user_group(id, **kwargs)[source]
Get user group
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_user_group(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • id (str) – The user group id. (required)
Returns:

UserGroup If the method is called asynchronously, returns the request thread.

get_user_group_with_http_info(id, **kwargs)[source]
Get user group
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_user_group_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • id (str) – The user group id. (required)
Returns:

UserGroup If the method is called asynchronously, returns the request thread.

get_user_groups(**kwargs)[source]
Get user groups
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_user_groups(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:list[UserGroup] If the method is called asynchronously, returns the request thread.
get_user_groups_with_http_info(**kwargs)[source]
Get user groups
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_user_groups_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:list[UserGroup] If the method is called asynchronously, returns the request thread.
get_user_with_http_info(id, **kwargs)[source]
Get user
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_user_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • id (str) – The user id. (required)
Returns:

User If the method is called asynchronously, returns the request thread.

get_users(**kwargs)[source]
Get all users
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_users(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:list[User] If the method is called asynchronously, returns the request thread.
get_users_with_http_info(**kwargs)[source]
Get all users
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_users_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional)
Returns:list[User] If the method is called asynchronously, returns the request thread.
remove_user(version, id, **kwargs)[source]
Delete user
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_user(version, id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • version (str) – The version is used to verify the client is working with the latest version of the entity. (required)
  • id (str) – The user id. (required)
  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
Returns:

User If the method is called asynchronously, returns the request thread.

remove_user_group(version, id, **kwargs)[source]
Delete user group
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_user_group(version, id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • version (str) – The version is used to verify the client is working with the latest version of the entity. (required)
  • id (str) – The user group id. (required)
  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
Returns:

UserGroup If the method is called asynchronously, returns the request thread.

remove_user_group_with_http_info(version, id, **kwargs)[source]
Delete user group
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_user_group_with_http_info(version, id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • version (str) – The version is used to verify the client is working with the latest version of the entity. (required)
  • id (str) – The user group id. (required)
  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
Returns:

UserGroup If the method is called asynchronously, returns the request thread.

remove_user_with_http_info(version, id, **kwargs)[source]
Delete user
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_user_with_http_info(version, id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • version (str) – The version is used to verify the client is working with the latest version of the entity. (required)
  • id (str) – The user id. (required)
  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
Returns:

User If the method is called asynchronously, returns the request thread.

update_user(id, body, **kwargs)[source]
Update user
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_user(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • id (str) – The user id. (required)
  • body (User) – The user configuration details. (required)
Returns:

User If the method is called asynchronously, returns the request thread.

update_user_group(id, body, **kwargs)[source]
Update user group
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_user_group(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • id (str) – The user group id. (required)
  • body (UserGroup) – The user group configuration details. (required)
Returns:

UserGroup If the method is called asynchronously, returns the request thread.

update_user_group_with_http_info(id, body, **kwargs)[source]
Update user group
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_user_group_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • id (str) – The user group id. (required)
  • body (UserGroup) – The user group configuration details. (required)
Returns:

UserGroup If the method is called asynchronously, returns the request thread.

update_user_with_http_info(id, body, **kwargs)[source]
Update user
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_user_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • id (str) – The user id. (required)
  • body (User) – The user configuration details. (required)
Returns:

User If the method is called asynchronously, returns the request thread.