Apache NiFi Registry REST API

REST API definition for Apache NiFi Registry web services

OpenAPI spec version: 2.6.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

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

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

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

Parameters:

  • body (Bucket) – The bucket to create (required)

  • preserve_source_properties (bool) – Whether source properties like identifier should be kept

Returns:

The response data.

Return type:

Bucket

create_bucket_with_http_info(body, **kwargs)[source]

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

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

Parameters:

  • body (Bucket) – The bucket to create (required)

  • preserve_source_properties (bool) – Whether source properties like identifier should be kept

Returns:

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

Return type:

tuple

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 and returns the response data directly.

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

Parameters:

  • version (LongParameter) – 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 (ClientIdParameter) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

Returns:

The response data.

Return type:

Bucket

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 and returns detailed response information.

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

Parameters:

  • version (LongParameter) – 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 (ClientIdParameter) – 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, status_code, headers) - Response data with HTTP details.

Return type:

tuple

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 and returns the response data directly.

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

Args:

Returns:

The response data.

Return type:

Fields

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 and returns detailed response information.

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

Args:

Returns:

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

Return type:

tuple

get_bucket(bucket_id, **kwargs)[source]

Get bucket.

Gets the bucket with the given id.

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

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

Parameters:

bucket_id (str) – The bucket identifier (required)

Returns:

The response data.

Return type:

Bucket

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 and returns detailed response information.

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

Parameters:

bucket_id (str) – The bucket identifier (required)

Returns:

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

Return type:

tuple

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 and returns the response data directly.

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

Args:

Returns:

The response data.

Return type:

list[Bucket]

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 and returns detailed response information.

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

Args:

Returns:

(list[Bucket], status_code, headers) - Response data with HTTP details.

Return type:

tuple

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

Update bucket.

Updates the bucket with the given id.

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

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

Parameters:

  • body (Bucket) – The updated bucket (required)

  • bucket_id (str) – The bucket identifier (required)

Returns:

The response data.

Return type:

Bucket

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

Update bucket.

Updates the bucket with the given id.

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

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

Parameters:

  • body (Bucket) – The updated bucket (required)

  • bucket_id (str) – The bucket identifier (required)

Returns:

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

Return type:

tuple