com.huawei.openstack4j.api.dns.v2.ZoneService 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.api.dns.v2;
import java.util.List;
import com.huawei.openstack4j.common.RestService;
import com.huawei.openstack4j.model.dns.v2.Nameserver;
import com.huawei.openstack4j.model.dns.v2.Zone;
import com.huawei.openstack4j.model.dns.v2.ZoneType;
import com.huawei.openstack4j.openstack.dns.v2.domain.DesignateZone;
/**
* Designate V2 Zone Service
*
*/
public interface ZoneService extends RestService {
/**
* create a new zone
*
* @param zone the zone
* @return the newly created zone
*/
Zone create(Zone zone);
/**
* creates a new zone
*
* @param name the zone name
* @param email the e-mail for the zone
*
* @return the newly created group
*/
Zone create(String name, String email);
/**
* gets detailed information about a specified zone by id
*
* @param zoneId the zone identifier
* @return the zone
*/
Zone get(String zoneId);
/**
* delete a zone by id
*
* @param zoneId the zone id
* @return the action response
*/
Zone delete(String zoneId);
/**
* list nameservers for a zone
*
* @param zoneId the zone identifier
* @return list of nameservers for a zone
*/
List listNameservers(String zoneId);
/**
* lists zones.
*
* @return list of zones
*/
List list();
/**
* lists zones
* @param type the zone type, null -> query all zones, public -> query all public zones, private -> query all private zones
* @param marker the initial ID of a paging query, if null, query the first page
* @param limit per page's item quantity. Value can be 0~500
* @return
*/
List list(ZoneType type, String marker, Integer limit);
/**
* Associate a router to the zone
* @param zoneId the zone id
* @param router the router info
* @return
*/
DesignateZone.Router associateRouter(String zoneId, DesignateZone.Router router);
/**
* Disassociate the router from the zone
* @param zoneId the zone id
* @param router the router info
* @return
*/
DesignateZone.Router disassociateRouter(String zoneId, DesignateZone.Router router);
}