All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

There is a newer version: 4.5.1
Show newest version
/*
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.types.GlusterBrick;

/**
 * This service manages a single gluster brick.
 */
public interface GlusterBrickService extends Service {
    /**
     * Get details of a brick.
     * 
     * Retrieves status details of brick from underlying gluster volume with header `All-Content` set to `true`. This is
     * the equivalent of running `gluster volume status   detail`.
     * 
     * For example, to get the details of brick `234` of gluster volume `123`, send a request like this:
     * 
     * [source]
     * ----
     * GET /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234
     * ----
     * 
     * Which will return a response body like this:
     * 
     * [source,xml]
     * ----
     * 
     *   host1:/rhgs/data/brick1
     *   /rhgs/data/brick1
     *   111
     *   up
     *   /dev/mapper/RHGS_vg1-lv_vmaddldisks
     *   xfs
     *   
     *     
     *       2818417648
     *       1384694844
     *       1011
     *       client2
     *     
     *   
     *   
     *     
     *       data-server:fd_t
     *       1626348
     *       1020
     *       4
     *       23
     *       0
     *       140
     *       0
     *     
     *   
     *   rw,seclabel,noatime,nodiratime,attr2,inode64,sunit=512,swidth=2048,noquota
     *   25589
     *   49155
     * 
     * ----
     */
    public interface GetRequest extends Request {
    }
    
    /**
     * Get details of a brick.
     * 
     * Retrieves status details of brick from underlying gluster volume with header `All-Content` set to `true`. This is
     * the equivalent of running `gluster volume status   detail`.
     * 
     * For example, to get the details of brick `234` of gluster volume `123`, send a request like this:
     * 
     * [source]
     * ----
     * GET /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234
     * ----
     * 
     * Which will return a response body like this:
     * 
     * [source,xml]
     * ----
     * 
     *   host1:/rhgs/data/brick1
     *   /rhgs/data/brick1
     *   111
     *   up
     *   /dev/mapper/RHGS_vg1-lv_vmaddldisks
     *   xfs
     *   
     *     
     *       2818417648
     *       1384694844
     *       1011
     *       client2
     *     
     *   
     *   
     *     
     *       data-server:fd_t
     *       1626348
     *       1020
     *       4
     *       23
     *       0
     *       140
     *       0
     *     
     *   
     *   rw,seclabel,noatime,nodiratime,attr2,inode64,sunit=512,swidth=2048,noquota
     *   25589
     *   49155
     * 
     * ----
     */
    public interface GetResponse extends Response {
        GlusterBrick brick();
    }
    
    /**
     * Get details of a brick.
     * 
     * Retrieves status details of brick from underlying gluster volume with header `All-Content` set to `true`. This is
     * the equivalent of running `gluster volume status   detail`.
     * 
     * For example, to get the details of brick `234` of gluster volume `123`, send a request like this:
     * 
     * [source]
     * ----
     * GET /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234
     * ----
     * 
     * Which will return a response body like this:
     * 
     * [source,xml]
     * ----
     * 
     *   host1:/rhgs/data/brick1
     *   /rhgs/data/brick1
     *   111
     *   up
     *   /dev/mapper/RHGS_vg1-lv_vmaddldisks
     *   xfs
     *   
     *     
     *       2818417648
     *       1384694844
     *       1011
     *       client2
     *     
     *   
     *   
     *     
     *       data-server:fd_t
     *       1626348
     *       1020
     *       4
     *       23
     *       0
     *       140
     *       0
     *     
     *   
     *   rw,seclabel,noatime,nodiratime,attr2,inode64,sunit=512,swidth=2048,noquota
     *   25589
     *   49155
     * 
     * ----
     */
    GetRequest get();
    
    /**
     * Removes a brick.
     * 
     * Removes a brick from the underlying gluster volume and deletes entries from database. This can be used only when
     * removing a single brick without data migration. To remove multiple bricks and with data migration, use
     * <> instead.
     * 
     * For example, to delete brick `234` from gluster volume `123`, send a request like this:
     * 
     * [source]
     * ----
     * DELETE /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234
     * ----
     */
    public interface RemoveRequest extends Request {
        /**
         * Indicates if the remove should be performed asynchronously.
         */
        RemoveRequest async(Boolean async);
    }
    
    /**
     * Removes a brick.
     * 
     * Removes a brick from the underlying gluster volume and deletes entries from database. This can be used only when
     * removing a single brick without data migration. To remove multiple bricks and with data migration, use
     * <> instead.
     * 
     * For example, to delete brick `234` from gluster volume `123`, send a request like this:
     * 
     * [source]
     * ----
     * DELETE /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234
     * ----
     */
    public interface RemoveResponse extends Response {
    }
    
    /**
     * Removes a brick.
     * 
     * Removes a brick from the underlying gluster volume and deletes entries from database. This can be used only when
     * removing a single brick without data migration. To remove multiple bricks and with data migration, use
     * <> instead.
     * 
     * For example, to delete brick `234` from gluster volume `123`, send a request like this:
     * 
     * [source]
     * ----
     * DELETE /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234
     * ----
     */
    RemoveRequest remove();
    
    /**
     * Replaces this brick with a new one.
     * 
     * IMPORTANT: This operation has been deprecated since version 3.5 of the engine and will be removed in the future.
     * Use <> and
     * <> instead.
     */
    public interface ReplaceRequest extends Request {
        /**
         * Indicates if the replacement should be performed asynchronously.
         */
        ReplaceRequest async(Boolean async);
        ReplaceRequest force(Boolean force);
    }
    
    /**
     * Replaces this brick with a new one.
     * 
     * IMPORTANT: This operation has been deprecated since version 3.5 of the engine and will be removed in the future.
     * Use <> and
     * <> instead.
     */
    public interface ReplaceResponse extends Response {
    }
    
    /**
     * Replaces this brick with a new one.
     * 
     * IMPORTANT: This operation has been deprecated since version 3.5 of the engine and will be removed in the future.
     * Use <> and
     * <> instead.
     */
    ReplaceRequest replace();
    
    /**
     * Service locator method, returns individual service on which the URI is dispatched.
     */
    Service service(String path);
}





© 2015 - 2024 Weber Informatics LLC | Privacy Policy