com.siemens.mindsphere.sdk.iot.fileservice.apiclient

Class FileservicesClient

Object

MindsphereAPIClient

FileservicesClient

public class FileservicesClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileservicesClient.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

Modifier	Constructor and Description
protected	FileservicesClient(FileservicesClient.ClientBuilder builder)

Method Summary

Modifier and Type	Method and Description
static FileservicesClient.ClientBuilder	builder()
FileWriterResponse	createFile(File file, String entityId, String filepath) write a file Create a file for the specified entity and path, with the provided content.
FileWriterResponse	createFile(File file, String entityId, String filepath, String description, String type) write a file Create a file for the specified entity and path, with the provided content.
boolean	deleteFile(String entityId, String filepath) delete a file Delete a file for the specified entity and path.
FileReaderResponse	readFile(String entityId, String filepath) read a file Read a file for the specified entity and path
FileReaderResponse	readFile(String entityId, String filepath, Integer ifNoneMatch) read a file Read a file for the specified entity and path
FileSearchResponse	searchFiles(String entityId) search files Search files for the specified entity.
FileSearchResponse	searchFiles(String entityId, Integer offset, Integer limit, Boolean count, String order, String filter) search files Search files for the specified entity.
FileWriterResponse	updateFile(File file, String entityId, String filepath, Integer ifMatch) write a file update a file for the specified entity and path, with the provided content.
FileWriterResponse	updateFile(File file, String entityId, String filepath, String description, String type, Integer ifMatch) write a file update a file for the specified entity and path, with the provided content.

Methods inherited from class Object

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

Constructor Detail

FileservicesClient

protected FileservicesClient(FileservicesClient.ClientBuilder builder)

Method Detail

builder

public static FileservicesClient.ClientBuilder builder()

createFile

public FileWriterResponse createFile(File file,
                                     String entityId,
                                     String filepath,
                                     String description,
                                     String type)
                              throws MindsphereException

write a file Create 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 - File to be written

entityId - entityId to which file belongs

filepath - path of the directory where file needs to be stored

description - description of the file

type - type of file

Returns:

FileWriterResponse response will have location of path where the file got stored and ETag

Throws:

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

createFile

public FileWriterResponse createFile(File file,
                                     String entityId,
                                     String filepath)
                              throws MindsphereException

write a file Create 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 - File to be written

entityId - entityId to which file belongs

filepath - path of the directory where file needs to be stored

Returns:

FileWriterResponse response will have location of path where the file got stored and ETag

Throws:

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

updateFile

public FileWriterResponse updateFile(File file,
                                     String entityId,
                                     String filepath,
                                     String description,
                                     String type,
                                     Integer ifMatch)
                              throws MindsphereException

write a file 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 - File to be written

entityId - entityId to which file belongs

filepath - path of the directory where file needs to be stored

description - description of the file

type - type of file

ifMatch - ETag of the latest version for optimistic locking

Returns:

FileWriterResponse response will have location of path where the file got stored and ETag

Throws:

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

updateFile

public FileWriterResponse updateFile(File file,
                                     String entityId,
                                     String filepath,
                                     Integer ifMatch)
                              throws MindsphereException

write a file 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 - File to be written

entityId - entityId to which file belongs

filepath - path of the directory where file needs to be stored

ifMatch - ETag of the latest version for optimistic locking

Returns:

FileWriterResponse response will have location of path where the file got stored and ETag

Throws:

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

readFile

public FileReaderResponse readFile(String entityId,
                                   String filepath)
                            throws MindsphereException

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

200 - file content

304 - not modfied

401 - unauthorized

404 - not found

0 - unexpected error

Parameters:

entityId - entityId to which file belongs

filepath - path of the directory where file needs to be stored

Returns:

FileReaderResponse response will contain contents of file, ETag and description of file

Throws:

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

searchFiles

public FileSearchResponse searchFiles(String entityId)
                               throws MindsphereException

search files Search files for the specified entity.

200 - successful operation

400 - bad request

401 - unauthorized

0 - unexpected error

Parameters:

entityId - entityId to which file belongs

Returns:

FileSearchResponse response will contain details of all the files matching the search criteria

Throws:

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

readFile

public FileReaderResponse readFile(String entityId,
                                   String filepath,
                                   Integer ifNoneMatch)
                            throws MindsphereException

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

200 - file content

304 - not modfied

401 - unauthorized

404 - not found

0 - unexpected error

Parameters:

entityId - entityId to which file belongs

filepath - path of the directory where file needs to be stored

ifNoneMatch - ETag of the latest version

Returns:

FileReaderResponse response will contain contents of file, ETag and description of file

Throws:

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

searchFiles

public FileSearchResponse searchFiles(String entityId,
                                      Integer 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) example: String filter = "name eq 'unitTest'" or String filter = "name%20eq%20'unitTest'"

Returns:

FileSearchResponse response will contain details of all the files matching the search criteria

Throws:

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

deleteFile

public boolean 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 - entityId to which file belongs

filepath - path of the directory where file needs to be stored

Returns:

boolean return true if file deleted successfully

Throws:

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