org.ovirt.engine.sdk.decorators.VMNIC Maven / Gradle / Ivy
Show all versions of ovirt-engine-sdk-java Show documentation
//
// Copyright (c) 2012 Red Hat, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// *********************************************************************
// ********************* GENERATED CODE - DO NOT MODIFY ****************
// *********************************************************************
package org.ovirt.engine.sdk.decorators;
import java.io.IOException;
import java.util.List;
import org.apache.http.Header;
import org.apache.http.client.ClientProtocolException;
import org.ovirt.engine.sdk.entities.Action;
import org.ovirt.engine.sdk.entities.Response;
import org.ovirt.engine.sdk.exceptions.ServerException;
import org.ovirt.engine.sdk.utils.HttpHeaderBuilder;
import org.ovirt.engine.sdk.utils.HttpHeaderUtils;
import org.ovirt.engine.sdk.utils.UrlBuilder;
import org.ovirt.engine.sdk.web.HttpProxyBroker;
import org.ovirt.engine.sdk.web.UrlParameterType;
/**
* VMNIC providing relation and functional services
*
to {@link org.ovirt.engine.sdk.entities.NIC }.
*/
@SuppressWarnings("unused")
public class VMNIC extends
org.ovirt.engine.sdk.entities.NIC {
private HttpProxyBroker proxy;
private final Object LOCK = new Object();
private volatile VMNICReportedDevices vMNICReportedDevices;
private volatile VMNICStatistics vMNICStatistics;
/**
* @param proxy HttpProxyBroker
*/
public VMNIC(HttpProxyBroker proxy) {
this.proxy = proxy;
}
/**
* @return HttpProxyBroker
*/
private HttpProxyBroker getProxy() {
return proxy;
}
/**
* Gets the value of the VMNICReportedDevices property.
*
* @return
* {@link VMNICReportedDevices }
*/
public VMNICReportedDevices getReportedDevices() {
if (this.vMNICReportedDevices == null) {
synchronized (this.LOCK) {
if (this.vMNICReportedDevices == null) {
this.vMNICReportedDevices = new VMNICReportedDevices(proxy, this);
}
}
}
return vMNICReportedDevices;
}
/**
* Gets the value of the VMNICStatistics property.
*
* @return
* {@link VMNICStatistics }
*/
public VMNICStatistics getStatistics() {
if (this.vMNICStatistics == null) {
synchronized (this.LOCK) {
if (this.vMNICStatistics == null) {
this.vMNICStatistics = new VMNICStatistics(proxy, this);
}
}
}
return vMNICStatistics;
}
/**
* Performs activate action.
*
* @param action {@link org.ovirt.engine.sdk.entities.Action}
*
* @return
* {@link Action }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
public Action activate(Action action) throws ClientProtocolException,
ServerException, IOException {
String url = this.getHref() + "/activate";
HttpHeaderBuilder headersBuilder = new HttpHeaderBuilder();
List headers = headersBuilder.build();
UrlBuilder urlBuilder = new UrlBuilder(url);
url = urlBuilder.build();
return getProxy().action(url, action, Action.class, Action.class, headers);
}
/**
* Performs activate action.
*
* @param action {@link org.ovirt.engine.sdk.entities.Action}
* @param correlationId
*
* [any string]
*
* @return
* {@link Action }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
public Action activate(Action action, String correlationId) throws ClientProtocolException,
ServerException, IOException {
String url = this.getHref() + "/activate";
HttpHeaderBuilder headersBuilder = new HttpHeaderBuilder();
if (correlationId != null) {
headersBuilder.add("Correlation-Id", correlationId);
}
List headers = headersBuilder.build();
UrlBuilder urlBuilder = new UrlBuilder(url);
url = urlBuilder.build();
return getProxy().action(url, action, Action.class, Action.class, headers);
}
/**
* Performs activate action.
*
* @param action {@link org.ovirt.engine.sdk.entities.Action}
* @param correlationId
*
* [any string]
*
* @param async
*
* [true|false]
*
* @return
* {@link Action }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
public Action activate(Action action, String correlationId, Boolean async) throws ClientProtocolException,
ServerException, IOException {
String url = this.getHref() + "/activate";
HttpHeaderBuilder headersBuilder = new HttpHeaderBuilder();
if (correlationId != null) {
headersBuilder.add("Correlation-Id", correlationId);
}
List headers = headersBuilder.build();
UrlBuilder urlBuilder = new UrlBuilder(url);
if (async != null) {
urlBuilder.add("async", async, UrlParameterType.MATRIX);
}
url = urlBuilder.build();
return getProxy().action(url, action, Action.class, Action.class, headers);
}
/**
* Performs deactivate action.
*
* @param action {@link org.ovirt.engine.sdk.entities.Action}
*
* @return
* {@link Action }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
public Action deactivate(Action action) throws ClientProtocolException,
ServerException, IOException {
String url = this.getHref() + "/deactivate";
HttpHeaderBuilder headersBuilder = new HttpHeaderBuilder();
List headers = headersBuilder.build();
UrlBuilder urlBuilder = new UrlBuilder(url);
url = urlBuilder.build();
return getProxy().action(url, action, Action.class, Action.class, headers);
}
/**
* Performs deactivate action.
*
* @param action {@link org.ovirt.engine.sdk.entities.Action}
* @param correlationId
*
* [any string]
*
* @return
* {@link Action }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
public Action deactivate(Action action, String correlationId) throws ClientProtocolException,
ServerException, IOException {
String url = this.getHref() + "/deactivate";
HttpHeaderBuilder headersBuilder = new HttpHeaderBuilder();
if (correlationId != null) {
headersBuilder.add("Correlation-Id", correlationId);
}
List headers = headersBuilder.build();
UrlBuilder urlBuilder = new UrlBuilder(url);
url = urlBuilder.build();
return getProxy().action(url, action, Action.class, Action.class, headers);
}
/**
* Performs deactivate action.
*
* @param action {@link org.ovirt.engine.sdk.entities.Action}
* @param correlationId
*
* [any string]
*
* @param async
*
* [true|false]
*
* @return
* {@link Action }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
public Action deactivate(Action action, String correlationId, Boolean async) throws ClientProtocolException,
ServerException, IOException {
String url = this.getHref() + "/deactivate";
HttpHeaderBuilder headersBuilder = new HttpHeaderBuilder();
if (correlationId != null) {
headersBuilder.add("Correlation-Id", correlationId);
}
List headers = headersBuilder.build();
UrlBuilder urlBuilder = new UrlBuilder(url);
if (async != null) {
urlBuilder.add("async", async, UrlParameterType.MATRIX);
}
url = urlBuilder.build();
return getProxy().action(url, action, Action.class, Action.class, headers);
}
/**
* Deletes object.
*
* @return
* {@link Response }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
public Response delete() throws ClientProtocolException,
ServerException, IOException {
String url = this.getHref();
HttpHeaderBuilder headersBuilder = new HttpHeaderBuilder();
List headers = headersBuilder.build();
UrlBuilder urlBuilder = new UrlBuilder(url);
url = urlBuilder.build();
return getProxy().delete(url, Response.class, headers);
}
/**
* Deletes object.
* @param async
*
* [true|false]
*
* @return
* {@link Response }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
public Response delete(Boolean async) throws ClientProtocolException,
ServerException, IOException {
String url = this.getHref();
HttpHeaderBuilder headersBuilder = new HttpHeaderBuilder();
List headers = headersBuilder.build();
UrlBuilder urlBuilder = new UrlBuilder(url);
if (async != null) {
urlBuilder.add("async", async, UrlParameterType.MATRIX);
}
url = urlBuilder.build();
return getProxy().delete(url, Response.class, headers);
}
/**
* Deletes object.
* @param async
*
* [true|false]
*
* @param correlationId
*
* [any string]
*
* @return
* {@link Response }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
public Response delete(Boolean async, String correlationId) throws ClientProtocolException,
ServerException, IOException {
String url = this.getHref();
HttpHeaderBuilder headersBuilder = new HttpHeaderBuilder();
if (correlationId != null) {
headersBuilder.add("Correlation-Id", correlationId);
}
List headers = headersBuilder.build();
UrlBuilder urlBuilder = new UrlBuilder(url);
if (async != null) {
urlBuilder.add("async", async, UrlParameterType.MATRIX);
}
url = urlBuilder.build();
return getProxy().delete(url, Response.class, headers);
}
/**
* Updates VMNIC object.
*
* @param nic {@link org.ovirt.engine.sdk.entities.NIC}
*
* Overload 1:
*
* update the network interface
* for the given virtual machine
*
* [nic.vnic_profile.id]
* [nic.linked]
* [nic.name]
* [nic.mac.address]
* [nic.interface]
* [nic.plugged]
*
* Overload 2:
*
* update the network interface
* for the given virtual machine
* with port mirroring options
*
* [nic.network.id|name]
* [nic.linked]
* [nic.name]
* [nic.mac.address]
* [nic.interface]
* [nic.port_mirroring.networks.network]
* [nic.plugged]
*
*
*
* @return
* {@link VMNIC }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
public VMNIC update() throws ClientProtocolException,
ServerException, IOException {
String url = this.getHref();
HttpHeaderBuilder headersBuilder = new HttpHeaderBuilder();
List headers = headersBuilder.build();
UrlBuilder urlBuilder = new UrlBuilder(url);
url = urlBuilder.build();
return getProxy().update(
url,
this,
org.ovirt.engine.sdk.entities.NIC.class,
VMNIC.class,
headers);
}
/**
* Updates VMNIC object.
*
* @param nic {@link org.ovirt.engine.sdk.entities.NIC}
*
* Overload 1:
*
* update the network interface
* for the given virtual machine
*
* [nic.vnic_profile.id]
* [nic.linked]
* [nic.name]
* [nic.mac.address]
* [nic.interface]
* [nic.plugged]
*
* Overload 2:
*
* update the network interface
* for the given virtual machine
* with port mirroring options
*
* [nic.network.id|name]
* [nic.linked]
* [nic.name]
* [nic.mac.address]
* [nic.interface]
* [nic.port_mirroring.networks.network]
* [nic.plugged]
*
*
* @param correlationId
*
* [any string]
*
* @return
* {@link VMNIC }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
public VMNIC update(String correlationId) throws ClientProtocolException,
ServerException, IOException {
String url = this.getHref();
HttpHeaderBuilder headersBuilder = new HttpHeaderBuilder();
if (correlationId != null) {
headersBuilder.add("Correlation-Id", correlationId);
}
List headers = headersBuilder.build();
UrlBuilder urlBuilder = new UrlBuilder(url);
url = urlBuilder.build();
return getProxy().update(
url,
this,
org.ovirt.engine.sdk.entities.NIC.class,
VMNIC.class,
headers);
}
/**
* Updates VMNIC object.
*
* @param nic {@link org.ovirt.engine.sdk.entities.NIC}
*
* Overload 1:
*
* update the network interface
* for the given virtual machine
*
* [nic.vnic_profile.id]
* [nic.linked]
* [nic.name]
* [nic.mac.address]
* [nic.interface]
* [nic.plugged]
*
* Overload 2:
*
* update the network interface
* for the given virtual machine
* with port mirroring options
*
* [nic.network.id|name]
* [nic.linked]
* [nic.name]
* [nic.mac.address]
* [nic.interface]
* [nic.port_mirroring.networks.network]
* [nic.plugged]
*
*
* @param correlationId
*
* [any string]
*
* @param async
*
* [true|false]
*
* @return
* {@link VMNIC }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
public VMNIC update(String correlationId, Boolean async) throws ClientProtocolException,
ServerException, IOException {
String url = this.getHref();
HttpHeaderBuilder headersBuilder = new HttpHeaderBuilder();
if (correlationId != null) {
headersBuilder.add("Correlation-Id", correlationId);
}
List headers = headersBuilder.build();
UrlBuilder urlBuilder = new UrlBuilder(url);
if (async != null) {
urlBuilder.add("async", async, UrlParameterType.MATRIX);
}
url = urlBuilder.build();
return getProxy().update(
url,
this,
org.ovirt.engine.sdk.entities.NIC.class,
VMNIC.class,
headers);
}
/**
* Updates VMNIC object.
*
* @param nic {@link org.ovirt.engine.sdk.entities.NIC}
*
* Overload 1:
*
* update the network interface
* for the given virtual machine
*
* [nic.vnic_profile.id]
* [nic.linked]
* [nic.name]
* [nic.mac.address]
* [nic.interface]
* [nic.plugged]
*
* Overload 2:
*
* update the network interface
* for the given virtual machine
* with port mirroring options
*
* [nic.network.id|name]
* [nic.linked]
* [nic.name]
* [nic.mac.address]
* [nic.interface]
* [nic.port_mirroring.networks.network]
* [nic.plugged]
*
*
* @param correlationId
*
* [any string]
*
* @param async
*
* [true|false]
*
* @param expect
*
* [202-accepted]
*
* @return
* {@link VMNIC }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
public VMNIC update(String correlationId, Boolean async, String expect) throws ClientProtocolException,
ServerException, IOException {
String url = this.getHref();
HttpHeaderBuilder headersBuilder = new HttpHeaderBuilder();
if (correlationId != null) {
headersBuilder.add("Correlation-Id", correlationId);
}
if (expect != null) {
headersBuilder.add("Expect", expect);
}
List headers = headersBuilder.build();
UrlBuilder urlBuilder = new UrlBuilder(url);
if (async != null) {
urlBuilder.add("async", async, UrlParameterType.MATRIX);
}
url = urlBuilder.build();
return getProxy().update(
url,
this,
org.ovirt.engine.sdk.entities.NIC.class,
VMNIC.class,
headers);
}
}