<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Returns the command's operation ID</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-monitoring-commandfailedevent.geterror.html">MongoDB\Driver\Monitoring\CommandFailedEvent::getError</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-monitoring-commandfailedevent.getreply.html">MongoDB\Driver\Monitoring\CommandFailedEvent::getReply</a></div>
<div class="up"><a href="class.mongodb-driver-monitoring-commandfailedevent.html">MongoDB\Driver\Monitoring\CommandFailedEvent</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongodb-driver-monitoring-commandfailedevent.getoperationid" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoDB\Driver\Monitoring\CommandFailedEvent::getOperationId</h1>
<p class="verinfo">(mongodb >=1.3.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\Monitoring\CommandFailedEvent::getOperationId</span> — <span class="dc-title">Returns the command's operation ID</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongodb-driver-monitoring-commandfailedevent.getoperationid-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><strong>MongoDB\Driver\Monitoring\CommandFailedEvent::getOperationId</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
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.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<span class="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
<span class="methodname"><a href="mongodb-driver-monitoring-commandfailedevent.getrequestid.html" class="methodname">MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId()</a></span>
should be used instead.
</span>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-mongodb-driver-monitoring-commandfailedevent.getoperationid-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongodb-driver-monitoring-commandfailedevent.getoperationid-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the command's operation ID.
</p>
</div>
<div class="refsect1 errors" id="refsect1-mongodb-driver-monitoring-commandfailedevent.getoperationid-errors">
<h3 class="title">Errors/Exceptions</h3>
<ul class="simplelist">
<li class="member">Throws <a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> on argument parsing errors.</li>
</ul>
</div>
<div class="refsect1 seealso" id="refsect1-mongodb-driver-monitoring-commandfailedevent.getoperationid-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"><span class="methodname"><a href="mongodb-driver-monitoring-commandstartedevent.getoperationid.html" class="methodname" rel="rdfs-seeAlso">MongoDB\Driver\Monitoring\CommandStartedEvent::getOperationId()</a> - Returns the command's operation ID</span></li>
<li class="member"><span class="methodname"><a href="mongodb-driver-monitoring-commandfailedevent.getrequestid.html" class="methodname" rel="rdfs-seeAlso">MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId()</a> - Returns the command's request ID</span></li>
<li class="member"><a href="mongodb.tutorial.apm.html" class="xref">Application Performance Monitoring (APM)</a></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-monitoring-commandfailedevent.geterror.html">MongoDB\Driver\Monitoring\CommandFailedEvent::getError</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-monitoring-commandfailedevent.getreply.html">MongoDB\Driver\Monitoring\CommandFailedEvent::getReply</a></div>
<div class="up"><a href="class.mongodb-driver-monitoring-commandfailedevent.html">MongoDB\Driver\Monitoring\CommandFailedEvent</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
