com.huawei.openstack4j.model.network.ext.LbPool Maven / Gradle / Ivy
/*******************************************************************************
* Copyright 2016 ContainX and OpenStack4j
*
* 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 com.huawei.openstack4j.model.network.ext;
import java.util.List;
import com.huawei.openstack4j.common.Buildable;
import com.huawei.openstack4j.model.ModelEntity;
import com.huawei.openstack4j.model.network.ext.builder.LbPoolBuilder;
/**
* A loadbanlance pool
* @author liujunpeng
*
*/
public interface LbPool extends ModelEntity, Buildable {
/**
*
* @return id. The unique ID for the pool.
*/
public String getId();
/**
*
* @return tenantId.
* Owner of the pool. Only an administrative user can specify a tenant ID other than its own.
*/
public String getTenantId();
/**
*
* @return vip Id.
*/
public String getVipId();
/**
*
* @return Pool name. Does not have to be unique.
*/
public String getName();
/**
*
* @return Description for the pool.
*/
public String getDescription();
/**
*
* @return subnetId The ID of the subnet on which to allocate the VIP address.
*/
public String getSubnetId();
/**
*
* @return The protocol of the pool, which is TCP, HTTP, or HTTPS.
*/
public Protocol getProtocol();
/**
*
* @return loadbalance provider,such as haproxy
*/
public String getProvider();
/**
*
* @return The load-balancer algorithm, which is round-robin, least-connections, and so on. This value, which must be supported, is dependent on the load-balancer provider. Round-robin must be supported.
*/
public LbMethod getLbMethod();
/**
*
* @return List of members that belong to the pool.
*/
public List getMembers();
/**
*
* @return List of health monitors that associated to the pool.
*/
public List getHealthMonitors();
/**
*
* @return The administrative state of the lb pool, which is up (true) or
* down (false).
*/
public boolean isAdminStateUp();
/**
*
* @return status The status of the lb pool. Indicates whether the lb pool is
* operational.
*/
public String getStatus();
}