€cdocutils.nodes
document
q)q}q(U	nametypesq}q(X   infoqNX   setupqNX   create entityqNX   entitiesq	NX   update and delete entityq
NX
   attributesqNuUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU
decorationqNUautofootnote_startqKUnameidsq}q(hUinfoqhUsetupqhUcreate-entityqh	Uentitiesqh
Uupdate-and-delete-entityqhU
attributesquUchildrenq]qcdocutils.nodes
section
q)q}q(U	rawsourceq U Uparentq!hUsourceq"XO   /Users/jamie/projects/php/php-opencloud/doc/services/monitoring/Entities.md.rstq#Utagnameq$Usectionq%U
attributesq&}q'(Udupnamesq(]Uclassesq)]Ubackrefsq*]Uidsq+]q,haUnamesq-]q.h	auUlineq/KUdocumentq0hh]q1(cdocutils.nodes
title
q2)q3}q4(h X
   Â Entitiesq5h!hh"h#h$Utitleq6h&}q7(h(]h)]h*]h+]h-]uh/Kh0hh]q8cdocutils.nodes
Text
q9X
   Â Entitiesq:…q;}q<(h h5h!h3ubaubh)q=}q>(h U h!hh"h#h$h%h&}q?(h(]h)]h*]h+]q@hah-]qAhauh/Kh0hh]qB(h2)qC}qD(h X   InfoqEh!h=h"h#h$h6h&}qF(h(]h)]h*]h+]h-]uh/Kh0hh]qGh9X   InfoqH…qI}qJ(h hEh!hCubaubcdocutils.nodes
paragraph
qK)qL}qM(h Xœ  An entity is the target of what you are monitoring. For example, you can
create an entity to monitor your website, a particular web service, or
your Rackspace server. Note that an entity represents only one item in
the monitoring system -- if you wanted to monitor each server in a
cluster, you would create an entity for each of the servers. You would
not create a single entity to represent the entire cluster.qNh!h=h"h#h$U	paragraphqOh&}qP(h(]h)]h*]h+]h-]uh/Kh0hh]qQh9Xœ  An entity is the target of what you are monitoring. For example, you can
create an entity to monitor your website, a particular web service, or
your Rackspace server. Note that an entity represents only one item in
the monitoring system -- if you wanted to monitor each server in a
cluster, you would create an entity for each of the servers. You would
not create a single entity to represent the entire cluster.qR…qS}qT(h hNh!hLubaubhK)qU}qV(h XÙ   An entity can have multiple checks associated with it. This allows you
to check multiple services on the same host by creating multiple checks
on the same entity, instead of multiple entities each with a single
check.qWh!h=h"h#h$hOh&}qX(h(]h)]h*]h+]h-]uh/Kh0hh]qYh9XÙ   An entity can have multiple checks associated with it. This allows you
to check multiple services on the same host by creating multiple checks
on the same entity, instead of multiple entities each with a single
check.qZ…q[}q\(h hWh!hUubaubeubh)q]}q^(h U h!hh"h#h$h%h&}q_(h(]h)]h*]h+]q`hah-]qahauh/Kh0hh]qb(h2)qc}qd(h X   Setupqeh!h]h"h#h$h6h&}qf(h(]h)]h*]h+]h-]uh/Kh0hh]qgh9X   Setupqh…qi}qj(h heh!hcubaubcdocutils.nodes
literal_block
qk)ql}qm(h X    $entity = $service->getEntity();h!h]h"h#h$Uliteral_blockqnh&}qo(U	xml:spaceqpUpreserveqqh+]h*]h(]h)]qr(UcodeqsX   phpqteh-]uh/Kh0hh]qucdocutils.nodes
inline
qv)qw}qx(h X    $entity = $service->getEntity();h&}qy(h(]h)]qzUotherq{ah*]h+]h-]uh!hlh]q|h9X    $entity = $service->getEntity();q}…q~}q(h U h!hwubah$Uinlineq€ubaubhK)q}q‚(h X   For more information about setting up the ``$service`` object, please
see the userguide tutorial for `services <Service.md>`__.h!h]h"h#h$hOh&}qƒ(h(]h)]h*]h+]h-]uh/Kh0hh]q„(h9X*   For more information about setting up the q……q†}q‡(h X*   For more information about setting up the h!hubcdocutils.nodes
literal
qˆ)q‰}qŠ(h X   ``$service``h&}q‹(h(]h)]h*]h+]h-]uh!hh]qŒh9X   $serviceq…qŽ}q(h U h!h‰ubah$Uliteralqubh9X/    object, please
see the userguide tutorial for q‘…q’}q“(h X/    object, please
see the userguide tutorial for h!hubcdocutils.nodes
reference
q”)q•}q–(h X   `services <Service.md>`__h&}q—(UnameX   servicesUrefuriq˜X
   Service.mdh+]h*]h(]h)]h-]uh!hh]q™h9X   servicesqš…q›}qœ(h U h!h•ubah$U	referencequbh9X   .…qž}qŸ(h X   .h!hubeubeubh)q }q¡(h U h!hh"h#h$h%h&}q¢(h(]h)]h*]h+]q£hah-]q¤hauh/Kh0hh]q¥(h2)q¦}q§(h X
   Attributesq¨h!h h"h#h$h6h&}q©(h(]h)]h*]h+]h-]uh/Kh0hh]qªh9X
   Attributesq«…q¬}q­(h h¨h!h¦ubaubcdocutils.nodes
table
q®)q¯}q°(h U h!h h"h#h$Utableq±h&}q²(h(]h)]h*]h+]h-]uh/Nh0hh]q³cdocutils.nodes
tgroup
q´)qµ}q¶(h U h&}q·(h+]h*]h(]h)]h-]UcolsKuh!h¯h]q¸(cdocutils.nodes
colspec
q¹)qº}q»(h U h&}q¼(h+]h*]h(]h)]h-]UcolwidthKuh!hµh]h$Ucolspecq½ubh¹)q¾}q¿(h U h&}qÀ(h+]h*]h(]h)]h-]UcolwidthKIuh!hµh]h$h½ubh¹)qÁ}qÂ(h U h&}qÃ(h+]h*]h(]h)]h-]UcolwidthKuh!hµh]h$h½ubh¹)qÄ}qÅ(h U h&}qÆ(h+]h*]h(]h)]h-]UcolwidthK5uh!hµh]h$h½ubh¹)qÇ}qÈ(h U h&}qÉ(h+]h*]h(]h)]h-]UcolwidthKuh!hµh]h$h½ubcdocutils.nodes
thead
qÊ)qË}qÌ(h U h&}qÍ(h(]h)]h*]h+]h-]uh!hµh]qÎcdocutils.nodes
row
qÏ)qÐ}qÑ(h U h&}qÒ(h(]h)]h*]h+]h-]uh!hËh]qÓ(cdocutils.nodes
entry
qÔ)qÕ}qÖ(h U h&}q×(h(]h)]h*]h+]h-]uh!hÐh]qØhK)qÙ}qÚ(h X   NameqÛh!hÕh"h#h$hOh&}qÜ(h(]h)]h*]h+]h-]uh/K!h]qÝh9X   NameqÞ…qß}qà(h hÛh!hÙubaubah$UentryqáubhÔ)qâ}qã(h U h&}qä(h(]h)]h*]h+]h-]uh!hÐh]qåhK)qæ}qç(h X   Descriptionqèh!hâh"h#h$hOh&}qé(h(]h)]h*]h+]h-]uh/K!h]qêh9X   Descriptionqë…qì}qí(h hèh!hæubaubah$háubhÔ)qî}qï(h U h&}qð(h(]h)]h*]h+]h-]uh!hÐh]qñhK)qò}qó(h X	   Required?qôh!hîh"h#h$hOh&}qõ(h(]h)]h*]h+]h-]uh/K!h]qöh9X	   Required?q÷…qø}qù(h hôh!hòubaubah$háubhÔ)qú}qû(h U h&}qü(h(]h)]h*]h+]h-]uh!hÐh]qýhK)qþ}qÿ(h X	   Data typer   h!húh"h#h$hOh&}r  (h(]h)]h*]h+]h-]uh/K!h]r  h9X	   Data typer  …r  }r  (h j   h!hþubaubah$háubhÔ)r  }r  (h U h&}r  (h(]h)]h*]h+]h-]uh!hÐh]r	  hK)r
  }r  (h X   Methodr  h!j  h"h#h$hOh&}r  (h(]h)]h*]h+]h-]uh/K!h]r  h9X   Methodr  …r  }r  (h j  h!j
  ubaubah$háubeh$Urowr  ubah$Utheadr  ubcdocutils.nodes
tbody
r  )r  }r  (h U h&}r  (h(]h)]h*]h+]h-]uh!hµh]r  (hÏ)r  }r  (h U h&}r  (h(]h)]h*]h+]h-]uh!j  h]r  (hÔ)r  }r  (h U h&}r  (h(]h)]h*]h+]h-]uh!j  h]r   hK)r!  }r"  (h X   labelr#  h!j  h"h#h$hOh&}r$  (h(]h)]h*]h+]h-]uh/K#h]r%  h9X   labelr&  …r'  }r(  (h j#  h!j!  ubaubah$háubhÔ)r)  }r*  (h U h&}r+  (h(]h)]h*]h+]h-]uh!j  h]r,  hK)r-  }r.  (h X   Defines a name for the entity.r/  h!j)  h"h#h$hOh&}r0  (h(]h)]h*]h+]h-]uh/K#h]r1  h9X   Defines a name for the entity.r2  …r3  }r4  (h j/  h!j-  ubaubah$háubhÔ)r5  }r6  (h U h&}r7  (h(]h)]h*]h+]h-]uh!j  h]r8  hK)r9  }r:  (h X   Requiredr;  h!j5  h"h#h$hOh&}r<  (h(]h)]h*]h+]h-]uh/K#h]r=  h9X   Requiredr>  …r?  }r@  (h j;  h!j9  ubaubah$háubhÔ)rA  }rB  (h U h&}rC  (h(]h)]h*]h+]h-]uh!j  h]rD  hK)rE  }rF  (h X   String (1..255 chars)rG  h!jA  h"h#h$hOh&}rH  (h(]h)]h*]h+]h-]uh/K#h]rI  h9X   String (1..255 chars)rJ  …rK  }rL  (h jG  h!jE  ubaubah$háubhÔ)rM  }rN  (h U h&}rO  (h(]h)]h*]h+]h-]uh!j  h]rP  hK)rQ  }rR  (h X   ``getLabel()``rS  h!jM  h"h#h$hOh&}rT  (h(]h)]h*]h+]h-]uh/K#h]rU  hˆ)rV  }rW  (h jS  h&}rX  (h(]h)]h*]h+]h-]uh!jQ  h]rY  h9X
   getLabel()rZ  …r[  }r\  (h U h!jV  ubah$hubaubah$háubeh$j  ubhÏ)r]  }r^  (h U h&}r_  (h(]h)]h*]h+]h-]uh!j  h]r`  (hÔ)ra  }rb  (h U h&}rc  (h(]h)]h*]h+]h-]uh!j]  h]rd  hK)re  }rf  (h X	   agent\_idh!ja  h"h#h$hOh&}rg  (h(]h)]h*]h+]h-]uh/K%h]rh  h9X   agent_idri  …rj  }rk  (h X	   agent\_idh!je  ubaubah$háubhÔ)rl  }rm  (h U h&}rn  (h(]h)]h*]h+]h-]uh!j]  h]ro  hK)rp  }rq  (h X'   Agent to which this entity is bound to.rr  h!jl  h"h#h$hOh&}rs  (h(]h)]h*]h+]h-]uh/K%h]rt  h9X'   Agent to which this entity is bound to.ru  …rv  }rw  (h jr  h!jp  ubaubah$háubhÔ)rx  }ry  (h U h&}rz  (h(]h)]h*]h+]h-]uh!j]  h]r{  hK)r|  }r}  (h X   Optionalr~  h!jx  h"h#h$hOh&}r  (h(]h)]h*]h+]h-]uh/K%h]r€  h9X   Optionalr  …r‚  }rƒ  (h j~  h!j|  ubaubah$háubhÔ)r„  }r…  (h U h&}r†  (h(]h)]h*]h+]h-]uh!j]  h]r‡  hK)rˆ  }r‰  (h X1   String matching the regex: ``/^[-\.\w]{1,255}$/``h!j„  h"h#h$hOh&}rŠ  (h(]h)]h*]h+]h-]uh/K%h]r‹  (h9X   String matching the regex: rŒ  …r  }rŽ  (h X   String matching the regex: h!jˆ  ubhˆ)r  }r  (h X   ``/^[-\.\w]{1,255}$/``h&}r‘  (h(]h)]h*]h+]h-]uh!jˆ  h]r’  h9X   /^[-\.\w]{1,255}$/r“  …r”  }r•  (h U h!j  ubah$hubeubah$háubhÔ)r–  }r—  (h U h&}r˜  (h(]h)]h*]h+]h-]uh!j]  h]r™  hK)rš  }r›  (h X   ``getAgentId()``rœ  h!j–  h"h#h$hOh&}r  (h(]h)]h*]h+]h-]uh/K%h]rž  hˆ)rŸ  }r   (h jœ  h&}r¡  (h(]h)]h*]h+]h-]uh!jš  h]r¢  h9X   getAgentId()r£  …r¤  }r¥  (h U h!jŸ  ubah$hubaubah$háubeh$j  ubhÏ)r¦  }r§  (h U h&}r¨  (h(]h)]h*]h+]h-]uh!j  h]r©  (hÔ)rª  }r«  (h U h&}r¬  (h(]h)]h*]h+]h-]uh!j¦  h]r­  hK)r®  }r¯  (h X   ip\_addressesh!jª  h"h#h$hOh&}r°  (h(]h)]h*]h+]h-]uh/K'h]r±  h9X   ip_addressesr²  …r³  }r´  (h X   ip\_addressesh!j®  ubaubah$háubhÔ)rµ  }r¶  (h U h&}r·  (h(]h)]h*]h+]h-]uh!j¦  h]r¸  hK)r¹  }rº  (h XE   Hash of IP addresses that can be referenced by checks on this entity.r»  h!jµ  h"h#h$hOh&}r¼  (h(]h)]h*]h+]h-]uh/K'h]r½  h9XE   Hash of IP addresses that can be referenced by checks on this entity.r¾  …r¿  }rÀ  (h j»  h!j¹  ubaubah$háubhÔ)rÁ  }rÂ  (h U h&}rÃ  (h(]h)]h*]h+]h-]uh!j¦  h]rÄ  hK)rÅ  }rÆ  (h X   OptionalrÇ  h!jÁ  h"h#h$hOh&}rÈ  (h(]h)]h*]h+]h-]uh/K'h]rÉ  h9X   OptionalrÊ  …rË  }rÌ  (h jÇ  h!jÅ  ubaubah$háubhÔ)rÍ  }rÎ  (h U h&}rÏ  (h(]h)]h*]h+]h-]uh!j¦  h]rÐ  hK)rÑ  }rÒ  (h X   ArrayrÓ  h!jÍ  h"h#h$hOh&}rÔ  (h(]h)]h*]h+]h-]uh/K'h]rÕ  h9X   ArrayrÖ  …r×  }rØ  (h jÓ  h!jÑ  ubaubah$háubhÔ)rÙ  }rÚ  (h U h&}rÛ  (h(]h)]h*]h+]h-]uh!j¦  h]rÜ  hK)rÝ  }rÞ  (h X   ``getIpAddresses()``rß  h!jÙ  h"h#h$hOh&}rà  (h(]h)]h*]h+]h-]uh/K'h]rá  hˆ)râ  }rã  (h jß  h&}rä  (h(]h)]h*]h+]h-]uh!jÝ  h]rå  h9X   getIpAddresses()ræ  …rç  }rè  (h U h!jâ  ubah$hubaubah$háubeh$j  ubhÏ)ré  }rê  (h U h&}rë  (h(]h)]h*]h+]h-]uh!j  h]rì  (hÔ)rí  }rî  (h U h&}rï  (h(]h)]h*]h+]h-]uh!jé  h]rð  hK)rñ  }rò  (h X   metadataró  h!jí  h"h#h$hOh&}rô  (h(]h)]h*]h+]h-]uh/K)h]rõ  h9X   metadatarö  …r÷  }rø  (h jó  h!jñ  ubaubah$háubhÔ)rù  }rú  (h U h&}rû  (h(]h)]h*]h+]h-]uh!jé  h]rü  hK)rý  }rþ  (h XD   Arbitrary key/value pairs that are passed during the alerting phase.rÿ  h!jù  h"h#h$hOh&}r   (h(]h)]h*]h+]h-]uh/K)h]r  h9XD   Arbitrary key/value pairs that are passed during the alerting phase.r  …r  }r  (h jÿ  h!jý  ubaubah$háubhÔ)r  }r  (h U h&}r  (h(]h)]h*]h+]h-]uh!jé  h]r  hK)r	  }r
  (h X   Optionalr  h!j  h"h#h$hOh&}r  (h(]h)]h*]h+]h-]uh/K)h]r  h9X   Optionalr  …r  }r  (h j  h!j	  ubaubah$háubhÔ)r  }r  (h U h&}r  (h(]h)]h*]h+]h-]uh!jé  h]r  hK)r  }r  (h X   ``OpenCloud\Common\Metadata``h!j  h"h#h$hOh&}r  (h(]h)]h*]h+]h-]uh/K)h]r  hˆ)r  }r  (h X   ``OpenCloud\Common\Metadata``h&}r  (h(]h)]h*]h+]h-]uh!j  h]r  h9X   OpenCloud\Common\Metadatar  …r  }r  (h U h!j  ubah$hubaubah$háubhÔ)r   }r!  (h U h&}r"  (h(]h)]h*]h+]h-]uh!jé  h]r#  hK)r$  }r%  (h X   ``getMetadata()``r&  h!j   h"h#h$hOh&}r'  (h(]h)]h*]h+]h-]uh/K)h]r(  hˆ)r)  }r*  (h j&  h&}r+  (h(]h)]h*]h+]h-]uh!j$  h]r,  h9X   getMetadata()r-  …r.  }r/  (h U h!j)  ubah$hubaubah$háubeh$j  ubeh$Utbodyr0  ubeh$Utgroupr1  ubaubeubh)r2  }r3  (h U h!hh"h#h$h%h&}r4  (h(]h)]h*]h+]r5  hah-]r6  hauh/K-h0hh]r7  (h2)r8  }r9  (h X   Create Entityr:  h!j2  h"h#h$h6h&}r;  (h(]h)]h*]h+]h-]uh/K-h0hh]r<  h9X   Create Entityr=  …r>  }r?  (h j:  h!j8  ubaubhk)r@  }rA  (h XŠ  $service->createEntity(array(
    'label' => 'Brand New Entity',
    'ip_addresses' => array(
        'default' => '127.0.0.4',
        'b'       => '127.0.0.5',
        'c'       => '127.0.0.6',
        'test'    => '127.0.0.7'
    ),
    'metadata' => array(
        'all'  => 'kinds',
        'of'   => 'stuff',
        'can'  => 'go',
        'here' => 'null is not a valid value'
    )
));h!j2  h"h#h$hnh&}rB  (hphqh+]h*]h(]h)]rC  (hsX   phprD  eh-]uh/K@h0hh]rE  hv)rF  }rG  (h XŠ  $service->createEntity(array(
    'label' => 'Brand New Entity',
    'ip_addresses' => array(
        'default' => '127.0.0.4',
        'b'       => '127.0.0.5',
        'c'       => '127.0.0.6',
        'test'    => '127.0.0.7'
    ),
    'metadata' => array(
        'all'  => 'kinds',
        'of'   => 'stuff',
        'can'  => 'go',
        'here' => 'null is not a valid value'
    )
));h&}rH  (h(]h)]rI  UotherrJ  ah*]h+]h-]uh!j@  h]rK  h9XŠ  $service->createEntity(array(
    'label' => 'Brand New Entity',
    'ip_addresses' => array(
        'default' => '127.0.0.4',
        'b'       => '127.0.0.5',
        'c'       => '127.0.0.6',
        'test'    => '127.0.0.7'
    ),
    'metadata' => array(
        'all'  => 'kinds',
        'of'   => 'stuff',
        'can'  => 'go',
        'here' => 'null is not a valid value'
    )
));rL  …rM  }rN  (h U h!jF  ubah$h€ubaubeubh)rO  }rP  (h U h!hh"h#h$h%h&}rQ  (h(]h)]h*]h+]rR  hah-]rS  h
auh/KBh0hh]rT  (h2)rU  }rV  (h X   Update and delete EntityrW  h!jO  h"h#h$h6h&}rX  (h(]h)]h*]h+]h-]uh/KBh0hh]rY  h9X   Update and delete EntityrZ  …r[  }r\  (h jW  h!jU  ubaubhk)r]  }r^  (h Xk   // Update
$entity->update(array(
    'label' => 'New label for my entity'
));

// Delete
$entity->delete();h!jO  h"h#h$hnh&}r_  (hphqh+]h*]h(]h)]r`  (hsX   phpra  eh-]uh/KMh0hh]rb  hv)rc  }rd  (h Xk   // Update
$entity->update(array(
    'label' => 'New label for my entity'
));

// Delete
$entity->delete();h&}re  (h(]h)]rf  Uotherrg  ah*]h+]h-]uh!j]  h]rh  h9Xk   // Update
$entity->update(array(
    'label' => 'New label for my entity'
));

// Delete
$entity->delete();ri  …rj  }rk  (h U h!jc  ubah$h€ubaubeubeubah U Utransformerrl  NUfootnote_refsrm  }rn  Urefnamesro  }rp  Usymbol_footnotesrq  ]rr  Uautofootnote_refsrs  ]rt  Usymbol_footnote_refsru  ]rv  U	citationsrw  ]rx  h0hUcurrent_linery  NUtransform_messagesrz  ]r{  Ureporterr|  NUid_startr}  KUautofootnotesr~  ]r  Ucitation_refsr€  }r  Uindirect_targetsr‚  ]rƒ  Usettingsr„  (cdocutils.frontend
Values
r…  or†  }r‡  (Ufootnote_backlinksrˆ  KUrecord_dependenciesr‰  NUrfc_base_urlrŠ  Uhttp://tools.ietf.org/html/r‹  U	tracebackrŒ  ˆUpep_referencesr  NUstrip_commentsrŽ  NUtoc_backlinksr  háUlanguage_coder  Uenr‘  U	datestampr’  NUreport_levelr“  KU_destinationr”  NU
halt_levelr•  KUstrip_classesr–  Nh6NUerror_encoding_error_handlerr—  Ubackslashreplacer˜  Udebugr™  NUembed_stylesheetrš  ‰Uoutput_encoding_error_handlerr›  Ustrictrœ  Usectnum_xformr  KUdump_transformsrž  NUdocinfo_xformrŸ  KUwarning_streamr   NUpep_file_url_templater¡  Upep-%04dr¢  Uexit_status_levelr£  KUconfigr¤  NUstrict_visitorr¥  NUcloak_email_addressesr¦  ˆUtrim_footnote_reference_spacer§  ‰Uenvr¨  NUdump_pseudo_xmlr©  NUexpose_internalsrª  NUsectsubtitle_xformr«  ‰Usource_linkr¬  NUrfc_referencesr­  NUoutput_encodingr®  Uutf-8r¯  U
source_urlr°  NUinput_encodingr±  U	utf-8-sigr²  U_disable_configr³  NU	id_prefixr´  U U	tab_widthrµ  KUerror_encodingr¶  UUTF-8r·  U_sourcer¸  h#Ugettext_compactr¹  ˆU	generatorrº  NUdump_internalsr»  NUsmart_quotesr¼  ‰Upep_base_urlr½  Uhttp://www.python.org/dev/peps/r¾  Usyntax_highlightr¿  UlongrÀ  Uinput_encoding_error_handlerrÁ  jœ  Uauto_id_prefixrÂ  UidrÃ  Udoctitle_xformrÄ  ‰Ustrip_elements_with_classesrÅ  NU_config_filesrÆ  ]Ufile_insertion_enabledrÇ  ˆUraw_enabledrÈ  KUdump_settingsrÉ  NubUsymbol_footnote_startrÊ  K UidsrË  }rÌ  (hh=hj2  hh]hjO  hhhh uUsubstitution_namesrÍ  }rÎ  h$h0h&}rÏ  (h(]h+]h*]Usourceh#h)]h-]uU	footnotesrÐ  ]rÑ  UrefidsrÒ  }rÓ  ub.