com.siemens.mindsphere.sdk.iotfileservices.apiclient

Class FileServiceClient

Object

MindsphereAPIClient

FileServiceClient

public class FileServiceClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileServiceClient.ClientBuilder

Nested classes/interfaces inherited from class MindsphereAPIClient

MindsphereAPIClient.Builder<T extends MindsphereAPIClient.Builder<T>>

Field Summary

Fields inherited from class MindsphereAPIClient

credentials, restClientConfig, restTemplate

Constructor Summary

Constructors

Constructor and Description
FileServiceClient(FileServiceClient.ClientBuilder builder)

Method Summary

Modifier and Type	Method and Description
void	abortMultiPartUpload(PutFileRequest request) Abort a multi part file upload.
static FileServiceClient.ClientBuilder	builder()
void	completeMultiPartUpload(PutFileRequest request) Complete a multi part file upload.
void	createMultiPartFile(PutFileRequest request) Create a new multi part file upload.
void	deleteFile(DeleteFileRequest requestObject) delete a file Delete a file for the specified entity and path.
void	deleteFile(String entityId, String filepath) delete a file Delete a file for the specified entity and path.
byte[]	getFile(GetFileRequest requestObject) read a file Read a file for the specified entity and path
byte[]	getFile(String entityId, String filepath, Integer ifNoneMatch) read a file Read a file for the specified entity and path
byte[]	getFile(String entityId, String filepath, Integer ifNoneMatch, String range) read a file Read a file for the specified entity and path
List<Fileslist>	getFileList(GetFileListRequest requestObject) list multi part uploads List multi part uploads
List<Fileslist>	getFileList(String entityId, String filepath) list multi part uploads List multi part uploads
void	initiateMultiPartUpload(PutFileRequest request) Initiate a multi part file upload.
void	putFile(byte[] file, String entityId, String filepath, Integer part, String upload, Integer ifMatch, String timestamp, String description, String type) write a file Create or update a file for the specified entity and path, with the provided content.
void	putFile(byte[] file, String entityId, String filepath, Integer ifMatch, String timestamp, String description, String type) write a file Create or update a file for the specified entity and path, with the provided content.
void	putFile(PutFileRequest requestObject) write a file Create or update a file for the specified entity and path, with the provided content.
List<FileResponse>	searchFiles(SearchFilesRequest requestObject) search files Search files for the specified entity.
List<FileResponse>	searchFiles(String entityId, BigDecimal offset, Integer limit, Boolean count, String order, String filter) search files Search files for the specified entity.
void	updateMultiPartFile(PutFileRequest request) Update an existing multi part file upload.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileServiceClient

public FileServiceClient(FileServiceClient.ClientBuilder builder)

Method Detail

builder

public static FileServiceClient.ClientBuilder builder()

deleteFile

public void deleteFile(DeleteFileRequest requestObject)
                throws MindsphereException

delete a file Delete a file for the specified entity and path.

204 - deleted

401 - unauthorized

404 - not found

0 - unexpected error

Parameters:

requestObject - - Object of type DeleteFileRequest {Parameters are entityId*,filepath*}

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

getFile

public byte[] getFile(GetFileRequest requestObject)
               throws MindsphereException

read a file Read a file for the specified entity and path

200 - file content

206 - Partial Content of the file

304 - not modfied

401 - unauthorized

404 - not found

416 - Range Not Satisfiable

0 - unexpected error

Parameters:

requestObject - - Object of type GetFileRequest {Parameters are entityId*,filepath*,If-None-Match,range}

Returns:

byte[]

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

getFileList

public List<Fileslist> getFileList(GetFileListRequest requestObject)
                            throws MindsphereException

list multi part uploads List multi part uploads

200 - multi part list

400 - bad request

401 - unauthorized

404 - not found

0 - unexpected error

Parameters:

requestObject - - Object of type GetFileListRequest {Parameters are entityId*,filepath*}

Returns:

List<Fileslist>

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

putFile

public void putFile(PutFileRequest requestObject)
             throws MindsphereException

write a file Create or update a file for the specified entity and path, with the provided content.

201 - created

204 - updated

400 - bad request

401 - unauthorized

404 - not found

409 - conflict

0 - Unexpected error

Parameters:

requestObject - - Object of type PutFileRequest {Parameters are file*,entityId*,filepath*,part,upload,If-Match,timestamp,description,type}

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

searchFiles

public List<FileResponse> searchFiles(SearchFilesRequest requestObject)
                               throws MindsphereException

search files Search files for the specified entity.

200 - successful operation

400 - bad request

401 - unauthorized

0 - unexpected error

Parameters:

requestObject - - Object of type SearchFilesRequest {Parameters are entityId*,offset,limit,count,order,filter}

Returns:

List<FileResponse>

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

deleteFile

public void deleteFile(String entityId,
                       String filepath)
                throws MindsphereException

delete a file Delete a file for the specified entity and path.

204 - deleted

401 - unauthorized

404 - not found

0 - unexpected error

Parameters:

entityId - unique identifier of the entity

filepath - unique identifier of the file

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

getFile

public byte[] getFile(String entityId,
                      String filepath,
                      Integer ifNoneMatch)
               throws MindsphereException

read a file Read a file for the specified entity and path

200 - file content

206 - Partial Content of the file

304 - not modfied

401 - unauthorized

404 - not found

416 - Range Not Satisfiable

0 - unexpected error

Parameters:

entityId - Id to instance of entity

filepath - path of the file along with filename

ifNoneMatch - ETag of the latest version (not supported in this release)

Returns:

byte[]

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

getFile

public byte[] getFile(String entityId,
                      String filepath,
                      Integer ifNoneMatch,
                      String range)
               throws MindsphereException

read a file Read a file for the specified entity and path

200 - file content

206 - Partial Content of the file

304 - not modfied

401 - unauthorized

404 - not found

416 - Range Not Satisfiable

0 - unexpected error

Parameters:

entityId - Id to instance of entity

filepath - path of the file along with filename

ifNoneMatch - ETag of the latest version (not supported in this release)

range - Part of a file to return in Bytes, eg bytes=200-600

Returns:

byte[]

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

getFileList

public List<Fileslist> getFileList(String entityId,
                                   String filepath)
                            throws MindsphereException

list multi part uploads List multi part uploads

200 - multi part list

400 - bad request

401 - unauthorized

404 - not found

0 - unexpected error

Parameters:

entityId - Id to instance of entity

filepath - path of the file

Returns:

List<Fileslist>

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

putFile

public void putFile(byte[] file,
                    String entityId,
                    String filepath,
                    Integer part,
                    String upload,
                    Integer ifMatch,
                    String timestamp,
                    String description,
                    String type)
             throws MindsphereException

write a file Create or update a file for the specified entity and path, with the provided content.

201 - created

204 - updated

400 - bad request

401 - unauthorized

404 - not found

409 - conflict

0 - Unexpected error

Parameters:

file - the file attached content

entityId - unique identifier of the entity

filepath - url path of the file along with filename

part - Part number to upload

upload - Upload status to start, complete, and abort multi-part uploads

ifMatch - ETag of the latest version for optimistic locking

timestamp - file timestamp

description - description of the file

type - type of the file

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

searchFiles

public List<FileResponse> searchFiles(String entityId,
                                      BigDecimal offset,
                                      Integer limit,
                                      Boolean count,
                                      String order,
                                      String filter)
                               throws MindsphereException

search files Search files for the specified entity.

200 - successful operation

400 - bad request

401 - unauthorized

0 - unexpected error

Parameters:

entityId - entity instance id

offset - number of files to skip

limit - maximum number of files to return (max 200)

count - return total number of matching files

order - sort based on supported fields - see order syntax for more details (name, path, type, size, timestamp, created, updated)

filter - filter based on supported fields - see filter syntax for more details (name, path, type, size, timestamp, created, updated)

Returns:

List<FileResponse>

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

putFile

public void putFile(byte[] file,
                    String entityId,
                    String filepath,
                    Integer ifMatch,
                    String timestamp,
                    String description,
                    String type)
             throws MindsphereException

write a file Create or update a file for the specified entity and path, with the provided content.

201 - created

204 - updated

400 - bad request

401 - unauthorized

404 - not found

409 - conflict

0 - Unexpected error

Parameters:

file - the file attached content

entityId - unique identifier of the entity

filepath - url path of the file along with filename

ifMatch - ETag of the latest version for optimistic locking

timestamp - file timestamp

description - description of the file

type - type of the file

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

initiateMultiPartUpload

public void initiateMultiPartUpload(PutFileRequest request)
                             throws MindsphereException

Initiate a multi part file upload. Used to initiate new multi part file upload and re-initiate an existing multi part file uploads.

Parameters:

request - PutFileRequest object with entity id and filepath as mandatory parameters. IfMatch value need to be passed for re-initiation of an existing multi part file upload.

Throws:

MindsphereException - thrown if an error occurs while attempting to invoke the API

createMultiPartFile

public void createMultiPartFile(PutFileRequest request)
                         throws MindsphereException

Create a new multi part file upload.

Parameters:

request - PutFileRequest object with file, part, entity id and filepath as mandatory parameters.

Throws:

MindsphereException - thrown if an error occurs while attempting to invoke the API

updateMultiPartFile

public void updateMultiPartFile(PutFileRequest request)
                         throws MindsphereException

Update an existing multi part file upload.

Parameters:

request - PutFileRequest object with file, part, ifMatch, entity id and filepath as mandatory parameters.

Throws:

MindsphereException - thrown if an error occurs while attempting to invoke the API

completeMultiPartUpload

public void completeMultiPartUpload(PutFileRequest request)
                             throws MindsphereException

Complete a multi part file upload. Used to complete both new and existing multi part file uploads.

Parameters:

request - PutFileRequest object with entity id and filepath as mandatory parameters. IfMatch value needs to be passed if an existing Multi part File Upload is being completed.

Throws:

MindsphereException - thrown if an error occurs while attempting to invoke the API

abortMultiPartUpload

public void abortMultiPartUpload(PutFileRequest request)
                          throws MindsphereException

Abort a multi part file upload. Used to abort both new and existing multi part file uploads.

Parameters:

request - PutFileRequest object with entity id and filepath as mandatory parameters. IfMatch value needs to be passed if an existing Multi part File Upload is being aborted.

Throws:

MindsphereException - thrown if an error occurs while attempting to invoke the API