com.huawei.openstack4j.api.compute.KeypairService 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.compute;
import java.util.List;
import javax.annotation.Nullable;
import com.huawei.openstack4j.common.RestService;
import com.huawei.openstack4j.model.common.ActionResponse;
import com.huawei.openstack4j.model.compute.Keypair;
/**
* Keypair Service manages SSH Keys within OpenStack Compute (Nova).
*
* @author Jeremy Unruh
*/
public interface KeypairService extends RestService {
/**
* Lists keypairs that are associated with the account making the request
*
* @return the list of keypairs
*/
List list();
/**
* Gets the keypair by name
*
* @param name the keypair name
* @return the keypair
*/
Keypair get(String name);
/**
* Deletes the keypair by name
*
* @param name the keypair name
* @return the action response
*/
ActionResponse delete(String name);
/**
* Generates or imports a keypair
*
* @param name the name of the keypair
* @param publicKey the public key (optional), Null indicates one will be generated
* @return the newly created keypair
*/
Keypair create(String name, @Nullable String publicKey);
}