Package org.ovirt.engine.sdk4.services

Interface VmsService.ListRequest

All Superinterfaces:

Request<VmsService.ListRequest,VmsService.ListResponse>

Enclosing interface:

VmsService

public static interface VmsService.ListRequest
extends Request<VmsService.ListRequest,VmsService.ListResponse>

Returns the list of virtual machines of the system. The order of the returned list of virtual machines is guaranteed only if the `sortby` clause is included in the `search` parameter.

Method Summary

Modifier and Type	Method	Description
VmsService.ListRequest	allContent(Boolean allContent)	Indicates if all the attributes of the virtual machines should be included in the response.
VmsService.ListRequest	caseSensitive(Boolean caseSensitive)	Indicates if the search performed using the `search` parameter should be performed taking case into account.
VmsService.ListRequest	filter(Boolean filter)	Indicates if the results should be filtered according to the permissions of the user.
VmsService.ListRequest	follow(String follow)	Indicates which inner links should be _followed_.
VmsService.ListRequest	max(Integer max)	The maximum number of results to return.
VmsService.ListRequest	max(Long max)	The maximum number of results to return.
VmsService.ListRequest	max(BigInteger max)	The maximum number of results to return.
VmsService.ListRequest	ovfAsOva(Boolean ovfAsOva)	Indicates if the results should expose the OVF as it appears in OVA files of that VM.
VmsService.ListRequest	search(String search)	A query string used to restrict the returned virtual machines.

Methods inherited from interface org.ovirt.engine.sdk4.Request

header, query, send

Method Detail

allContent

VmsService.ListRequest allContent(Boolean allContent)

Indicates if all the attributes of the virtual machines should be included in the response. By default the following attributes are excluded: - `console` - `initialization.configuration.data` - The OVF document describing the virtual machine. - `rng_source` - `soundcard` - `virtio_scsi` For example, to retrieve the complete representation of the virtual machines send a request like this: .... GET /ovirt-engine/api/vms?all_content=true .... NOTE: The reason for not including these attributes is performance: they are seldom used and they require additional queries to the database. So try to use the this parameter only when it is really needed.

caseSensitive

VmsService.ListRequest caseSensitive(Boolean caseSensitive)

Indicates if the search performed using the `search` parameter should be performed taking case into account. The default value is `true`, which means that case is taken into account. If you want to search ignoring case set it to `false`.

filter

VmsService.ListRequest filter(Boolean filter)

Indicates if the results should be filtered according to the permissions of the user.

follow

VmsService.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

VmsService.ListRequest max(Integer max)

The maximum number of results to return.

max

VmsService.ListRequest max(Long max)

The maximum number of results to return.

max

VmsService.ListRequest max(BigInteger max)

The maximum number of results to return.

ovfAsOva

VmsService.ListRequest ovfAsOva(Boolean ovfAsOva)

Indicates if the results should expose the OVF as it appears in OVA files of that VM. The OVF document describing the virtual machine. This parameter will work only when all_content=True is set. The OVF will be presented in `initialization.configuration.data`. For example: [source] ---- GET /vms?all_content=true&ovf_as_ova=true ----

search

VmsService.ListRequest search(String search)

A query string used to restrict the returned virtual machines.