org.jclouds.providers

Interface ProviderMetadata

All Known Implementing Classes:

AnonymousProviderMetadata, AutoscaleUSProviderMetadata, AutoscaleUSProviderMetadata, AWSCloudWatchProviderMetadata, AWSEC2ProviderMetadata, AWSRoute53ProviderMetadata, AWSS3ProviderMetadata, AWSSQSProviderMetadata, AWSSTSProviderMetadata, AzureBlobProviderMetadata, AzureComputeProviderMetadata, B2ProviderMetadata, BaseProviderMetadata, CloudBlockStorageUKProviderMetadata, CloudBlockStorageUSProviderMetadata, CloudDatabasesUKProviderMetadata, CloudDatabasesUSProviderMetadata, CloudDNSUKProviderMetadata, CloudDNSUSProviderMetadata, CloudFilesUKProviderMetadata, CloudFilesUSProviderMetadata, CloudLoadBalancersUKProviderMetadata, CloudLoadBalancersUSProviderMetadata, CloudNetworksUKProviderMetadata, CloudNetworksUSProviderMetadata, CloudQueuesUKProviderMetadata, CloudQueuesUSProviderMetadata, CloudServersUKProviderMetadata, CloudServersUSProviderMetadata, DigitalOcean2ProviderMetadata, DynECTProviderMetadata, ElasticHostsAmsterdamMetadata, ElasticHostsBlueSquareLondonProviderMetadata, ElasticHostsDallasMetadata, ElasticHostsHongKongProviderMetadata, ElasticHostsMiamiMetadata, ElasticHostsPeer1LondonProviderMetadata, ElasticHostsPeer1LosAngelesProviderMetadata, ElasticHostsPeer1SanAntonioProviderMetadata, ElasticHostsPeer1TorontoProviderMetadata, ElasticHostsSanJoseProviderMetadata, ElasticHostsSydneyProviderMetadata, GleSYSProviderMetadata, Go2CloudJohannesburg1ProviderMetadata, GoGridProviderMetadata, GoogleCloudStorageProviderMetadata, GoogleComputeEngineProviderMetadata, OpenHostingEast1ProviderMetadata, PacketProviderMetadata, ProfitBricksProviderMetadata, ServerloveManchesterProviderMetadata, SkaliCloudMalaysiaProviderMetadata, SoftLayerProviderMetadata, UltraDNSWSProviderMetadata

public interface ProviderMetadata

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ProviderMetadata.Builder

Method Summary

Modifier and Type	Method and Description
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, rackspace-cloudservers-us)

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