Page tree
Skip to end of metadata
Go to start of metadata

Name

Description

ActionDefinition

An object that defines an action used by a configuration resource provider

Address

The Address class holds the details of each address.

AggregationField

The Aggregation class specifies an aggregation function that can be executed in a complex database query.

AggregationFilter

The AggregationFilter class specifies a filter that can be run on an aggregation function in a complex database query.

AuthenticationToken

Authentication tokens object holds the information on token used for authentication with the API which can be used without requiring to use the user password for each call

BillingEntity

The BillingEntity class is a virtual resource holding data for each Billing Entity

BillingEntityDetails

The BillingEntityDetails class holds the base data for each Billing Entity.

BillingMethod

The BillingMethod class represents a Billing Method.

Blob

The blob class is a resource representing a blob in internationalisation

CallbackParams

A hash containing parameters to be passed to or from the FDL payment provider process callback function

CapabilityAction

An object which represents a relation ship between a capability and a resource type.

Cluster

The Cluster class is a virtual resource that represents a cluster.

ConditionalState

An object that represents a condition value state change

ConfigurationProvider

The ConfigurationProvider class extensions to existing resources defined in FDL.

CreditNote

The CreditNote class holds the base data for each credit note.

Currency

The Country class holds the base data for each country.

Customer

The Customer class is a virtual resource holding the data for each customer.

CustomerDetails

The Customer Details class holds the details for each customer.

CustomerEmail

The CustomerEmail class holds the base data for each email sent to a customer.

DeploymentInstance

The DeploymentInstance class holds an instance of a deployment template.

DeploymentTemplate

The DeploymentTemplate class is a template resource holding the details of resources which are deployed when the template is deployed.

Disk

The Disk class is a virtual resource holding the data for each disk.

DryRunResult

The class represents the result of dry run and list of resolved/unresolved references

EmailBlock

The EmailBlock class holds an email block.

EmailTemplate

The EmailTemplate class holds the base data for each email template.

EmailVarsMap

A map wrapper for EmailVAR keys and string values. The map contains the EmailVAR that can be used and description.

ExternalVm

Object that represents an external VM

FDLActionOutput

An object that represents a collection for values used for a translation.

FDLCodeBlock

Represent a FDL code block

FetchParameters

The FetchParameters class holds the parameters for a disk server or image fetch.

FilterCondition

The FilterCondition class holds the base data for each filter condition.

Firewall

The Firewall class is a virtual resource holding data for a firewall instance.

FirewallRule

the FirewallRule class contains an individual firewall rule within a FirewallTemplate

FirewallTemplate

The FirewallTemplate class is a virtual resource representing a template for firewalls which may be attached to one or more IP addresses

Group

The Group class is a virtual resource representing a group.

HypervisorAction

An object that defines a hypervisor specific action.

HypervisorConfig

A mapping of hypervisor configuration keys to valid string values used to specify a set of hypervisor specific setting keys and their valid values.

HypervisorSetting

HypervisorSetting represents a hypervisor configuration setting.

IP

The IP class holds the data about an IP address

Image

The Image class is a virtual resource holding data about a server or disk image

ImagePermission

The ImagePermission class specifies the permissions on a given image

ImportVmSpec

A imported VM specification

InvalidationQueryResult

Object that represents an invalidation query result.

Invoice

The Invoice class holds the base data for each invoice.

InvoiceItem

The InvoiceItem class holds the base data for each line item on a invoice.

InvoiceSetting

A billing entity's settings for an invoice

JadeList

The JadeList class represents a list of strings

Job

The Job class is a virtual resource representing a job

KeyList

The KeyList class represents a list of resource keys and their values

LicenceInformation

Object containing licence information

ListResult

The ListResult class represents the result of a list call

MapHolder

A map between two object classes

MeasuredValue

A measured value measured from a resource

MeasurementFunction

The MeasurementFunction class represents an FDL defined function used in measuring resource usage.

Network

The Network class is a virtual object representing a layer 2 link between virtual NICs and (possibly) virtual routing devices

Nic

The Nic object is a virtual resource representing a virtual Network Interface Card (or NIC).

OrderedField

The orderedField class holds a field to order a query by, together with the direction of the ordering.

PaymentMethod

The PaymentMethod class represents a Payment Method.

PaymentMethodInstance

An instance of a payment method, mainly used by transactions.

PaymentProvider

The PaymentProvider class represents a Payment Provider.

Permission

The Permission object specifies an inheritable permission tuple on a particular resource.

PluggableResource

The PluggableResource class represents an instance of a resource defined by a PluggableResourceProvider.

PluggableResourceProvider

The PluggableResourceProvider class represents a pluggable resource provider defined in FDL.

Product

The Product class holds the base data for each product.

ProductComponent

The ProductComponent class represents the components of a product

ProductComponentType

The ProductComponentType class represents a Product Component Type.

ProductOffer

The ProductOffer class holds the base data for each product offer.

ProductPurchase

The ProductPurchase class holds the base data for each product purchase.

PromoCode

The PromoCode class holds the base data for each promo code.

Promotion

The Promotion class holds the base data for each promotion.

ProviderData

Provider data per resource type

PseudoResource

The PseudoResource class represents a pseudo-resource

PublishTo

The PublishTo class defines to whom a resource should be published.

PurchasedUnits

The PurchasedUnits class holds the base data for each purchase of units.

Query

The Query class specifies a complex database query.

QueryLimit

The QueryLimit class holds the base data for each query limit.

QueryResult

The QueryResult class contains the result of a complex query.

Question

The Question object represents a question to be asked of the deployer when a Deployment Instance is deployed.

ReferralPromoCode

The ReferralPromoCode class holds the base data for each referral promo code.

ReferralPromotion

The ReferralScheme class holds the base data for each referral scheme.

ReportMethod

ReportMethod class represents a FDL defined object that is used to generate reports and charts.

ResolvableReference

The ResolvableResult class represents the result of resolved/unresolved references

Resource

The Resource class is a base class which is the fundamental building block from which all resources in the system are derived.

ResourceKey

The ResourceKey class provides a key which can be attached to a given resource.

ResourceMetadata

The ResourceMetadata class implements metadata which can be attached to resources

ResourceTypeDefinition

The ResourceTypeDefinition object contains information about each resource type

ResultRow

The ResultRow class contains a row of the result of a complex query.

SSHKey

The SSHKey class describes an ssh key.

SearchFilter

The searchFilter class holds the base data for each search filter.

Server

The Server class is a virtual resource representing a server.

SimpleResource

This is a cutdown version of a Resource

Snapshot

The Snapshot class is a virtual resource representing a snapshot of a disk or a server.

StatementDetail

StatementDetail represent a single credit and/or debit event that occurs to a customer. This includes receiving and sending payments, generating an invoice, and generating a credit note.

StorageGroup

The StorageUnitGroup class is a hold the groupings of StorageUnits.

Subnet

The Subnet class is a virtual resource representing an IP subnet.

SystemCapabilitySet

The SystemCapabilitySet class describes the capabilities of the system or a subset thereof

Tax

An object that represents the simplified tax settings for an invoice or credit note

TemplateProtectionPermission

The TemplateProtectionPermission class sets out the protection afforded to instances of a deployment template.

Transaction

An instance of a payment transaction against an invoice using a particular payment method.

Translation

An object that represents a collection for values used for a translation.

TriggerMethod

The TriggerMethod class represents a Trigger Method.

UnitTransaction

The UnitTransaction class holds the base data for a unit transaction.

UnitTransactionSummary

The UnitTransactionSummary class holds the base data for each daily unit transaction summary.

User

The User class holds the base data for each user / contact.

UserDetails

The UserDetails class holds the base data for each user / contact.

VDC

The VirtualDataCentre class is a virtual resource which describes a virtual data centre.

VNCConnection

The VNCConnection object represents the authentication information to connect to a server.

Value

A value, whether configured or measured.

ValueDescriptionDetails

A lua defined object that defines the value state when being retreived through describe resource.

ValueValidator

The ValueValidator class represents a Value Validator object.

VirtualResource

The VirtualResource class is a resource is a base class on which all other virtual resources are based.

VncForwarderDetails

An object that represents the details required for VNC forwarding.

  • No labels