org.jclouds.providers
Interface ProviderMetadata

All Known Implementing Classes:

AnonymousProviderMetadata, BaseProviderMetadata

public interface ProviderMetadata

The ProviderMetadata interface allows jclouds to provide a plugin framework for gathering cloud provider metadata.

Author:

Jeremy Whitlock , Adrian Cole

Nested Class Summary

static interface

ProviderMetadata.Builder

Method Summary

ApiMetadata	getApiMetadata()
com.google.common.base.Optional<URI>	getConsole()
Properties	getDefaultProperties() Configuration Properties used when creating connections to this provider.
String	getEndpoint()
com.google.common.base.Optional<URI>	getHomepage()
String	getId()
Set<String>	getIso3166Codes() iso 3166 codes; ex.
Set<String>	getLinkedServices()
String	getName()
ProviderMetadata.Builder	toBuilder()

Method Detail

toBuilder

ProviderMetadata.Builder toBuilder()

Since:

1.5

See Also:

ProviderMetadata.Builder

getId

String getId()

Returns:

the provider's unique identifier (ex. aws-ec2, trystack-nova)

getName

String getName()

Returns:

the name (display name) of the provider (ex. GoGrid)

getApiMetadata

ApiMetadata getApiMetadata()

Returns:

the provider's api

Since:

1.5

getEndpoint

String getEndpoint()

Returns:

the url for the provider's api

See Also:

ApiMetadata#getEndpoint

getDefaultProperties

Properties getDefaultProperties()

Configuration Properties used when creating connections to this provider. For example, location information, or default networking configuration.

Returns:

properties used to create connections to this provider

See Also:

ApiMetadata.getDefaultProperties()

getConsole

com.google.common.base.Optional<URI> getConsole()

Returns:

the url for the provider's console, or absent if one doesn't exist

getHomepage

com.google.common.base.Optional<URI> getHomepage()

Returns:

the url for the provider's homepage, or absent if unknown

getLinkedServices

Set<String> getLinkedServices()

Returns:

ids of all known providers which have the same account as this.

getIso3166Codes

Set<String> getIso3166Codes()

iso 3166 codes; ex. US-CA,US

Returns:

all known region/location ISO 3166 codes