getoperationid.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ --> 

<refentry xml:id="mongodb-driver-monitoring-commandsucceededevent.getoperationid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>MongoDB\Driver\Monitoring\CommandSucceededEvent::getOperationId</refname>
  <refpurpose>Returns the command's operation ID</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>final</modifier> <modifier>public</modifier> <type>string</type><methodname>MongoDB\Driver\Monitoring\CommandSucceededEvent::getOperationId</methodname>
   <void />
  </methodsynopsis>
  <para>
   The operation ID is generated by the driver and may be used to link events
   together such as bulk write operations, which may have been split across
   several commands at the protocol level.
  </para>
  <note>
   <simpara>
    Since multiple commands may share the same operation ID, it is not reliable
    to use this value to associate event objects with each other. The request ID
    returned by
    <methodname>MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId</methodname>
    should be used instead.
   </simpara>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the command's operation ID.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <simplelist>
   &mongodb.throws.argumentparsing;
  </simplelist>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>MongoDB\Driver\Monitoring\CommandStartedEvent::getOperationId</methodname></member>
   <member><methodname>MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId</methodname></member>
   <member><xref linkend="mongodb.tutorial.apm" /></member>
  </simplelist>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->