org.openstack4j.api.barbican.ContainerService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openstack4j-core Show documentation

OpenStack Java API

The newest version!

package org.openstack4j.api.barbican;

import org.openstack4j.model.barbican.Container;
import org.openstack4j.model.common.ActionResponse;

import java.util.List;
import java.util.Map;

/**
 * Container service provides CRUD capabilities for Containers(s).
 */
public interface ContainerService {

    /**
     * Returns list of containers filtered by parameters.
     *
     * @param filteringParams map (name, value) of filtering parameters
     * @return list of containers filtered by filteringParams
     */
    List list(final Map filteringParams);

    /**
     * Gets a list of currently existing {@link Container}s for a specified container.
     *
     * @return the list of {@link Container}s
     */
    List list(final String name);

    /**
     * Get the specified container by ID
     * @param containerId
     * @return
     */
    Container get(final String containerId);

    /**
     * Delete the specified container by ID
     * @param containerId
     * @return
     */
    ActionResponse delete(final String containerId);

    /**
     * Create a container.
     * @param container
     * @return
     */
    Container create(final Container container);
}