Package com.merge.api.resources.filestorage.files

Class FilesClient

java.lang.Object

com.merge.api.resources.filestorage.files.FilesClient

public class FilesClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
FilesClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
FileStorageFileResponse	create(FileStorageFileEndpointRequest request)	Creates a File object with the given values.
FileStorageFileResponse	create(FileStorageFileEndpointRequest request, RequestOptions requestOptions)	Creates a File object with the given values.
java.io.InputStream	downloadRetrieve(java.lang.String id)	Returns the File content with the given id as a stream of bytes.
java.io.InputStream	downloadRetrieve(java.lang.String id, FilesDownloadRetrieveRequest request)	Returns the File content with the given id as a stream of bytes.
java.io.InputStream	downloadRetrieve(java.lang.String id, FilesDownloadRetrieveRequest request, RequestOptions requestOptions)	Returns the File content with the given id as a stream of bytes.
PaginatedFileList	list()	Returns a list of File objects.
PaginatedFileList	list(FilesListRequest request)	Returns a list of File objects.
PaginatedFileList	list(FilesListRequest request, RequestOptions requestOptions)	Returns a list of File objects.
MetaResponse	metaPostRetrieve()	Returns metadata for FileStorageFile POSTs.
MetaResponse	metaPostRetrieve(RequestOptions requestOptions)	Returns metadata for FileStorageFile POSTs.
File	retrieve(java.lang.String id)	Returns a File object with the given id.
File	retrieve(java.lang.String id, FilesRetrieveRequest request)	Returns a File object with the given id.
File	retrieve(java.lang.String id, FilesRetrieveRequest request, RequestOptions requestOptions)	Returns a File object with the given id.

Methods inherited from class java.lang.Object

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

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

FilesClient

public FilesClient(ClientOptions clientOptions)

Method Detail

list

public PaginatedFileList list()

Returns a list of File objects.

list

public PaginatedFileList list(FilesListRequest request)

Returns a list of File objects.

list

public PaginatedFileList list(FilesListRequest request,
                              RequestOptions requestOptions)

Returns a list of File objects.

create

public FileStorageFileResponse create(FileStorageFileEndpointRequest request)

Creates a File object with the given values.

create

public FileStorageFileResponse create(FileStorageFileEndpointRequest request,
                                      RequestOptions requestOptions)

Creates a File object with the given values.

retrieve

public File retrieve(java.lang.String id)

Returns a File object with the given id.

retrieve

public File retrieve(java.lang.String id,
                     FilesRetrieveRequest request)

Returns a File object with the given id.

retrieve

public File retrieve(java.lang.String id,
                     FilesRetrieveRequest request,
                     RequestOptions requestOptions)

Returns a File object with the given id.

downloadRetrieve

public java.io.InputStream downloadRetrieve(java.lang.String id)

Returns the File content with the given id as a stream of bytes.

downloadRetrieve

public java.io.InputStream downloadRetrieve(java.lang.String id,
                                            FilesDownloadRetrieveRequest request)

Returns the File content with the given id as a stream of bytes.

downloadRetrieve

public java.io.InputStream downloadRetrieve(java.lang.String id,
                                            FilesDownloadRetrieveRequest request,
                                            RequestOptions requestOptions)

Returns the File content with the given id as a stream of bytes.

metaPostRetrieve

public MetaResponse metaPostRetrieve()

Returns metadata for FileStorageFile POSTs.

metaPostRetrieve

public MetaResponse metaPostRetrieve(RequestOptions requestOptions)

Returns metadata for FileStorageFile POSTs.