org.ovirt.engine.sdk.decorators

Class JobSteps

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<Step,Steps,JobStep>

org.ovirt.engine.sdk.decorators.JobSteps

public class JobSteps
extends CollectionDecorator<Step,Steps,JobStep>

JobSteps providing relation and functional services

to Steps.

Constructor Summary

Constructors

Constructor and Description
JobSteps(HttpProxyBroker proxy, Job parent)

Method Summary

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

JobSteps

public JobSteps(HttpProxyBroker proxy,
                Job parent)

Parameters:

proxy - HttpProxyBroker

parent - Job

Method Detail

list

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

Lists JobStep objects.

Specified by:

list in class CollectionDecorator<Step,Steps,JobStep>

Returns:

List of JobStep

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

Fetches JobStep object by id.

Specified by:

get in class CollectionDecorator<Step,Steps,JobStep>

Parameters:

id - entity id

Returns:

JobStep

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

Fetches JobStep object by id.

Specified by:

getById in class CollectionDecorator<Step,Steps,JobStep>

Parameters:

id - entity id

Returns:

JobStep

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

Lists JobStep objects.

Parameters:

max -

    [max results]
    

Returns:

List of JobStep

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

Adds Step object.

Parameters:

step - Step

    step.type
    step.description
    [step.job.id]
    [step.parent_step.id]
    

Returns:

JobStep

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

Adds Step object.

Parameters:

step - Step

    step.type
    step.description
    [step.job.id]
    [step.parent_step.id]
    

expect -

    [201-created]
    

Returns:

JobStep

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

Adds Step object.

Parameters:

step - Step

    step.type
    step.description
    [step.job.id]
    [step.parent_step.id]
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

JobStep

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.