Package org.ovirt.engine.sdk4.services
Interface FilesService.ListRequest
-
- All Superinterfaces:
Request<FilesService.ListRequest,FilesService.ListResponse>
- Enclosing interface:
- FilesService
public static interface FilesService.ListRequest extends Request<FilesService.ListRequest,FilesService.ListResponse>
Returns the list of ISO images and virtual floppy disks available in the storage domain. The order of the returned list is not guaranteed. If the `refresh` parameter is `false`, the returned list may not reflect recent changes to the storage domain; for example, it may not contain a new ISO file that was recently added. This is because the server caches the list of files to improve performance. To get the very latest results, set the `refresh` parameter to `true`. The default value of the `refresh` parameter is `true`, but it can be changed using the configuration value `ForceRefreshDomainFilesByDefault`: [source] ---- # engine-config -s ForceRefreshDomainFilesByDefault=false ---- IMPORTANT: Setting the value of the `refresh` parameter to `true` has an impact on the performance of the server. Use it only if necessary.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description FilesService.ListRequest
caseSensitive(Boolean caseSensitive)
Indicates if the search performed using the `search` parameter should take case into account.FilesService.ListRequest
follow(String follow)
Indicates which inner links should be _followed_.FilesService.ListRequest
max(Integer max)
Sets the maximum number of files to return.FilesService.ListRequest
max(Long max)
Sets the maximum number of files to return.FilesService.ListRequest
max(BigInteger max)
Sets the maximum number of files to return.FilesService.ListRequest
refresh(Boolean refresh)
Indicates whether the list of files should be refreshed from the storage domain, rather than showing cached results that are updated at certain intervals.FilesService.ListRequest
search(String search)
A query string used to restrict the returned files.
-
-
-
Method Detail
-
caseSensitive
FilesService.ListRequest caseSensitive(Boolean caseSensitive)
Indicates if the search performed using the `search` parameter should take case into account. The default value is `true`.
-
follow
FilesService.ListRequest follow(String follow)
Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part of the current request. See <> for details.
-
max
FilesService.ListRequest max(Integer max)
Sets the maximum number of files to return. If not specified, all the files are returned.
-
max
FilesService.ListRequest max(Long max)
Sets the maximum number of files to return. If not specified, all the files are returned.
-
max
FilesService.ListRequest max(BigInteger max)
Sets the maximum number of files to return. If not specified, all the files are returned.
-
refresh
FilesService.ListRequest refresh(Boolean refresh)
Indicates whether the list of files should be refreshed from the storage domain, rather than showing cached results that are updated at certain intervals.
-
search
FilesService.ListRequest search(String search)
A query string used to restrict the returned files.
-
-