Overview

Namespaces

  • OpenCloud
    • Autoscale
      • Resource
    • CloudMonitoring
      • Exception
      • Resource
    • Common
      • Collection
      • Constants
      • Exceptions
      • Http
        • Message
      • Identity
      • Log
      • Service
    • Compute
      • Constants
      • Exception
      • Resource
    • Database
      • Resource
    • DNS
      • Resource
    • LoadBalancer
      • Resource
    • ObjectStore
      • Constants
      • Exception
      • Resource
      • Upload
    • Orchestration
    • Queues
      • Exception
      • Resource
    • Volume
      • Resource
  • PHP

Classes

  • Flavor
  • Image
  • KeyPair
  • Network
  • Server
  • ServerMetadata
  • VolumeAttachment
  • Overview
  • Namespace
  • Class
  • Tree
  • Download

Class Network

The Network class represents a single virtual network

OpenCloud\Common\Base
Extended by OpenCloud\Common\PersistentObject
Extended by OpenCloud\Compute\Resource\Network
Namespace: OpenCloud\Compute\Resource
Located at OpenCloud/Compute/Resource/Network.php
Methods summary
public
# __construct( OpenCloud\Compute\Service $service, string $id = null )

Creates a new isolated Network object

Creates a new isolated Network object

NOTE: contains hacks to recognize the Rackspace public and private networks. These are not really networks, but they show up in lists.

Parameters

$service
OpenCloud\Compute
$service The compute service associated with the network
$id
string
$id The ID of the network (this handles the pseudo-networks Network::RAX_PUBLIC and Network::RAX_PRIVATE

Overrides

OpenCloud\Common\PersistentObject::__construct()
public HttpResponse
# update( array $params = array() )

Always throws an error; updates are not permitted

Always throws an error; updates are not permitted

Parameters

$params
array
$params array of values to set when updating the object

Returns

HttpResponse

Throws

NetworkUpdateError
always

Overrides

OpenCloud\Common\PersistentObject::update()
public OpenCloud\HttpResponse
# delete( )

Deletes an isolated network

Deletes an isolated network

Returns

OpenCloud\HttpResponse

Throws

NetworkDeleteError
if HTTP status is not Success

Api

Overrides

OpenCloud\Common\PersistentObject::delete()
public string
# name( )

returns the visible name (label) of the network

returns the visible name (label) of the network

Returns

string

Throws

NameError
if attribute 'name' is not defined

Api

Overrides

OpenCloud\Common\PersistentObject::name()
protected
# createJson( )

Creates the JSON object for the Create() method

Creates the JSON object for the Create() method

Throws

CreateError
if not overridden

Overrides

OpenCloud\Common\PersistentObject::createJson()
Methods inherited from OpenCloud\Common\PersistentObject
action(), checkExtension(), create(), createUrl(), findLink(), getClient(), getMetadata(), getParent(), getService(), getUrl(), id(), jsonCollectionElement(), jsonCollectionName(), jsonName(), noCreate(), noDelete(), noUpdate(), parseResponse(), primaryKeyField(), refresh(), refreshFromLocationUrl(), region(), resourceName(), setMetadata(), setParent(), setService(), status(), updateJson(), url(), waitFor()
Methods inherited from OpenCloud\Common\Base
__call(), checkJsonError(), generateUuid(), getLogger(), getProperty(), makeResourceIteratorOptions(), populate(), propertyExists(), setLogger(), setProperty(), stripNamespace(), toCamel(), toUnderscores()
Properties summary
public mixed $id
#
public mixed $label
#
public mixed $cidr
#
protected static string $json_name 'network'
#
protected static string $url_resource 'os-networksv2'
#
Properties inherited from OpenCloud\Common\PersistentObject
$metadata
PHP OpenCloud API API documentation generated by ApiGen 2.8.0