Package com.cumulocity.sdk.client.event

Interface EventBinaryApi

All Known Implementing Classes:

EventBinaryApiImpl

public interface EventBinaryApi

API to perform operations to create, retrieve and delete event binaries. One event can store only one file.

Method Summary

Modifier and Type	Method	Description
void	createEventBinary(String id, byte[] bytes)	Upload a file (binary) with content-type of "application/octet-stream" (default) to given event ID.
void	deleteEventBinary(String id)	Remove stored file from given event ID.
InputStream	getEventBinary(String id)	Download a stored file from given event ID.
void	updateEventBinary(String id, byte[] bytes)	Replace the attached file (binary) to given event ID.

Method Details

getEventBinary

InputStream getEventBinary(String id)
                    throws SDKException

Download a stored file from given event ID.

Parameters:

id - ID of event

Returns:

file (binary)

Throws:

SDKException - if download fails

createEventBinary

void createEventBinary(String id,
 byte[] bytes)
                throws SDKException

Upload a file (binary) with content-type of "application/octet-stream" (default) to given event ID.

Parameters:

id - ID of event

bytes - file (binary) to be uploaded

Throws:

SDKException - if upload fails

updateEventBinary

void updateEventBinary(String id,
 byte[] bytes)
                throws SDKException

Replace the attached file (binary) to given event ID.

Parameters:

id - ID of event

bytes - file (binary) to be uploaded

Throws:

SDKException - if upload fails

deleteEventBinary

void deleteEventBinary(String id)
                throws SDKException

Remove stored file from given event ID.

Parameters:

id - ID of event

Throws:

SDKException - if delete fails