org.ovirt.engine.sdk4.services.NetworkLabelsService Maven / Gradle / Ivy
/*
Copyright (c) 2015 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.
*/
package org.ovirt.engine.sdk4.services;
import java.io.IOException;
import java.math.BigInteger;
import java.util.List;
import org.ovirt.engine.sdk4.Request;
import org.ovirt.engine.sdk4.Response;
import org.ovirt.engine.sdk4.Service;
import org.ovirt.engine.sdk4.builders.NetworkLabelBuilder;
import org.ovirt.engine.sdk4.types.NetworkLabel;
public interface NetworkLabelsService extends Service {
/**
* Attaches label to logical network.
*
* You can attach labels to a logical network to automate the association of that logical network with physical host
* network interfaces to which the same label has been attached.
*
* For example, to attach the label `mylabel` to a logical network having id `123` send a request like this:
*
* [source]
* ----
* POST /ovirt-engine/api/networks/123/labels
* ----
*
* With a request body like this:
*
* [source,xml]
* ----
*
* ----
*/
public interface AddRequest extends Request {
AddRequest label(NetworkLabel label);
AddRequest label(NetworkLabelBuilder label);
}
/**
* Attaches label to logical network.
*
* You can attach labels to a logical network to automate the association of that logical network with physical host
* network interfaces to which the same label has been attached.
*
* For example, to attach the label `mylabel` to a logical network having id `123` send a request like this:
*
* [source]
* ----
* POST /ovirt-engine/api/networks/123/labels
* ----
*
* With a request body like this:
*
* [source,xml]
* ----
*
* ----
*/
public interface AddResponse extends Response {
NetworkLabel label();
}
/**
* Attaches label to logical network.
*
* You can attach labels to a logical network to automate the association of that logical network with physical host
* network interfaces to which the same label has been attached.
*
* For example, to attach the label `mylabel` to a logical network having id `123` send a request like this:
*
* [source]
* ----
* POST /ovirt-engine/api/networks/123/labels
* ----
*
* With a request body like this:
*
* [source,xml]
* ----
*
* ----
*/
AddRequest add();
public interface ListRequest extends Request {
/**
* Sets the maximum number of labels to return. If not specified all the labels are returned.
*/
ListRequest max(Integer max);
/**
* Sets the maximum number of labels to return. If not specified all the labels are returned.
*/
ListRequest max(Long max);
/**
* Sets the maximum number of labels to return. If not specified all the labels are returned.
*/
ListRequest max(BigInteger max);
}
public interface ListResponse extends Response {
List labels();
}
ListRequest list();
NetworkLabelService labelService(String id);
/**
* Service locator method, returns individual service on which the URI is dispatched.
*/
Service service(String path);
}