Package org.ovirt.engine.sdk4.services

Interface SystemOptionService

All Superinterfaces:

Service

All Known Implementing Classes:

SystemOptionServiceImpl

public interface SystemOptionService
extends Service

A service that provides values of specific configuration option of the system.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SystemOptionService.GetRequest	Get the values of specific configuration option.
static interface	SystemOptionService.GetResponse	Get the values of specific configuration option.

Method Summary

Modifier and Type	Method	Description
SystemOptionService.GetRequest	get()	Get the values of specific configuration option.
Service	service(String path)	Service locator method, returns individual service on which the URI is dispatched.

Method Detail

get

SystemOptionService.GetRequest get()

Get the values of specific configuration option. For example to retrieve the values of configuration option `MigrationPoliciesSupported` send a request like this: [source] ---- GET /ovirt-engine/api/options/MigrationPoliciesSupported ---- The response to that request will be the following: [source,xml] ---- MigrationPoliciesSupported true 4.0 true 4.1 true 4.2 false 3.6 ---- NOTE: The appropriate permissions are required to query configuration options. Some options can be queried only by users with administrator permissions. [IMPORTANT] ==== There is NO backward compatibility and no guarantee about the names or values of the options. Options may be removed and their meaning can be changed at any point. We strongly discourage the use of this service for applications other than the ones that are released simultaneously with the engine. Usage by other applications is not supported. Therefore there will be no documentation listing accessible configuration options. ====

service

Service service(String path)

Service locator method, returns individual service on which the URI is dispatched.