org.jclouds.openstack.swift.v1.features
Interface AccountApi


@Beta
public interface AccountApi

Provides access to the OpenStack Object Storage (Swift) Account API features.

Account metadata prefixed with X-Account-Meta- will be converted appropriately using a binder/parser.

This API is new to jclouds and hence is in Beta. That means we need people to use it and give us feedback. Based on that feedback, minor changes to the interfaces may happen. This code will replace org.jclouds.openstack.swift.SwiftClient in jclouds 2.0 and it is recommended you adopt it sooner than later.

See Also:
Account}

Method Summary
 boolean deleteMetadata(Map<String,String> metadata)
          Deletes metadata from the Account.
 Account get()
          Gets the Account.
 boolean updateMetadata(Map<String,String> metadata)
          Creates or updates the Account metadata.
 boolean updateTemporaryUrlKey(String temporaryUrlKey)
          Replaces the temporary URL key for the Account.
 

Method Detail

get

@Named(value="account:get")
Account get()
Gets the Account.

Returns:
The Account object.

updateMetadata

@Named(value="account:updateMetadata")
boolean updateMetadata(Map<String,String> metadata)
Creates or updates the Account metadata.

Parameters:
metadata - the metadata to create or update.
Returns:
true if the metadata was successfully created or updated, false if not.

updateTemporaryUrlKey

@Named(value="account:updateTemporaryUrlKey")
boolean updateTemporaryUrlKey(@HeaderParam(value="X-Account-Meta-Temp-Url-Key")
                                    String temporaryUrlKey)
Replaces the temporary URL key for the Account.

Parameters:
temporaryUrlKey - the temporary URL key to update.
Returns:
true if the temporary URL key was successfully updated, false if not.

deleteMetadata

@Named(value="account:deleteMetadata")
boolean deleteMetadata(Map<String,String> metadata)
Deletes metadata from the Account.

Parameters:
metadata - the metadata to delete.
Returns:
true if the metadata was successfully deleted, false if not.


Copyright © 2009-2014 The Apache Software Foundation. All Rights Reserved.