org.apache.nifi.registry.client

Interface BucketClient

All Known Implementing Classes:

JerseyBucketClient

public interface BucketClient

Client for interacting with buckets.

Method Summary

Modifier and Type	Method and Description
Bucket	create(Bucket bucket) Creates the given bucket.
Bucket	delete(String bucketId) Deletes the bucket with the given id.
Bucket	get(String bucketId) Gets the bucket with the given id.
List<Bucket>	getAll() Gets all buckets.
Fields	getFields() Gets the fields that can be used to sort/search buckets.
Bucket	update(Bucket bucket) Updates the given bucket.

Method Detail

create

Bucket create(Bucket bucket)
       throws NiFiRegistryException,
              IOException

Creates the given bucket.

Parameters:

bucket - the bucket to create

Returns:

the created bucket with containing identifier that was generated

Throws:

NiFiRegistryException

IOException

get

Bucket get(String bucketId)
    throws NiFiRegistryException,
           IOException

Gets the bucket with the given id.

Parameters:

bucketId - the id of the bucket to retrieve

Returns:

the bucket with the given id

Throws:

NiFiRegistryException

IOException

update

Bucket update(Bucket bucket)
       throws NiFiRegistryException,
              IOException

Updates the given bucket. Only the name and description can be updated.

Parameters:

bucket - the bucket with updates, must contain the id

Returns:

the updated bucket

Throws:

NiFiRegistryException

IOException

delete

Bucket delete(String bucketId)
       throws NiFiRegistryException,
              IOException

Deletes the bucket with the given id.

Parameters:

bucketId - the id of the bucket to delete

Returns:

the deleted bucket

Throws:

NiFiRegistryException

IOException

getFields

Fields getFields()
          throws NiFiRegistryException,
                 IOException

Gets the fields that can be used to sort/search buckets.

Returns:

the bucket fields

Throws:

NiFiRegistryException

IOException

getAll

List<Bucket> getAll()
             throws NiFiRegistryException,
                    IOException

Gets all buckets.

Returns:

the list of all buckets

Throws:

NiFiRegistryException

IOException