com.huawei.openstack4j.api.storage.ObjectStorageContainerService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of openstack4j Show documentation
Show all versions of openstack4j Show documentation
Huawei Cloud Open API SDK for Java
/*******************************************************************************
* 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.storage;
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.storage.object.SwiftContainer;
import com.huawei.openstack4j.model.storage.object.options.ContainerListOptions;
import com.huawei.openstack4j.model.storage.object.options.CreateUpdateContainerOptions;
/**
* Provides access to the OpenStack Object Storage (Swift) Container API features.
*
* @author Jeremy Unruh
*/
public interface ObjectStorageContainerService extends RestService {
/**
* Listing of all containers associated with the Account (max result size is 10,000);
*
* @return List of containers ordered by name
*/
List list();
/**
* Listing of all containers with the associated options used in the query
*
* @param options the query based options
* @return List of containers ordered by name
*/
List list(ContainerListOptions options);
/**
* Creates a new container with the specified {@code name}
*
* @param name the name of the new container
* @return the action response
*/
ActionResponse create(String name);
/**
* Creates a pseudo path aka directory for the specified {@code containerName}
*
* @param containerName the name of the container
* @param path the path to create
* @return the ETAG checksum of the new path
*/
String createPath(String containerName, String path);
/**
* Creates a new container with the specified {@code name} with options
*
* @param name the name of the new container
* @param options the options to use when creating a container
* @return the action response
*/
ActionResponse create(String name, CreateUpdateContainerOptions options);
/**
* Updates a container with the specified {@code name} with options
*
* @param name the name of the container to update
* @param options the options to use when updating a container
* @param the action response
*/
ActionResponse update(String name, CreateUpdateContainerOptions options);
/**
* Deletes an empty container with the specified {@code name}
*
* @param name the name of the container to delete
* @return the action response (true if successfully deleted)
*/
ActionResponse delete(String name);
/**
* Gets the Metadata for a given container
*
* @param name the container name
* @return Map of key to value metadata
*/
Map getMetadata(String name);
/**
* Creates or Updates metadata items for the specified container {@code name}
*
* @param name the name of the container
* @param metadata the metadata to create/update for this container
* @return true if the create/update was successful, false if not
*/
boolean updateMetadata(String name, Map metadata);
/**
* Deletes metadata items from the specified container {@code name}
*
* @param name the name of the container
* @param metadata the metadata items to remove from the container's metadata
* @return true if the removal of items was successful, false if not
*/
boolean deleteMetadata(String name, Map metadata);
}