org.ovirt.engine.sdk.decorators

Class VMSnapshots

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<Snapshot,Snapshots,VMSnapshot>

org.ovirt.engine.sdk.decorators.VMSnapshots

public class VMSnapshots
extends CollectionDecorator<Snapshot,Snapshots,VMSnapshot>

VMSnapshots providing relation and functional services

to Snapshots.

Constructor Summary

Constructors

Constructor and Description
VMSnapshots(HttpProxyBroker proxy, VM parent)

Method Summary

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

VMSnapshots

public VMSnapshots(HttpProxyBroker proxy,
                   VM parent)

Parameters:

proxy - HttpProxyBroker

parent - VM

Method Detail

list

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

Lists VMSnapshot objects.

Specified by:

list in class CollectionDecorator<Snapshot,Snapshots,VMSnapshot>

Returns:

List of VMSnapshot

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

Fetches VMSnapshot object by id.

Specified by:

get in class CollectionDecorator<Snapshot,Snapshots,VMSnapshot>

Parameters:

id - entity id

Returns:

VMSnapshot

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

Fetches VMSnapshot object by id.

Specified by:

getById in class CollectionDecorator<Snapshot,Snapshots,VMSnapshot>

Parameters:

id - entity id

Returns:

VMSnapshot

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

Lists VMSnapshot objects.

Parameters:

max -

    [max results]
    

Returns:

List of VMSnapshot

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

Lists VMSnapshot objects.

Parameters:

allContent -

    [true|false]
    

max -

    [max results]
    

Returns:

List of VMSnapshot

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

Adds Snapshot object.

Parameters:

snapshot - Snapshot

    snapshot.description
    [snapshot.persist_memorystate]
    [snapshot.disks.disk]
    

Returns:

VMSnapshot

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

Adds Snapshot object.

Parameters:

snapshot - Snapshot

    snapshot.description
    [snapshot.persist_memorystate]
    [snapshot.disks.disk]
    

expect -

    [201-created]
    

Returns:

VMSnapshot

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

Adds Snapshot object.

Parameters:

snapshot - Snapshot

    snapshot.description
    [snapshot.persist_memorystate]
    [snapshot.disks.disk]
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

VMSnapshot

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.