Class Message
A message is a task, a notification, or any meaningful data that gets posted
to the queue. A message exists until it is deleted by a recipient or
automatically by the system based on a TTL (time-to-live) value.
-
OpenCloud\Common\Base
-
OpenCloud\Common\Resource\BaseResource
-
OpenCloud\Common\Resource\PersistentResource
-
OpenCloud\Common\PersistentObject
-
OpenCloud\Queues\Resource\Message
Methods summary
public
OpenCloud\Queues\Resource\Message
|
#
setHref( string $href )
Set href (and ID).
Parameters
Returns
|
public
string
|
|
public
object
|
#
createJson( )
Provides JSON for create request body
Provides JSON for create request body
Returns
object object
Throws
Overrides
|
public
Guzzle\Http\Message\Response
|
#
create( array $params = array() )
Create a new resource
Parameters
Returns
Guzzle\Http\Message\Response \Guzzle\Http\Message\Response
Overrides
|
public
Guzzle\Http\Message\Response
|
#
update( array $params = array() )
Update a resource
Parameters
Returns
Guzzle\Http\Message\Response \Guzzle\Http\Message\Response
Overrides
|
public
boolean
|
#
delete( string $claimId = null )
This operation immediately deletes the specified message.
This operation immediately deletes the specified message.
Parameters
- $claimId
- Specifies that the message should be deleted only if it has the specified claim
ID, and that claim has not expired. This is useful for ensuring only one agent
processes any given message. Whenever a worker client's claim expires before it
has a chance to delete a message it has processed, the worker must roll back any
actions it took based on that message because another worker will now be able to
claim and process the same message. If you do <em>not</em> specify $claimId, but
the message is claimed, the operation fails. You can only delete claimed
messages by providing an appropriate $claimId.
Returns
boolean bool
Throws
Overrides
|
public
string
|
#
getClaimIdFromHref( )
If this message has been claimed, retrieve the claim id.
If this message has been claimed, retrieve the claim id.
Returns
string string
|
Methods inherited from OpenCloud\Common\Resource\PersistentResource
checkExtension(),
generateJsonPatch(),
getAlias(),
getUpdateablePropertiesAsArray(),
noCreate(),
noDelete(),
noUpdate(),
recursivelyAliasPropertyValue(),
refresh(),
refreshFromLocationUrl(),
refreshFromParent(),
updateJson(),
waitFor()
|
Methods inherited from OpenCloud\Common\Resource\BaseResource
__construct(),
findLink(),
getClient(),
getMetadata(),
getParent(),
getService(),
getUrl(),
jsonCollectionElement(),
jsonCollectionName(),
jsonName(),
parseResponse(),
primaryKeyField(),
resourceName(),
setMetadata(),
setParent(),
setService()
|
Methods inherited from OpenCloud\Common\Base
__call(),
checkJsonError(),
generateUuid(),
getInstance(),
getJsonHeader(),
getLogger(),
getPatchHeaders(),
getProperty(),
hasLogger(),
makeResourceIteratorOptions(),
populate(),
propertyExists(),
setLogger(),
setProperty(),
stripNamespace(),
toCamel(),
toUnderscores()
|