doc/Sidekiq/JobSet.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Sidekiq::JobSet
— Documentation by YARD 0.9.26
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Sidekiq::JobSet";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (J)</a> »
<span class='title'><span class='object_link'><a href="../Sidekiq.html" title="Sidekiq (module)">Sidekiq</a></span></span>
»
<span class="title">JobSet</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Sidekiq::JobSet
<span class="private note title">Private</span>
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Sidekiq::JobSet</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="JobSet/UniqueExtension.html" title="Sidekiq::JobSet::UniqueExtension (module)">UniqueExtension</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/sidekiq_unique_jobs/sidekiq_unique_ext.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This class is part of a private API.</strong>
You should avoid using this class if possible, as it may be removed or be changed in the future.
</p>
<p>See Sidekiq::Api</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="JobSet/UniqueExtension.html" title="Sidekiq::JobSet::UniqueExtension (module)">UniqueExtension</a></span>
</p>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#clear-instance_method" title="#clear (instance method)">#<strong>clear</strong> ⇒ Object </a>
</span>
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="JobSet/UniqueExtension.html#clear-instance_method" title="Sidekiq::JobSet::UniqueExtension#clear (method)">UniqueExtension</a></span>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'><p>Wraps the original method to ensure locks for the job are deleted.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete_by_value-instance_method" title="#delete_by_value (instance method)">#<strong>delete_by_value</strong>(name, value) ⇒ Object </a>
</span>
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="JobSet/UniqueExtension.html#delete_by_value-instance_method" title="Sidekiq::JobSet::UniqueExtension#delete_by_value (method)">UniqueExtension</a></span>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'><p>Wraps the original method to ensure locks for the job are deleted.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="clear-instance_method">
#<strong>clear</strong> ⇒ <tt>Object</tt>
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="JobSet/UniqueExtension.html#clear-instance_method" title="Sidekiq::JobSet::UniqueExtension#clear (method)">UniqueExtension</a></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This method is part of a private API.</strong>
You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>
<p>Wraps the original method to ensure locks for the job are deleted</p>
</div>
</div>
<div class="tags">
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="delete_by_value-instance_method">
#<strong>delete_by_value</strong>(name, value) ⇒ <tt>Object</tt>
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="JobSet/UniqueExtension.html#delete_by_value-instance_method" title="Sidekiq::JobSet::UniqueExtension#delete_by_value (method)">UniqueExtension</a></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This method is part of a private API.</strong>
You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>
<p>Wraps the original method to ensure locks for the job are deleted</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>the name of the key</p>
</div>
</li>
<li>
<span class='name'>value</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>a sidekiq job hash</p>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Sep 27 15:29:09 2021 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.26 (ruby-3.0.2).
</div>
</div>
</body>
</html>