Overview

Namespaces

  • None
  • OpenCloud
    • Autoscale
      • Resource
    • CloudMonitoring
      • Exception
      • Resource
    • Common
      • Exceptions
      • Log
      • Request
        • Response
    • Compute
    • Database
    • DNS
    • LoadBalancer
      • Resources
    • ObjectStore
      • Resource
    • Orchestration
    • Volume
  • PHP

Classes

  • AsyncResponse
  • Domain
  • Object
  • PtrRecord
  • Record
  • Service
  • Subdomain
  • Overview
  • Namespace
  • Class
  • Tree
  • Download

Class AsyncResponse

The AsyncResponse class encapsulates the data returned by a Cloud DNS asynchronous response.

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

constructs a new AsyncResponse object from a JSON string

constructs a new AsyncResponse object from a JSON string

Parameters

$service
OpenCloud\Service
$service the calling service
$json
string
$json the json response from the initial request

Overrides

OpenCloud\Common\PersistentObject::__construct()
public string
# url( string $subresource = null, array $qstr = array() )

URL for status

URL for status

We always show details

Parameters

$subresource
string
$subresource optional sub-resource string
$qstr
array
$qstr optional k/v pairs for query strings

Returns

string

Throws

UrlError
if URL is not defined

Overrides

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

returns the Name of the request (the job ID)

returns the Name of the request (the job ID)

Returns

string

Throws

NameError
if attribute 'name' is not defined

Overrides

OpenCloud\Common\PersistentObject::name()
public HttpResponse
# create( array $params = array() )

overrides for methods

overrides for methods

Parameters

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

Returns

HttpResponse

Throws

VolumeCreateError
if HTTP status is not Success

Overrides

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

Updates an existing object

Updates an existing object

Parameters

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

Returns

HttpResponse

Throws

VolumeCreateError
if HTTP status is not Success

Api

Overrides

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

Deletes an object

Deletes an object

Returns

HttpResponse

Throws

DeleteError
if HTTP status is not Success

Api

Overrides

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

Returns the primary key field for the object

Returns the primary key field for the object

The primary key is usually 'id', but this function is provided so that (in rare cases where it is not 'id'), it can be overridden.

Returns

string

Overrides

OpenCloud\Common\PersistentObject::primaryKeyField()
Methods inherited from OpenCloud\Common\PersistentObject
__set(), action(), checkExtension(), createJson(), createUrl(), customAction(), findLink(), getParent(), getService(), id(), jsonCollectionElement(), jsonCollectionName(), jsonName(), noCreate(), noDelete(), noUpdate(), parent(), refresh(), region(), resourceName(), service(), setParent(), setService(), status(), updateJson(), waitFor()
Methods inherited from OpenCloud\Common\Base
checkJsonError(), getHttpRequestObject(), getLogger(), makeQueryString(), populate(), setLogger(), setProperty()
Properties summary
public mixed $jobId
#
public mixed $callbackUrl
#
public mixed $status
#
public mixed $requestUrl
#
public mixed $verb
#
public mixed $request
#
public mixed $response
#
public mixed $error
#
public mixed $domains
#
protected static boolean $json_name false
#
Properties inherited from OpenCloud\Common\PersistentObject
$id
PHP OpenCloud API API documentation generated by ApiGen 2.8.0