com.huawei.openstack4j.api.compute.ComputeImageService 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 java.util.Map;
import com.huawei.openstack4j.common.RestService;
import com.huawei.openstack4j.model.common.ActionResponse;
import com.huawei.openstack4j.model.compute.Image;
/**
* Provides access to Compute Images
*
* @author Jeremy Unruh
*/
public interface ComputeImageService extends RestService {
/**
* Lists Images on an OpenStack Compute EndPoint. By default this method lists in "Detail" which means all
* major fields are populated for each image. This is equivalent to calling {@link #list(boolean)} with {code}true{code}
*
* @return List of Image
*/
List list();
/**
* Lists Images on an OpenStack Compute EndPoint. If {@code detailed} is false then only {@link Image#getId()}, {@link Image#getName()} and
*
* @param detailed true to populate all properties within each Image, false to include Id, Name and Links only (all other properties will be null)
* @return List of Image
* {@link Image#getLinks()} will be populated. True will populate all fields
*/
List list(boolean detailed);
/**
* Finds an Image by the given {@code imageId}.
* @param imageId the image identifier
* @return the specified Image
*/
Image get(String imageId);
/**
* Deletes an Image based on it's identifiers. Images created by another user typically cannot be deleted
*
* @param imageId the image identifier
* @return the action response
*/
ActionResponse delete(String imageId);
/**
* Gets the metadata for an image
*
* @param imageId the image identifier
* @return the metadata as Map
*/
Map getMetaData(String imageId);
/**
* Sets the metadata for an image
*
* @param imageId the image identifier
* @param metadata a Map containing the metadata
* @return the metadata as Map
*/
Map setMetaData(String imageId, Map metadata);
/**
* Delete a metadata item from an image
*
* @param imageId the image identifier
* @param keys one or more keys/metadata names to remove
* @return the action response
*/
ActionResponse deleteMetaData(String imageId, String... keys);
}