com.siemens.mindsphere.sdk.assetmanagement.apiclient

Class FilesClient

Object

MindsphereAPIClient

FilesClient

public class FilesClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static FilesClient.ClientBuilder	builder()
void	deleteFile(DeleteFileRequest requestObject) Delete a file.
void	deleteFile(String ifMatch, String fileId) Delete a file.
byte[]	downloadFile(DownloadFileRequest requestObject) Returns a file by its id Returns a file by its id
byte[]	downloadFile(String fileId) Returns a file by its id Returns a file by its id
FileMetadataResource	getFile(GetFileRequest requestObject) Returns a file's metadata by its id Returns a file's metadata by its id
FileMetadataResource	getFile(String fileId, String ifNoneMatch) Returns a file's metadata by its id Returns a file's metadata by its id
FileMetadataListResource	listFiles(Integer page, Integer size, String sort, String filter, String ifNoneMatch) Get metadata of uploaded files.
FileMetadataListResource	listFiles(ListFilesRequest requestObject) Get metadata of uploaded files.
FileMetadataResource	replaceFile(ReplaceFileRequest requestObject) Update a file Update a previously uploaded file * Max file size is 5 MB.
FileMetadataResource	replaceFile(String ifMatch, String fileId, File file, String name, String scope, String description) Update a file Update a previously uploaded file * Max file size is 5 MB.
FileMetadataResource	uploadFile(File file, String name, String scope, String description) Upload files to be used in Asset Management.
FileMetadataResource	uploadFile(UploadFileRequest requestObject) 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

FilesClient

public FilesClient(FilesClient.ClientBuilder builder)

Method Detail

builder

public static FilesClient.ClientBuilder builder()

deleteFile

public void deleteFile(DeleteFileRequest requestObject)
                throws MindsphereException

Delete a file. * Deletion is blocked if there are any file assignment with the given fileId.

204 - File has been successfully deleted

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - File not found

412 - File changed in the background

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

Parameters:

requestObject - - Object of type DeleteFileRequest {Parameters are If-Match*,fileId*}

Throws:

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

downloadFile

public byte[] downloadFile(DownloadFileRequest requestObject)
                    throws MindsphereException

Returns a file by its id 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:

requestObject - - Object of type DownloadFileRequest {Parameters are fileId*}

Returns:

byte[]

Throws:

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

getFile

public FileMetadataResource getFile(GetFileRequest requestObject)
                             throws MindsphereException

Returns a file's metadata by its id 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:

requestObject - - Object of type GetFileRequest {Parameters are fileId*,If-None-Match}

Returns:

FileMetadataResource

Throws:

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

listFiles

public FileMetadataListResource listFiles(ListFilesRequest requestObject)
                                   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:

requestObject - - Object of type ListFilesRequest {Parameters are page,size,sort,filter,If-None-Match}

Returns:

FileMetadataListResource

Throws:

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

replaceFile

public FileMetadataResource replaceFile(ReplaceFileRequest requestObject)
                                 throws MindsphereException

Update a file Update a previously uploaded file * Max file size is 5 MB.

200 - File has been successfully updated

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - File not found

412 - File is changed in the background

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

Parameters:

requestObject - - Object of type ReplaceFileRequest {Parameters are If-Match*,fileId*,file*,name*,scope*,description}

Returns:

FileMetadataResource

Throws:

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

uploadFile

public FileMetadataResource uploadFile(UploadFileRequest requestObject)
                                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:

requestObject - - Object of type UploadFileRequest {Parameters are file*,name*,scope,description}

Returns:

FileMetadataResource

Throws:

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

deleteFile

public void deleteFile(String ifMatch,
                       String fileId)
                throws MindsphereException

Delete a file. * Deletion is blocked if there are any file assignment with the given fileId.

204 - File has been successfully deleted

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - File not found

412 - File changed in the background

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

Parameters:

ifMatch - Last known version to facilitate optimistic locking

fileId - Unique identifier of the file.

Throws:

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

downloadFile

public byte[] downloadFile(String fileId)
                    throws MindsphereException

Returns a file by its id 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:

byte[]

Throws:

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

getFile

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

Returns a file's metadata by its id 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

listFiles

public FileMetadataListResource listFiles(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

ifNoneMatch - ETag hash of previous request to allow caching

Returns:

FileMetadataListResource

Throws:

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

replaceFile

public FileMetadataResource replaceFile(String ifMatch,
                                        String fileId,
                                        File file,
                                        String name,
                                        String scope,
                                        String description)
                                 throws MindsphereException

Update a file Update a previously uploaded file * Max file size is 5 MB.

200 - File has been successfully updated

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - File not found

412 - File is changed in the background

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

Parameters:

ifMatch - Last known version to facilitate optimistic locking

fileId - Unique identifier of the file.

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

name - The name of the file

scope - The scope of the file

description - The description of the file

Returns:

FileMetadataResource

Throws:

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

uploadFile

public FileMetadataResource uploadFile(File file,
                                       String name,
                                       String scope,
                                       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

scope - The scope of the file

description - The description of the file

Returns:

FileMetadataResource

Throws:

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