org.ovirt.engine.sdk.decorators

Class Jobs

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<Job,Jobs,Job>

org.ovirt.engine.sdk.decorators.Jobs

public class Jobs
extends CollectionDecorator<Job,Jobs,Job>

Jobs providing relation and functional services

to Jobs.

Constructor Summary

Constructors

Constructor and Description
Jobs(HttpProxyBroker proxy)

Method Summary

Modifier and Type	Method and Description
Job	add(Job job) Adds Job object.
Job	add(Job job, String expect) Adds Job object.
Job	add(Job job, String expect, String correlationId) Adds Job object.
Job	get(UUID id) Fetches Job object by id.
Job	getById(String id) Fetches Job object by id.
List<Job>	list() Lists Job objects.
List<Job>	list(Integer max) Lists Job 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

Jobs

public Jobs(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

list

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

Lists Job objects.

Specified by:

list in class CollectionDecorator<Job,Jobs,Job>

Returns:

List of Job

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 Job get(UUID id)
        throws org.apache.http.client.ClientProtocolException,
               ServerException,
               IOException

Fetches Job object by id.

Specified by:

get in class CollectionDecorator<Job,Jobs,Job>

Parameters:

id - entity id

Returns:

Job

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 Job getById(String id)
            throws org.apache.http.client.ClientProtocolException,
                   ServerException,
                   IOException

Fetches Job object by id.

Specified by:

getById in class CollectionDecorator<Job,Jobs,Job>

Parameters:

id - entity id

Returns:

Job

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<Job> list(Integer max)
               throws org.apache.http.client.ClientProtocolException,
                      ServerException,
                      IOException

Lists Job objects.

Parameters:

max -

    [max results]
    

Returns:

List of Job

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 Job add(Job job)
        throws org.apache.http.client.ClientProtocolException,
               ServerException,
               IOException

Adds Job object.

Parameters:

job - Job

    job.description
    [job.auto_cleared]
    

Returns:

Job

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 Job add(Job job,
               String expect)
        throws org.apache.http.client.ClientProtocolException,
               ServerException,
               IOException

Adds Job object.

Parameters:

job - Job

    job.description
    [job.auto_cleared]
    

expect -

    [201-created]
    

Returns:

Job

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 Job add(Job job,
               String expect,
               String correlationId)
        throws org.apache.http.client.ClientProtocolException,
               ServerException,
               IOException

Adds Job object.

Parameters:

job - Job

    job.description
    [job.auto_cleared]
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

Job

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.