Class AsyncResponse
The AsyncResponse class encapsulates the data returned by a Cloud DNS
asynchronous response.
-
OpenCloud\Common\Base
-
OpenCloud\Common\PersistentObject
-
OpenCloud\DNS\Resource\AsyncResponse
Methods summary
public
|
#
__construct( OpenCloud\Common\Service\AbstractService $service, string $object = 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
- $object
string $json the json response from the initial request
Overrides
|
public
string
|
#
getUrl( mixed $path = null, array $query = array() )
URL for status
We always show details
Returns
string
Throws
UrlError
Overrides
|
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
|
public
HttpResponse
|
#
create( array $params = array() )
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
|
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
|
public
HttpResponse
|
#
delete( )
Deletes an object
Returns
HttpResponse
Throws
DeleteError if HTTP status is not Success
Api
Overrides
|
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
|
Methods inherited from OpenCloud\Common\PersistentObject
action(),
checkExtension(),
createJson(),
createUrl(),
findLink(),
getClient(),
getMetadata(),
getParent(),
getService(),
id(),
jsonCollectionElement(),
jsonCollectionName(),
jsonName(),
noCreate(),
noDelete(),
noUpdate(),
parseResponse(),
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()
|