org.ovirt.engine.sdk4.services.StorageServerConnectionExtensionService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk Show documentation
There is a newer version: 4.5.1
/*
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 org.ovirt.engine.sdk4.Request;
import org.ovirt.engine.sdk4.Response;
import org.ovirt.engine.sdk4.Service;
import org.ovirt.engine.sdk4.builders.StorageConnectionExtensionBuilder;
import org.ovirt.engine.sdk4.types.StorageConnectionExtension;

public interface StorageServerConnectionExtensionService extends Service {
    public interface GetRequest extends Request {
    }
    
    public interface GetResponse extends Response {
        StorageConnectionExtension extension();
    }
    
    GetRequest get();
    
    public interface RemoveRequest extends Request {
        /**
         * Indicates if the remove should be performed asynchronously.
         */
        RemoveRequest async(Boolean async);
    }
    
    public interface RemoveResponse extends Response {
    }
    
    RemoveRequest remove();
    
    /**
     * Update a storage server connection extension for the given host.
     * 
     * To update the storage connection `456` of host `123` send a request like this:
     * 
     * [source]
     * ----
     * PUT /ovirt-engine/api/hosts/123/storageconnectionextensions/456
     * ----
     * 
     * With a request body like this:
     * 
     * [source,xml]
     * ----
     * 
     *   iqn.2016-01.com.example:mytarget
     *   myuser
     *   mypassword
     * 
     * ----
     */
    public interface UpdateRequest extends Request {
        /**
         * Indicates if the update should be performed asynchronously.
         */
        UpdateRequest async(Boolean async);
        UpdateRequest extension(StorageConnectionExtension extension);
        UpdateRequest extension(StorageConnectionExtensionBuilder extension);
    }
    
    /**
     * Update a storage server connection extension for the given host.
     * 
     * To update the storage connection `456` of host `123` send a request like this:
     * 
     * [source]
     * ----
     * PUT /ovirt-engine/api/hosts/123/storageconnectionextensions/456
     * ----
     * 
     * With a request body like this:
     * 
     * [source,xml]
     * ----
     * 
     *   iqn.2016-01.com.example:mytarget
     *   myuser
     *   mypassword
     * 
     * ----
     */
    public interface UpdateResponse extends Response {
        StorageConnectionExtension extension();
    }
    
    /**
     * Update a storage server connection extension for the given host.
     * 
     * To update the storage connection `456` of host `123` send a request like this:
     * 
     * [source]
     * ----
     * PUT /ovirt-engine/api/hosts/123/storageconnectionextensions/456
     * ----
     * 
     * With a request body like this:
     * 
     * [source,xml]
     * ----
     * 
     *   iqn.2016-01.com.example:mytarget
     *   myuser
     *   mypassword
     * 
     * ----
     */
    UpdateRequest update();
    
    /**
     * Service locator method, returns individual service on which the URI is dispatched.
     */
    Service service(String path);
}