OpenCloud/Compute/ServerMetadata.php

Classes |

Properties

author

package

version

Description

Specialized metadata for OpenStack Server objects (metadata items can be managed individually or in aggregate)

Classes

ServerMetadata

Properties

Extends

Implements

author

Glen Campbell s

Abstract

Final

Description

This class handles server metadata
Server metadata is a weird beast in that it has resource representations and HTTP calls to set the entire server metadata as well as individual items.

Methods

Create, Delete, GetMetadataJson, Parent, Update, Url, __construct, __set,

Create( ) : void

Description

Sets a new metadata value or block
Note that, if you're setting a block, the block specified will *entirely replace* the existing block.

Return value

Type	Description
void

Tags

Name	Description
api
throws

Delete( ) : void

Description

Deletes a metadata key or block

Return value

Type	Description
void

Tags

Name	Description
api
throws

GetMetadataJson( ) : string

Description

Builds a metadata JSON string

Return value

Type	Description
string

Tags

Name	Description
throws

Parent( ) : \OpenCloud\Compute\Server

Description

Returns the parent Server object

Return value

Type	Description
\OpenCloud\Compute\Server

Update( ) : void

Description

Updates a metadata key or block

Return value

Type	Description
void

Tags

Name	Description
api
throws

Url( string $subresource = '', ) : string

Description

Returns the URL of the metadata (key or block)

Arguments

Name	Type	Description	Default
$subresource	string	not used; required for strict compatibility	''

Return value

Type	Description
string

Tags

Name	Description
throws

__construct( object $parent, string $key = NULL, ) : n/a

Description

Contructs a Metadata object associated with a Server or Image object

Arguments

Name	Type	Description	Default
$parent	object	either a Server or an Image object
$key	string	the (optional) key for the metadata item	NULL

Return value

Type	Description
n/a	n/a

Tags

Name	Description
throws

__set( string $key, string $value, ) : void

Description

Overrides the base setter method, since the metadata key can be anything (no name-checking is required)

Arguments

Name	Type	Description	Default
$key	string
$value	string

Return value

Type	Description
void

Tags

Name	Description
throws

Properties

$_key, $_parent, $_url,

private $_key =

private $_parent =

private $_url =

Namespaces

OpenCloud

OpenStack
The OpenStack class represents a relationship (or "connection") between a user and a service.
Rackspace
Rackspace extends the OpenStack class with support for Rackspace's API key and tenant requirements.
Autoscale
- Service
  The Autoscale class represents the OpenStack Heat service.
CloudMonitoring
- Service
  The Rackspace Cloud Monitoring service.
- Exception
- Resource
  - AbstractResource
    Abstract AbstractResource class.
  - Account
    Account class.
  - Agent
    Agent class.
  - AgentConnection
    AgentConnection class.
  - AgentHost
    Agent class.
  - AgentHostInfo
    Agent class.
  - AgentTarget
    Agent class.
  - AgentToken
    Agent class.
  - Alarm
    Alarm class.
  - Changelog
    Changelog class.
  - Check
    Check class.
  - CheckType
    CheckType class.
  - Entity
    Entity class.
  - Metric
    Metric class.
  - Notification
    Notification class.
  - NotificationHistory
    NotificationHistory class.
  - NotificationPlan
    Abstract AbstractResource class.
  - NotificationType
    NotificationType class.
  - ReadonlyResource
    ReadonlyResource class.
  - ResourceInterface
    ResourceInterface interface.
  - View
    View class.
  - Zone
    Zone class.
Common
- Base
  The Base class is the root class for all other objects used or defined by this SDK.
- Collection
  Provides an abstraction for working with ordered sets of objects
- Debug
- Lang
- Metadata
  The Metadata class represents either Server or Image metadata
- Nova
  Nova is an abstraction layer for the OpenStack compute service.
- ObjectStore
  Intermediate (abstract) class to implement shared features of all object-storage classes
- PersistentObject
  represents an object that has the ability to be retrieved, created, updated, and deleted.
- Service
  This class defines a "service"—a relationship between a specific OpenStack and a provided service, represented by a URL in the service catalog.
- ServiceCatalogItem
  Holds information on a single service from the Service Catalog
- Exceptions
- Request
  - Curl
    The CurlRequest class is a simple wrapper to CURL functions. Not only does this permit stubbing of the interface as described under the HttpRequest interface, it could potentially allow us to replace the interface methods with other function calls in the future.
  - HttpRequestInterface
    The HttpRequest interface defines methods for wrapping CURL; this allows those methods to be stubbed out for unit testing, thus allowing us to test without actually making live calls.
  - Response
    - Blank
      The HttpResponse returns an object with status information, separated headers, and any response body necessary.
    - Http
      The HttpResponse returns an object with status information, separated headers, and any response body necessary.
Compute
- Flavor
  The Flavor class represents a flavor defined by the Compute service
- Image
  The Image class represents a stored machine image returned by the Compute service.
- Network
  The Network class represents a single virtual network
- Server
  The Server class represents a single server node.
- ServerMetadata
  This class handles server metadata
- Service
  The Compute class represents the OpenStack Nova service.
- VolumeAttachment
  The VolumeAttachment class represents a volume that is attached to a server.
DNS
- AsyncResponse
  The AsyncResponse class encapsulates the data returned by a Cloud DNS asynchronous response.
- Domain
  The Domain class represents a single domain
- Object
  The DnsObject class is an extension of the PersistentObject class that permits the asynchronous responses used by Cloud DNS
- PtrRecord
  PTR records are used for reverse DNS
- Record
  The Record class represents a single domain record
- Service
  This class defines a "service"—a relationship between a specific OpenStack and a provided service, represented by a URL in the service catalog.
- Subdomain
  The Subdomain is basically another domain, albeit one that is a child of a parent domain. In terms of the code involved, the JSON is slightly different than a top-level domain, and the parent is a domain instead of the DNS service itself.
Database
- Database
  This class represents a Database in the Rackspace "Red Dwarf" database-as-a-service product.
- Instance
  Instance represents an instance of DbService, similar to a Server in a Compute service
- Service
  The Rackspace Database As A Service (aka "Red Dwarf")
- User
  This class represents a User in the Rackspace "Red Dwarf" database-as-a-service product.
LoadBalancer
- Algorithm
  sub-resource to manage algorithms (read-only)
- AllowedDomain
  sub-resource to manage allowed domains
- BillableLoadBalancer
  used to get a list of billable load balancers for a specific date range
- LoadBalancer
  The LoadBalancer class represents a single load balancer
- Protocol
  sub-resource to manage protocols (read-only)
- Service
  The Rackspace Cloud Load Balancers
- Resources
  - Access
    sub-resource to manage access lists
  - ConnectionLogging
    sub-resource to manage connection logging
  - ConnectionThrottle
    sub-resource to manage connection throttling
  - ContentCaching
    sub-resource to manage content caching
  - ErrorPage
    The /loadbalancer/{id}/errorpage manages the error page for the load balancer.
  - HealthMonitor
    sub-resource to manage health monitor info
  - Metadata
    sub-resource to manage Metadata
  - Node
    information on a single node in the load balancer
  - NodeEvent
    a single node event, usually called as part of a Collection
  - Readonly
    This defines a read-only SubResource - one that cannot be created, updated, or deleted. Many subresources are like this, and this simplifies their class definitions.
  - SSLTermination
    sub-resource to manage SSL termination
  - SessionPersistence
    sub-resource to manage session persistence setting
  - Stats
    Stats returns statistics about the load balancer
  - SubResource
    SubResource is an abstract class that handles subresources of a LoadBalancer object; for example, the `/loadbalancers/{id}/errorpage`. Since most of the subresources are handled in a similar manner, this consolidates the functions.
  - Usage
    used to get usage data for a load balancer
  - VirtualIp
    VirtualIp represents a single virtual IP (usually returned in a Collection)
ObjectStore
- CDNContainer
  A simple container for the CDN Service
- Container
  A regular container with a (potentially) CDN container
- DataObject
  A DataObject is an object in the ObjectStore
- ObjectStoreBase
  A base class for common code shared between the ObjectStore and ObjectStoreCDN objects
- ObjectStoreCDN
  This is the CDN related to the ObjectStore
- Service
  ObjectStore - this defines the object-store (Cloud Files) service.
Orchestration
- Resource
- Service
  The Orchestration class represents the OpenStack Heat service.
- Stack
  The Stack class requires a CloudFormation template and may contain additional parameters for that template.
Volume
- Service
  Nova is an abstraction layer for the OpenStack compute service.
- Snapshot
  The Snapshot class represents a single block storage snapshot
- Volume
  The Volume class represents a single block storage volume
- VolumeType
  The VolumeType class represents a single block storage volume type

global

Packages

Default

AbstractResource
Abstract AbstractResource class.
Access
sub-resource to manage access lists
Account
Account class.
Agent
Agent class.
AgentConnection
AgentConnection class.
AgentException
AgentHost
Agent class.
AgentHostInfo
Agent class.
AgentTarget
Agent class.
AgentToken
Agent class.
Alarm
Alarm class.
AlarmException
Algorithm
sub-resource to manage algorithms (read-only)
AllowedDomain
sub-resource to manage allowed domains
AsyncError
AsyncHttpError
AsyncResponse
The AsyncResponse class encapsulates the data returned by a Cloud DNS asynchronous response.
AsyncTimeoutError
AttributeError
AuthenticationError
Base
The Base class is the root class for all other objects used or defined by this SDK.
BaseException
BillableLoadBalancer
used to get a list of billable load balancers for a specific date range
Blank
The HttpResponse returns an object with status information, separated headers, and any response body necessary.
CDNContainer
A simple container for the CDN Service
CdnError
CdnHttpError
CdnNotAvailableError
CdnTtlError
Changelog
Changelog class.
Check
Check class.
CheckException
CheckType
CheckType class.
ClassLoader
CloudMonitoringException
Collection
Provides an abstraction for working with ordered sets of objects
CollectionError
ConnectionLogging
sub-resource to manage connection logging
ConnectionThrottle
sub-resource to manage connection throttling
Container
A regular container with a (potentially) CDN container
ContainerCreateError
ContainerDeleteError
ContainerError
ContainerNameError
ContainerNotEmptyError
ContainerNotFoundError
ContentCaching
sub-resource to manage content caching
CreateError
CreateUpdateError
CredentialError
Curl
The CurlRequest class is a simple wrapper to CURL functions. Not only does this permit stubbing of the interface as described under the HttpRequest interface, it could potentially allow us to replace the interface methods with other function calls in the future.
DataObject
A DataObject is an object in the ObjectStore
Database
This class represents a Database in the Rackspace "Red Dwarf" database-as-a-service product.
DatabaseCreateError
DatabaseDeleteError
DatabaseListError
DatabaseNameError
DatabaseUpdateError
Debug
DeleteError
DocumentError
Domain
The Domain class represents a single domain
DomainError
EmptyResponseError
EndpointError
Entity
Entity class.
EntityException
ErrorPage
The /loadbalancer/{id}/errorpage manages the error page for the load balancer.
Flavor
The Flavor class represents a flavor defined by the Compute service
FlavorError
HealthMonitor
sub-resource to manage health monitor info
Http
The HttpResponse returns an object with status information, separated headers, and any response body necessary.
HttpError
HttpForbiddenError
HttpOverLimitError
HttpRequestInterface
The HttpRequest interface defines methods for wrapping CURL; this allows those methods to be stubbed out for unit testing, thus allowing us to test without actually making live calls.
HttpRetryError
HttpTimeoutError
HttpUnauthorizedError
HttpUrlError
IOError
IdRequiredError
Image
The Image class represents a stored machine image returned by the Compute service.
ImageError
Instance
Instance represents an instance of DbService, similar to a Server in a Compute service
InstanceCreateError
InstanceDeleteError
InstanceError
InstanceFlavorError
InstanceNotFound
InstanceUpdateError
InvalidArgumentError
InvalidIdTypeError
InvalidIpTypeError
InvalidParameterError
InvalidRequestError
JsonError
Lang
LoadBalancer
The LoadBalancer class represents a single load balancer
Metadata
The Metadata class represents either Server or Image metadata
Metadata
sub-resource to manage Metadata
MetadataCreateError
MetadataDeleteError
MetadataError
MetadataJsonError
MetadataKeyError
MetadataPrefixError
MetadataUpdateError
Metric
Metric class.
MetricException
MisMatchedChecksumError
MissingValueError
NameError
Network
The Network class represents a single virtual network
NetworkCreateError
NetworkDeleteError
NetworkError
NetworkUpdateError
NetworkUrlError
NoContentTypeError
NoNameError
Node
information on a single node in the load balancer
NodeEvent
a single node event, usually called as part of a Collection
Notification
Notification class.
NotificationHistory
NotificationHistory class.
NotificationHistoryException
NotificationPlan
Abstract AbstractResource class.
NotificationPlanException
NotificationType
NotificationType class.
Nova
Nova is an abstraction layer for the OpenStack compute service.
ObjFetchError
Object
The DnsObject class is an extension of the PersistentObject class that permits the asynchronous responses used by Cloud DNS
ObjectCopyError
ObjectError
ObjectStore
Intermediate (abstract) class to implement shared features of all object-storage classes
ObjectStoreBase
A base class for common code shared between the ObjectStore and ObjectStoreCDN objects
ObjectStoreCDN
This is the CDN related to the ObjectStore
OpenStack
The OpenStack class represents a relationship (or "connection") between a user and a service.
PersistentObject
represents an object that has the ability to be retrieved, created, updated, and deleted.
Protocol
sub-resource to manage protocols (read-only)
PtrRecord
PTR records are used for reverse DNS
Rackspace
Rackspace extends the OpenStack class with support for Rackspace's API key and tenant requirements.
Readonly
This defines a read-only SubResource - one that cannot be created, updated, or deleted. Many subresources are like this, and this simplifies their class definitions.
ReadonlyResource
ReadonlyResource class.
RebuildError
Record
The Record class represents a single domain record
RecordTypeError
Resource
ResourceInterface
ResourceInterface interface.
SSLTermination
sub-resource to manage SSL termination
Server
The Server class represents a single server node.
ServerActionError
ServerCreateError
ServerDeleteError
ServerIpsError
ServerJsonError
ServerMetadata
This class handles server metadata
ServerUpdateError
ServerUrlError
Service
The Autoscale class represents the OpenStack Heat service.
Service
The Rackspace Cloud Monitoring service.
Service
This class defines a "service"—a relationship between a specific OpenStack and a provided service, represented by a URL in the service catalog.
Service
The Compute class represents the OpenStack Nova service.
Service
The Rackspace Database As A Service (aka "Red Dwarf")
Service
This class defines a "service"—a relationship between a specific OpenStack and a provided service, represented by a URL in the service catalog.
Service
The Rackspace Cloud Load Balancers
Service
ObjectStore - this defines the object-store (Cloud Files) service.
Service
The Orchestration class represents the OpenStack Heat service.
Service
Nova is an abstraction layer for the OpenStack compute service.
ServiceCatalogItem
Holds information on a single service from the Service Catalog
ServiceException
ServiceValueError
SessionPersistence
sub-resource to manage session persistence setting
Snapshot
The Snapshot class represents a single block storage snapshot
SnapshotError
Stack
The Stack class requires a CloudFormation template and may contain additional parameters for that template.
Stats
Stats returns statistics about the load balancer
SubResource
SubResource is an abstract class that handles subresources of a LoadBalancer object; for example, the `/loadbalancers/{id}/errorpage`. Since most of the subresources are handled in a similar manner, this consolidates the functions.
Subdomain
The Subdomain is basically another domain, albeit one that is a child of a parent domain. In terms of the code involved, the JSON is slightly different than a top-level domain, and the parent is a domain instead of the DNS service itself.
TempUrlMethodError
TestException
UnknownError
UnknownParameterError
UnrecognizedServiceError
UnsupportedExtensionError
UnsupportedFeatureExtension
UnsupportedVersionError
UpdateError
UrlError
Usage
used to get usage data for a load balancer
User
This class represents a User in the Rackspace "Red Dwarf" database-as-a-service product.
UserCreateError
UserDeleteError
UserListError
UserNameError
UserUpdateError
View
View class.
VirtualIp
VirtualIp represents a single virtual IP (usually returned in a Collection)
Volume
The Volume class represents a single block storage volume
VolumeAttachment
The VolumeAttachment class represents a volume that is attached to a server.
VolumeError
VolumeType
The VolumeType class represents a single block storage volume type
VolumeTypeError
Zone
Zone class.
ZoneException

global

phpOpenCloud

AbstractResource
Abstract AbstractResource class.
Service
The Rackspace Cloud Monitoring service.