CollectionsClient

All Implemented Interfaces:


public final class CollectionsClient

Client that allows you to work with collections.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Either<StreamError, CollectionData>`	`add(CollectionData collectionData)`	Add a new Collection with the given data.
`final Either<StreamError, CollectionData>`	`get(String collectionName, String collectionId)`	Get a collection by the collectionName and collectionId.
`final Either<StreamError, CollectionData>`	`update(CollectionData collectionData)`	Update an already existing collection with the new data.
`final Either<StreamError, Unit>`	`delete(String collectionName, String collectionId)`	Delete a collection by the collectionName and collectionId.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - add
```
 final Either<StreamError, CollectionData> add(CollectionData collectionData)
```
    Add a new Collection with the given data.
    
    Parameters:
    
    collectionData - The collection to be added.
  - get
```
 final Either<StreamError, CollectionData> get(String collectionName, String collectionId)
```
    Get a collection by the collectionName and collectionId.
    
    Parameters:
    
    collectionName - The collection name of the expected Collection.
    
    collectionId - The collection id of the expected Collection.
  - update
```
 final Either<StreamError, CollectionData> update(CollectionData collectionData)
```
    Update an already existing collection with the new data.
    
    Parameters:
    
    collectionData - The collection data to be updated.
  - delete
```
 final Either<StreamError, Unit> delete(String collectionName, String collectionId)
```
    Delete a collection by the collectionName and collectionId.
    
    Parameters:
    
    collectionName - The collection name of the Collection to be deleted.
    
    collectionId - The collection id of the Collection to be deleted.