org.jclouds.vcloud.director.v1_5.features
Interface MetadataApi

public interface MetadataApi

Provides synchronous access to Metadata.

Author:

danikov, Adrian Cole

See Also:

MetadataAsyncApi

Method Summary

Metadata	get() Retrieves an list of metadata
String	get(String key) Retrieves a metadata value
Task	put(String key, String value) Sets the metadata for the particular key for the media to the value provided.
Task	putAll(Map<String,String> metadata) Merges the metadata for a media with the information provided.
Task	remove(String key) Deletes a metadata entry.

Method Detail

get

Metadata get()

Retrieves an list of metadata

Returns:

a list of metadata

get

String get(String key)

Retrieves a metadata value

Returns:

the metadata value, or null if not found

putAll

Task putAll(Map<String,String> metadata)

Merges the metadata for a media with the information provided.

Returns:

a task. This operation is asynchronous and the user should monitor the returned task status in order to check when it is completed.

put

Task put(String key,
         String value)

Sets the metadata for the particular key for the media to the value provided. Note: this will replace any existing metadata information

Returns:

a task. This operation is asynchronous and the user should monitor the returned task status in order to check when it is completed.

remove

Task remove(String key)

Deletes a metadata entry.

Returns:

a task. This operation is asynchronous and the user should monitor the returned task status in order to check when it is completed.