org.ovirt.engine.sdk.decorators

Class ExternalHostProviders

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<ExternalHostProvider,ExternalHostProviders,ExternalHostProvider>

org.ovirt.engine.sdk.decorators.ExternalHostProviders

public class ExternalHostProviders
extends CollectionDecorator<ExternalHostProvider,ExternalHostProviders,ExternalHostProvider>

ExternalHostProviders providing relation and functional services

to ExternalHostProviders.

Constructor Summary

Constructors

Constructor and Description
ExternalHostProviders(HttpProxyBroker proxy)

Method Summary

Methods

Modifier and Type	Method and Description
ExternalHostProvider	add(ExternalHostProvider externalhostprovider) Adds ExternalHostProvider object.
ExternalHostProvider	add(ExternalHostProvider externalhostprovider, String correlationId) Adds ExternalHostProvider object.
ExternalHostProvider	add(ExternalHostProvider externalhostprovider, String correlationId, String expect) Adds ExternalHostProvider object.
ExternalHostProvider	get(UUID id) Fetches ExternalHostProvider object by id.
ExternalHostProvider	getById(String id) Fetches ExternalHostProvider object by id.
List<ExternalHostProvider>	list() Lists ExternalHostProvider objects.
List<ExternalHostProvider>	list(Integer max) Lists ExternalHostProvider objects.

Methods inherited from class org.ovirt.engine.sdk.common.CollectionDecorator

get

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalHostProviders

public ExternalHostProviders(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

list

public List<ExternalHostProvider> list()
                                throws org.apache.http.client.ClientProtocolException,
                                       ServerException,
                                       IOException

Lists ExternalHostProvider objects.

Specified by:

list in class CollectionDecorator<ExternalHostProvider,ExternalHostProviders,ExternalHostProvider>

Returns:

List of ExternalHostProvider

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

get

public ExternalHostProvider get(UUID id)
                         throws org.apache.http.client.ClientProtocolException,
                                ServerException,
                                IOException

Fetches ExternalHostProvider object by id.

Specified by:

get in class CollectionDecorator<ExternalHostProvider,ExternalHostProviders,ExternalHostProvider>

Parameters:

id - entity id

Returns:

ExternalHostProvider

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

getById

public ExternalHostProvider getById(String id)
                             throws org.apache.http.client.ClientProtocolException,
                                    ServerException,
                                    IOException

Fetches ExternalHostProvider object by id.

Specified by:

getById in class CollectionDecorator<ExternalHostProvider,ExternalHostProviders,ExternalHostProvider>

Parameters:

id - entity id

Returns:

ExternalHostProvider

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

add

public ExternalHostProvider add(ExternalHostProvider externalhostprovider)
                         throws org.apache.http.client.ClientProtocolException,
                                ServerException,
                                IOException

Adds ExternalHostProvider object.

Parameters:

externalhostprovider - ExternalHostProvider

    external_host_provider.name
    [external_host_provider.description]
    [external_host_provider.url]
    [external_host_provider.requires_authentication]
    [external_host_provider.username]
    [external_host_provider.password]
    

Returns:

ExternalHostProvider

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

add

public ExternalHostProvider add(ExternalHostProvider externalhostprovider,
                       String correlationId)
                         throws org.apache.http.client.ClientProtocolException,
                                ServerException,
                                IOException

Adds ExternalHostProvider object.

Parameters:

externalhostprovider - ExternalHostProvider

    external_host_provider.name
    [external_host_provider.description]
    [external_host_provider.url]
    [external_host_provider.requires_authentication]
    [external_host_provider.username]
    [external_host_provider.password]
    

correlationId -

    [any string]
    

Returns:

ExternalHostProvider

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

add

public ExternalHostProvider add(ExternalHostProvider externalhostprovider,
                       String correlationId,
                       String expect)
                         throws org.apache.http.client.ClientProtocolException,
                                ServerException,
                                IOException

Adds ExternalHostProvider object.

Parameters:

externalhostprovider - ExternalHostProvider

    external_host_provider.name
    [external_host_provider.description]
    [external_host_provider.url]
    [external_host_provider.requires_authentication]
    [external_host_provider.username]
    [external_host_provider.password]
    

correlationId -

    [any string]
    

expect -

    [201-created]
    

Returns:

ExternalHostProvider

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

list

public List<ExternalHostProvider> list(Integer max)
                                throws org.apache.http.client.ClientProtocolException,
                                       ServerException,
                                       IOException

Lists ExternalHostProvider objects.

Parameters:

max -

    [max results]
    

Returns:

List of ExternalHostProvider

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.