com.siemens.mindsphere.sdk.iot.asset.apiclient

Class AssetFileClient

Object

MindsphereAPIClient

AssetFileClient

public class AssetFileClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AssetFileClient.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	AssetFileClient(AssetFileClient.ClientBuilder builder)

Method Summary

Modifier and Type	Method and Description
static AssetFileClient.ClientBuilder	builder()
AssetFiles	getAssetFiles() Get metadata of uploaded files.
AssetFiles	getAssetFiles(Integer page, Integer size) Get metadata of uploaded files.
AssetFiles	getAssetFiles(Integer page, Integer size, String sort, String filter, String ifNoneMatch) Get metadata of uploaded files.
AssetFiles	getAssetFiles(String sort, String filter) Get metadata of uploaded files.
String	getFileContentById(String fileId) Returns a file by its id
FileMetadataResource	getFileMetadataById(String fileId) Returns a file's metadata by its id
FileMetadataResource	getFileMetadataById(String fileId, String ifNoneMatch) Returns a file's metadata by its id
FileMetadataResource	uploadAssetFiles(File file, String name) Upload files to be used in Asset Management.
FileMetadataResource	uploadAssetFiles(File file, String name, String description) Upload files to be used in Asset Management.

Methods inherited from class Object

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

Constructor Detail

AssetFileClient

protected AssetFileClient(AssetFileClient.ClientBuilder builder)

Method Detail

builder

public static AssetFileClient.ClientBuilder builder()

uploadAssetFiles

public FileMetadataResource uploadAssetFiles(File file,
                                             String name,
                                             String description)
                                      throws MindsphereException

Upload files to be used in Asset Management. * Uploaded files are only visible for the uploader tenant. * Max file size is 5 MB.

201 - File has been successfully uploaded

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

500 - Server error, for more information see errorcode and message

Parameters:

file - The file to upload. The file size cannot be more than 5 MB.

name - The name of the file

description - The description of the file

Returns:

FileMetadataResource

Throws:

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

uploadAssetFiles

public FileMetadataResource uploadAssetFiles(File file,
                                             String name)
                                      throws MindsphereException

Upload files to be used in Asset Management. * Uploaded files are only visible for the uploader tenant. * Max file size is 5 MB.

201 - File has been successfully uploaded

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

500 - Server error, for more information see errorcode and message

Parameters:

file - The file to upload. The file size cannot be more than 5 MB.

name - The name of the file

Returns:

FileMetadataResource

Throws:

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

getAssetFiles

public AssetFiles getAssetFiles(Integer page,
                                Integer size,
                                String sort,
                                String filter,
                                String ifNoneMatch)
                         throws MindsphereException

Get metadata of uploaded files. Returns all visible file metadata for the tenant. Will NOT return the files.

200 - Metadata of files visible for the tenant

304 - Resource have not been modified

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

500 - Server error, for more information see errorcode and message

Parameters:

page - Specifies the requested page index

size - Specifies the number of elements in a page

sort - Specifies the ordering of returned elements

filter - Specifies the additional filtering criteria, e.g. "{\"name\":\"file_name\"}" or as an encoded string, "%7B%22name%22:%22file_name%22%7D"

ifNoneMatch - ETag hash of previous request to allow caching

Returns:

AssetFiles

Throws:

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

getAssetFiles

public AssetFiles getAssetFiles()
                         throws MindsphereException

Get metadata of uploaded files. Returns all visible file metadata for the tenant. Will NOT return the files.

200 - Metadata of files visible for the tenant

304 - Resource have not been modified

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

500 - Server error, for more information see errorcode and message

Returns:

AssetFiles

Throws:

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

getAssetFiles

public AssetFiles getAssetFiles(Integer page,
                                Integer size)
                         throws MindsphereException

Get metadata of uploaded files. Returns all visible file metadata for the tenant. Will NOT return the files.

200 - Metadata of files visible for the tenant

304 - Resource have not been modified

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

500 - Server error, for more information see errorcode and message

Parameters:

page - Specifies the requested page index

size - Specifies the number of elements in a page

Returns:

AssetFiles

Throws:

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

getAssetFiles

public AssetFiles getAssetFiles(String sort,
                                String filter)
                         throws MindsphereException

Get metadata of uploaded files. Returns all visible file metadata for the tenant. Will NOT return the files.

200 - Metadata of files visible for the tenant

304 - Resource have not been modified

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

500 - Server error, for more information see errorcode and message

Parameters:

sort - Specifies the ordering of returned elements

filter - Specifies the additional filtering criteria, e.g. "{\"name\":\"file_name\"}" or as an encoded string, "%7B%22name%22:%22file_name%22%7D"

Returns:

AssetFiles

Throws:

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

getFileContentById

public String getFileContentById(String fileId)
                          throws MindsphereException

Returns a file by its id

200 - Returns the file

401 - User is not authenticated

403 - User is not authorized for request

404 - File not found

406 - The resource cannot be represented in the format that would be acceptable to the user agent

500 - Server error, for more information see errorcode and message

Parameters:

fileId - Unique identifier of the file.

Returns:

File

Throws:

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

getFileMetadataById

public FileMetadataResource getFileMetadataById(String fileId,
                                                String ifNoneMatch)
                                         throws MindsphereException

Returns a file's metadata by its id

200 - Returns the file's metadata

304 - Resource have not been modified

401 - User is not authenticated

403 - User is not authorized for request

404 - File not found

500 - Server error, for more information see errorcode and message

Parameters:

fileId - Unique identifier of the file.

ifNoneMatch - ETag hash of previous request to allow caching

Returns:

FileMetadataResource

Throws:

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

getFileMetadataById

public FileMetadataResource getFileMetadataById(String fileId)
                                         throws MindsphereException

Returns a file's metadata by its id

200 - Returns the file's metadata

304 - Resource have not been modified

401 - User is not authenticated

403 - User is not authorized for request

404 - File not found

500 - Server error, for more information see errorcode and message

Parameters:

fileId - Unique identifier of the file.

Returns:

FileMetadataResource

Throws:

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