doc/SidekiqUniqueJobs/OnConflict/Strategy.html
<!DOCTYPE html><html> <head> <meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title> Class: SidekiqUniqueJobs::OnConflict::StrategyUnexpected trailing spaces found. — Documentation by YARD 0.9.26Unexpected trailing spaces found. </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 = "SidekiqUniqueJobs::OnConflict::Strategy"; 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">Unexpected trailing spaces found. <a href="../../_index.html">Index (S)</a> » <span class='title'><span class='object_link'><a href="../../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span> » <span class='title'><span class='object_link'><a href="../OnConflict.html" title="SidekiqUniqueJobs::OnConflict (module)">OnConflict</a></span></span>Unexpected trailing spaces found.
Expected an indentation at 6 instead of at 5. » <span class="title">Strategy</span>Unexpected trailing spaces found. </div> <div id="search">Unexpected trailing spaces found. <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>Unexpected trailing spaces found. </div> <div class="clear"></div> </div> <div id="content"><h1>Class: SidekiqUniqueJobs::OnConflict::Strategy <span class="abstract note title">Abstract</span>Unexpected trailing spaces found. Unexpected trailing spaces found. </h1><div class="box_info">Unexpected trailing spaces found. <dl> <dt>Inherits:</dt> <dd> <span class="inheritName">Object</span>Unexpected trailing spaces found. <ul class="fullTree"> <li>Object</li>Unexpected trailing spaces found. <li class="next">SidekiqUniqueJobs::OnConflict::Strategy</li>Unexpected trailing spaces found. </ul> <a href="#" class="inheritanceTree">show all</a>Unexpected trailing spaces found. </dd> </dl>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <dl> <dt>Includes:</dt> <dd><span class='object_link'><a href="../JSON.html" title="SidekiqUniqueJobs::JSON (module)">JSON</a></span>, <span class='object_link'><a href="../Logging.html" title="SidekiqUniqueJobs::Logging (module)">Logging</a></span>, <span class='object_link'><a href="../Script/Caller.html" title="SidekiqUniqueJobs::Script::Caller (module)">Script::Caller</a></span>, <span class='object_link'><a href="../Timing.html" title="SidekiqUniqueJobs::Timing (module)">Timing</a></span></dd> </dl>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <dl> <dt>Defined in:</dt> <dd>lib/sidekiq_unique_jobs/on_conflict/strategy.rb</dd> </dl>Unexpected trailing spaces found. </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <div class="note abstract"> <strong>This class is abstract.</strong> <div class='inline'></div></div><p>Abstract conflict strategy class</p> </div></div><div class="tags">Unexpected trailing spaces found. <p class="tag_title">Author:</p><ul class="author">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <div class='inline'><p>Mikael Henriksson <a href="mailto:mikael@mhenrixon.com">mikael@mhenrixon.com</a></p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div><div id="subclasses"> <h2>Direct Known Subclasses</h2> <p class="children"><span class='object_link'><a href="Log.html" title="SidekiqUniqueJobs::OnConflict::Log (class)">Log</a></span>, <span class='object_link'><a href="NullStrategy.html" title="SidekiqUniqueJobs::OnConflict::NullStrategy (class)">NullStrategy</a></span>, <span class='object_link'><a href="Raise.html" title="SidekiqUniqueJobs::OnConflict::Raise (class)">Raise</a></span>, <span class='object_link'><a href="Reject.html" title="SidekiqUniqueJobs::OnConflict::Reject (class)">Reject</a></span>, <span class='object_link'><a href="Replace.html" title="SidekiqUniqueJobs::OnConflict::Replace (class)">Replace</a></span>, <span class='object_link'><a href="Reschedule.html" title="SidekiqUniqueJobs::OnConflict::Reschedule (class)">Reschedule</a></span></p></div> <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2> <ul class="summary">Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#item-instance_method" title="#item (instance method)">#<strong>item</strong> ⇒ Object </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="note title readonly">readonly</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>Returns the value of attribute item.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#redis_pool-instance_method" title="#redis_pool (instance method)">#<strong>redis_pool</strong> ⇒ Object </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="note title readonly">readonly</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>Returns the value of attribute redis_pool.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. </ul> Unexpected trailing spaces found. <h2> Instance Method Summary <small><a href="#" class="summary_toggle">collapse</a></small> </h2> <ul class="summary">Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#build_message-instance_method" title="#build_message (instance method)">#<strong>build_message</strong>(message_or_exception, item = nil) ⇒ String </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. <span class="note title not_defined_here"> included from <span class='object_link'><a href="../Logging.html#build_message-instance_method" title="SidekiqUniqueJobs::Logging#build_message (method)">Logging</a></span> </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>Build a log message.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#call-instance_method" title="#call (instance method)">#<strong>call</strong> ⇒ Object </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>Use strategy on conflict.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(item, redis_pool = nil) ⇒ Strategy </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="note title constructor">constructor</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>Initialize a new Strategy.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#log_debug-instance_method" title="#log_debug (instance method)">#<strong>log_debug</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } ⇒ void </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. <span class="note title not_defined_here"> included from <span class='object_link'><a href="../Logging.html#log_debug-instance_method" title="SidekiqUniqueJobs::Logging#log_debug (method)">Logging</a></span> </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>Logs a message at debug level.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#log_error-instance_method" title="#log_error (instance method)">#<strong>log_error</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } ⇒ void </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. <span class="note title not_defined_here"> included from <span class='object_link'><a href="../Logging.html#log_error-instance_method" title="SidekiqUniqueJobs::Logging#log_error (method)">Logging</a></span> </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>Logs a message at error level.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#log_fatal-instance_method" title="#log_fatal (instance method)">#<strong>log_fatal</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } ⇒ void </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. <span class="note title not_defined_here"> included from <span class='object_link'><a href="../Logging.html#log_fatal-instance_method" title="SidekiqUniqueJobs::Logging#log_fatal (method)">Logging</a></span> </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>Logs a message at fatal level.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#log_info-instance_method" title="#log_info (instance method)">#<strong>log_info</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } ⇒ void </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. <span class="note title not_defined_here"> included from <span class='object_link'><a href="../Logging.html#log_info-instance_method" title="SidekiqUniqueJobs::Logging#log_info (method)">Logging</a></span> </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>Logs a message at info level.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#log_warn-instance_method" title="#log_warn (instance method)">#<strong>log_warn</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } ⇒ void </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. <span class="note title not_defined_here"> included from <span class='object_link'><a href="../Logging.html#log_warn-instance_method" title="SidekiqUniqueJobs::Logging#log_warn (method)">Logging</a></span> </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>Logs a message at warn level.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#logger-instance_method" title="#logger (instance method)">#<strong>logger</strong> ⇒ Logger </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. <span class="note title not_defined_here"> included from <span class='object_link'><a href="../Logging.html#logger-instance_method" title="SidekiqUniqueJobs::Logging#logger (method)">Logging</a></span> </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>A convenience method for using the configured gem logger.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#logging_context-instance_method" title="#logging_context (instance method)">#<strong>logging_context</strong> ⇒ Hash </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. <span class="note title not_defined_here"> included from <span class='object_link'><a href="../Logging.html#logging_context-instance_method" title="SidekiqUniqueJobs::Logging#logging_context (method)">Logging</a></span> </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>Setup some variables to add to each log line.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#replace%3F-instance_method" title="#replace? (instance method)">#<strong>replace?</strong> ⇒ true, false </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>Check if the strategy is kind of <span class='object_link'><a href="Replace.html" title="SidekiqUniqueJobs::OnConflict::Replace (class)">Replace</a></span>.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#with_configured_loggers_context-instance_method" title="#with_configured_loggers_context (instance method)">#<strong>with_configured_loggers_context</strong> { ... } ⇒ void </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. <span class="note title not_defined_here"> included from <span class='object_link'><a href="../Logging.html#with_configured_loggers_context-instance_method" title="SidekiqUniqueJobs::Logging#with_configured_loggers_context (method)">Logging</a></span> </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>Attempt to setup context aware logging for the given logger.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#with_logging_context-instance_method" title="#with_logging_context (instance method)">#<strong>with_logging_context</strong> ⇒ void </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. <span class="note title not_defined_here"> included from <span class='object_link'><a href="../Logging.html#with_logging_context-instance_method" title="SidekiqUniqueJobs::Logging#with_logging_context (method)">Logging</a></span> </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>Wraps the middleware logic with context aware logging.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. </ul>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2>Unexpected trailing spaces found. <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method">Unexpected trailing spaces found. Unexpected trailing spaces found. #<strong>initialize</strong>(item, redis_pool = nil) ⇒ <tt><span class='object_link'><a href="" title="SidekiqUniqueJobs::OnConflict::Strategy (class)">Strategy</a></span></tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p>Initialize a new Strategy</p> </div></div><div class="tags"> <p class="tag_title">Parameters:</p><ul class="param">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. <span class='name'>item</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt><span class='object_link'><a href="../../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>sidekiq job hash</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. <li>Unexpected trailing spaces found. <span class='name'>redis_pool</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>ConnectionPool</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <em class="default">(defaults to: <tt>nil</tt>)</em>Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the connection pool instance</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 28293031</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/on_conflict/strategy.rb', line 28</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='comma'>,</span> <span class='id identifier rubyid_redis_pool'>redis_pool</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span> <span class='ivar'>@item</span> <span class='op'>=</span> <span class='id identifier rubyid_item'>item</span> <span class='ivar'>@redis_pool</span> <span class='op'>=</span> <span class='id identifier rubyid_redis_pool'>redis_pool</span><span class='kw'>end</span></pre> </td> </tr></table></div>Unexpected trailing spaces found. </div> <div id="instance_attr_details" class="attr_details"> <h2>Instance Attribute Details</h2>Unexpected trailing spaces found. Unexpected trailing spaces found. <span id=""></span> <div class="method_details first"> <h3 class="signature first" id="item-instance_method">Unexpected trailing spaces found. #<strong>item</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p>Returns the value of attribute item.</p> </div></div><div class="tags">Unexpected trailing spaces found. </div><table class="source_code"> <tr> <td> <pre class="lines"> 171819</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/on_conflict/strategy.rb', line 17</span> <span class='kw'>def</span> <span class='id identifier rubyid_item'>item</span> <span class='ivar'>@item</span><span class='kw'>end</span></pre> </td> </tr></table></div>Unexpected trailing spaces found. Unexpected trailing spaces found. <span id=""></span> <div class="method_details "> <h3 class="signature " id="redis_pool-instance_method">Unexpected trailing spaces found. #<strong>redis_pool</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p>Returns the value of attribute redis_pool.</p> </div></div><div class="tags">Unexpected trailing spaces found. </div><table class="source_code"> <tr> <td> <pre class="lines"> 202122</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/on_conflict/strategy.rb', line 20</span> <span class='kw'>def</span> <span class='id identifier rubyid_redis_pool'>redis_pool</span> <span class='ivar'>@redis_pool</span><span class='kw'>end</span></pre> </td> </tr></table></div>Unexpected trailing spaces found. </div> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> Unexpected trailing spaces found. <div class="method_details first"> <h3 class="signature first" id="build_message-instance_method">Unexpected trailing spaces found. Unexpected trailing spaces found. #<strong>build_message</strong>(message_or_exception, item = nil) ⇒ <tt>String</tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="not_defined_here"> Originally defined in module <span class='object_link'><a href="../Logging.html#build_message-instance_method" title="SidekiqUniqueJobs::Logging#build_message (method)">Logging</a></span> </span>Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p>Build a log message</p> </div></div><div class="tags"> <p class="tag_title">Parameters:</p><ul class="param">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. <span class='name'>message_or_exception</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>an entry to log</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. <li>Unexpected trailing spaces found. <span class='name'>item</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt><span class='object_link'><a href="../../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <em class="default">(defaults to: <tt>nil</tt>)</em>Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the sidekiq job hash</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> <p class="tag_title">Returns:</p><ul class="return">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>String</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>a complete log entry</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div></div>Unexpected trailing spaces found. <div class="method_details "> <h3 class="signature " id="call-instance_method">Unexpected trailing spaces found. Unexpected trailing spaces found. #<strong>call</strong> ⇒ <tt>Object</tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p>Use strategy on conflict</p> </div></div><div class="tags">Unexpected trailing spaces found. <p class="tag_title">Raises:</p><ul class="raise">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>NotImplementedError</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>needs to be implemented in child class</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 353637</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/on_conflict/strategy.rb', line 35</span> <span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span> <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>needs to be implemented in child class</span><span class='tstring_end'>"</span></span><span class='kw'>end</span></pre> </td> </tr></table></div>Unexpected trailing spaces found. <div class="method_details "> <h3 class="signature " id="log_debug-instance_method">Unexpected trailing spaces found. Unexpected trailing spaces found. #<strong>log_debug</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } ⇒ <tt>void</tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="not_defined_here"> Originally defined in module <span class='object_link'><a href="../Logging.html#log_debug-instance_method" title="SidekiqUniqueJobs::Logging#log_debug (method)">Logging</a></span> </span>Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p class="note returns_void">This method returns an undefined value.</p><p>Logs a message at debug level</p> </div></div><div class="tags"> <p class="tag_title">Parameters:</p><ul class="param">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. <span class='name'>message_or_exception</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <em class="default">(defaults to: <tt>nil</tt>)</em>Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the message or exception to log</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> <p class="tag_title">Yields:</p><ul class="yield">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the message or exception to use for log message</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div></div>Unexpected trailing spaces found. <div class="method_details "> <h3 class="signature " id="log_error-instance_method">Unexpected trailing spaces found. Unexpected trailing spaces found. #<strong>log_error</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } ⇒ <tt>void</tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="not_defined_here"> Originally defined in module <span class='object_link'><a href="../Logging.html#log_error-instance_method" title="SidekiqUniqueJobs::Logging#log_error (method)">Logging</a></span> </span>Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p class="note returns_void">This method returns an undefined value.</p><p>Logs a message at error level</p> </div></div><div class="tags"> <p class="tag_title">Parameters:</p><ul class="param">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. <span class='name'>message_or_exception</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <em class="default">(defaults to: <tt>nil</tt>)</em>Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the message or exception to log</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> <p class="tag_title">Yields:</p><ul class="yield">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the message or exception to use for log message</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div></div>Unexpected trailing spaces found. <div class="method_details "> <h3 class="signature " id="log_fatal-instance_method">Unexpected trailing spaces found. Unexpected trailing spaces found. #<strong>log_fatal</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } ⇒ <tt>void</tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="not_defined_here"> Originally defined in module <span class='object_link'><a href="../Logging.html#log_fatal-instance_method" title="SidekiqUniqueJobs::Logging#log_fatal (method)">Logging</a></span> </span>Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p class="note returns_void">This method returns an undefined value.</p><p>Logs a message at fatal level</p> </div></div><div class="tags"> <p class="tag_title">Parameters:</p><ul class="param">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. <span class='name'>message_or_exception</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <em class="default">(defaults to: <tt>nil</tt>)</em>Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the message or exception to log</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> <p class="tag_title">Yields:</p><ul class="yield">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the message or exception to use for log message</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div></div>Unexpected trailing spaces found. <div class="method_details "> <h3 class="signature " id="log_info-instance_method">Unexpected trailing spaces found. Unexpected trailing spaces found. #<strong>log_info</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } ⇒ <tt>void</tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="not_defined_here"> Originally defined in module <span class='object_link'><a href="../Logging.html#log_info-instance_method" title="SidekiqUniqueJobs::Logging#log_info (method)">Logging</a></span> </span>Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p class="note returns_void">This method returns an undefined value.</p><p>Logs a message at info level</p> </div></div><div class="tags"> <p class="tag_title">Parameters:</p><ul class="param">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. <span class='name'>message_or_exception</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <em class="default">(defaults to: <tt>nil</tt>)</em>Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the message or exception to log</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> <p class="tag_title">Yields:</p><ul class="yield">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the message or exception to use for log message</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div></div>Unexpected trailing spaces found. <div class="method_details "> <h3 class="signature " id="log_warn-instance_method">Unexpected trailing spaces found. Unexpected trailing spaces found. #<strong>log_warn</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } ⇒ <tt>void</tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="not_defined_here"> Originally defined in module <span class='object_link'><a href="../Logging.html#log_warn-instance_method" title="SidekiqUniqueJobs::Logging#log_warn (method)">Logging</a></span> </span>Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p class="note returns_void">This method returns an undefined value.</p><p>Logs a message at warn level</p> </div></div><div class="tags"> <p class="tag_title">Parameters:</p><ul class="param">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. <span class='name'>message_or_exception</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. <em class="default">(defaults to: <tt>nil</tt>)</em>Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the message or exception to log</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> <p class="tag_title">Yields:</p><ul class="yield">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the message or exception to use for log message</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div></div>Unexpected trailing spaces found. <div class="method_details "> <h3 class="signature " id="logger-instance_method">Unexpected trailing spaces found. Unexpected trailing spaces found. #<strong>logger</strong> ⇒ <tt>Logger</tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="not_defined_here"> Originally defined in module <span class='object_link'><a href="../Logging.html#logger-instance_method" title="SidekiqUniqueJobs::Logging#logger (method)">Logging</a></span> </span>Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p>A convenience method for using the configured gem logger</p> </div></div><div class="tags">Unexpected trailing spaces found. <p class="tag_title">Returns:</p><ul class="return">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>Logger</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> <p class="tag_title">See Also:</p> <ul class="see">Unexpected trailing spaces found. <li>SidekiqUniqueJobs#.logger</li>Unexpected trailing spaces found. </ul> </div></div>Unexpected trailing spaces found. <div class="method_details "> <h3 class="signature " id="logging_context-instance_method">Unexpected trailing spaces found. Unexpected trailing spaces found. #<strong>logging_context</strong> ⇒ <tt><span class='object_link'><a href="../../Hash.html" title="Hash (class)">Hash</a></span></tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="not_defined_here"> Originally defined in module <span class='object_link'><a href="../Logging.html#logging_context-instance_method" title="SidekiqUniqueJobs::Logging#logging_context (method)">Logging</a></span> </span>Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p>Setup some variables to add to each log line</p> </div></div><div class="tags">Unexpected trailing spaces found. <p class="tag_title">Returns:</p><ul class="return">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt><span class='object_link'><a href="../../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the context to use for each log line</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul><p class="tag_title">Raises:</p><ul class="raise">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>NotImplementedError</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div></div>Unexpected trailing spaces found. <div class="method_details "> <h3 class="signature " id="replace?-instance_method">Unexpected trailing spaces found. Unexpected trailing spaces found. #<strong>replace?</strong> ⇒ <tt>true</tt>, <tt>false</tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p>Check if the strategy is kind of <span class='object_link'><a href="Replace.html" title="SidekiqUniqueJobs::OnConflict::Replace (class)">Replace</a></span></p> </div></div><div class="tags">Unexpected trailing spaces found. <p class="tag_title">Returns:</p><ul class="return">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>true</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>when the strategy is a <span class='object_link'><a href="Replace.html" title="SidekiqUniqueJobs::OnConflict::Replace (class)">Replace</a></span></p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>false</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>when the strategy is not a <span class='object_link'><a href="Replace.html" title="SidekiqUniqueJobs::OnConflict::Replace (class)">Replace</a></span></p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 464748</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/on_conflict/strategy.rb', line 46</span> <span class='kw'>def</span> <span class='id identifier rubyid_replace?'>replace?</span> <span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Replace.html" title="SidekiqUniqueJobs::OnConflict::Replace (class)">Replace</a></span></span><span class='rparen'>)</span><span class='kw'>end</span></pre> </td> </tr></table></div>Unexpected trailing spaces found. <div class="method_details "> <h3 class="signature " id="with_configured_loggers_context-instance_method">Unexpected trailing spaces found. Unexpected trailing spaces found. #<strong>with_configured_loggers_context</strong> { ... } ⇒ <tt>void</tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="not_defined_here"> Originally defined in module <span class='object_link'><a href="../Logging.html#with_configured_loggers_context-instance_method" title="SidekiqUniqueJobs::Logging#with_configured_loggers_context (method)">Logging</a></span> </span>Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p class="note returns_void">This method returns an undefined value.</p><p>Attempt to setup context aware logging for the given logger</p> </div></div><div class="tags">Unexpected trailing spaces found. <p class="tag_title">Yields:</p><ul class="yield">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'></span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div></div>Unexpected trailing spaces found. <div class="method_details "> <h3 class="signature " id="with_logging_context-instance_method">Unexpected trailing spaces found. Unexpected trailing spaces found. #<strong>with_logging_context</strong> ⇒ <tt>void</tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="not_defined_here"> Originally defined in module <span class='object_link'><a href="../Logging.html#with_logging_context-instance_method" title="SidekiqUniqueJobs::Logging#with_logging_context (method)">Logging</a></span> </span>Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p class="note returns_void">This method returns an undefined value.</p><p>Wraps the middleware logic with context aware logging</p> </div></div><div class="tags">Unexpected trailing spaces found. <p class="tag_title">Yield Returns:</p><ul class="yieldreturn">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt>void</tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>yield to the middleware instance</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div></div>Unexpected trailing spaces found. </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>Expected a newline at the end of the file.</html>