Overview
  • Namespace
  • Class

Namespaces

  • OpenCloud
    • Autoscale
      • Resource
    • CDN
      • Resource
    • CloudMonitoring
      • Collection
      • Exception
      • Resource
    • Common
      • Collection
      • Constants
      • Exceptions
      • Http
        • Message
      • Log
      • Resource
      • Service
    • Compute
      • Constants
      • Exception
      • Resource
    • Database
      • Resource
    • DNS
      • Collection
      • Resource
    • Identity
      • Constants
      • Resource
    • Image
      • Enum
      • Resource
        • JsonPatch
        • Schema
    • LoadBalancer
      • Collection
      • Enum
      • Resource
    • Networking
      • Resource
    • ObjectStore
      • Constants
      • Enum
      • Exception
      • Resource
      • Upload
    • Orchestration
      • Resource
    • Queues
      • Collection
      • Exception
      • Resource
    • Volume
      • Resource

Classes

  • Claim
  • Message
  • Queue

Class Claim

A worker claims or checks out a message to perform a task. Doing so prevents other workers from attempting to process the same messages.

OpenCloud\Common\Base
Extended by OpenCloud\Common\Resource\BaseResource
Extended by OpenCloud\Common\Resource\PersistentResource
Extended by OpenCloud\Common\PersistentObject
Extended by OpenCloud\Queues\Resource\Claim
Namespace: OpenCloud\Queues\Resource
Located at OpenCloud/Queues/Resource/Claim.php

Methods summary

public
# setHref( $href )

Set the Href attribute and extrapolate the ID.

Set the Href attribute and extrapolate the ID.

Parameters

$href

Returns


$this
public string
# getHref( )

Returns

string
public string
# getId( )

Returns

string
public Guzzle\Http\Message\Response
# create( array $params = array() )

Create a new resource

Create a new resource

Parameters

$params

Returns

Guzzle\Http\Message\Response

Overrides

OpenCloud\Common\Resource\PersistentResource::create
public Guzzle\Http\Message\Response
# update( array $params = array() )

Updates the current Claim. It is recommended that you periodically renew claims during long-running batches of work to avoid losing a claim in the middle of processing a message. This is done by setting a new TTL for the claim (which may be different from the original TTL). The server will then reset the age of the claim and apply the new TTL. Update a resource

Updates the current Claim. It is recommended that you periodically renew claims during long-running batches of work to avoid losing a claim in the middle of processing a message. This is done by setting a new TTL for the claim (which may be different from the original TTL). The server will then reset the age of the claim and apply the new TTL. Update a resource

Parameters

$params

Returns

Guzzle\Http\Message\Response

Overrides

OpenCloud\Common\Resource\PersistentResource::update

Methods inherited from OpenCloud\Common\Resource\PersistentResource

checkExtension(), createUrl(), delete(), id(), name(), refresh(), refreshFromLocationUrl(), region(), status(), waitFor()

Methods inherited from OpenCloud\Common\Resource\BaseResource

__construct(), findLink(), getClient(), getMetadata(), getParent(), getService(), getUrl(), jsonCollectionElement(), jsonCollectionName(), jsonName(), parseResponse(), resourceName(), setMetadata(), setParent(), setService(), url()

Methods inherited from OpenCloud\Common\Base

__call(), checkJsonError(), generateUuid(), getInstance(), getLogger(), hasLogger(), makeResourceIteratorOptions(), populate(), setLogger(), stripNamespace(), toCamel(), toUnderscores()

Constants summary

integer LIMIT_DEFAULT
# 10
integer GRACE_DEFAULT
# 43200
integer TTL_DEFAULT
# 43200

Constants inherited from OpenCloud\Common\Base

PATCH_CONTENT_TYPE

API documentation generated by ApiGen