| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>AbstractOptions (kafka 3.6.1 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.kafka.clients.admin, class: AbstractOptions"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.kafka.clients.admin</a></div> |
| <h1 title="Class AbstractOptions" class="title">Class AbstractOptions<T extends AbstractOptions></h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.kafka.clients.admin.AbstractOptions<T></div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="AbortTransactionOptions.html" title="class in org.apache.kafka.clients.admin">AbortTransactionOptions</a></code>, <code><a href="AlterClientQuotasOptions.html" title="class in org.apache.kafka.clients.admin">AlterClientQuotasOptions</a></code>, <code><a href="AlterConfigsOptions.html" title="class in org.apache.kafka.clients.admin">AlterConfigsOptions</a></code>, <code><a href="AlterConsumerGroupOffsetsOptions.html" title="class in org.apache.kafka.clients.admin">AlterConsumerGroupOffsetsOptions</a></code>, <code><a href="AlterPartitionReassignmentsOptions.html" title="class in org.apache.kafka.clients.admin">AlterPartitionReassignmentsOptions</a></code>, <code><a href="AlterReplicaLogDirsOptions.html" title="class in org.apache.kafka.clients.admin">AlterReplicaLogDirsOptions</a></code>, <code><a href="AlterUserScramCredentialsOptions.html" title="class in org.apache.kafka.clients.admin">AlterUserScramCredentialsOptions</a></code>, <code><a href="CreateAclsOptions.html" title="class in org.apache.kafka.clients.admin">CreateAclsOptions</a></code>, <code><a href="CreateDelegationTokenOptions.html" title="class in org.apache.kafka.clients.admin">CreateDelegationTokenOptions</a></code>, <code><a href="CreatePartitionsOptions.html" title="class in org.apache.kafka.clients.admin">CreatePartitionsOptions</a></code>, <code><a href="CreateTopicsOptions.html" title="class in org.apache.kafka.clients.admin">CreateTopicsOptions</a></code>, <code><a href="DeleteAclsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteAclsOptions</a></code>, <code><a href="DeleteConsumerGroupOffsetsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteConsumerGroupOffsetsOptions</a></code>, <code><a href="DeleteConsumerGroupsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteConsumerGroupsOptions</a></code>, <code><a href="DeleteRecordsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteRecordsOptions</a></code>, <code><a href="DeleteTopicsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteTopicsOptions</a></code>, <code><a href="DescribeAclsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeAclsOptions</a></code>, <code><a href="DescribeClientQuotasOptions.html" title="class in org.apache.kafka.clients.admin">DescribeClientQuotasOptions</a></code>, <code><a href="DescribeClusterOptions.html" title="class in org.apache.kafka.clients.admin">DescribeClusterOptions</a></code>, <code><a href="DescribeConfigsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeConfigsOptions</a></code>, <code><a href="DescribeConsumerGroupsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeConsumerGroupsOptions</a></code>, <code><a href="DescribeDelegationTokenOptions.html" title="class in org.apache.kafka.clients.admin">DescribeDelegationTokenOptions</a></code>, <code><a href="DescribeFeaturesOptions.html" title="class in org.apache.kafka.clients.admin">DescribeFeaturesOptions</a></code>, <code><a href="DescribeLogDirsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeLogDirsOptions</a></code>, <code><a href="DescribeMetadataQuorumOptions.html" title="class in org.apache.kafka.clients.admin">DescribeMetadataQuorumOptions</a></code>, <code><a href="DescribeProducersOptions.html" title="class in org.apache.kafka.clients.admin">DescribeProducersOptions</a></code>, <code><a href="DescribeReplicaLogDirsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeReplicaLogDirsOptions</a></code>, <code><a href="DescribeTopicsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeTopicsOptions</a></code>, <code><a href="DescribeTransactionsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeTransactionsOptions</a></code>, <code><a href="DescribeUserScramCredentialsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeUserScramCredentialsOptions</a></code>, <code><a href="ElectLeadersOptions.html" title="class in org.apache.kafka.clients.admin">ElectLeadersOptions</a></code>, <code><a href="ExpireDelegationTokenOptions.html" title="class in org.apache.kafka.clients.admin">ExpireDelegationTokenOptions</a></code>, <code><a href="FenceProducersOptions.html" title="class in org.apache.kafka.clients.admin">FenceProducersOptions</a></code>, <code><a href="ListConsumerGroupOffsetsOptions.html" title="class in org.apache.kafka.clients.admin">ListConsumerGroupOffsetsOptions</a></code>, <code><a href="ListConsumerGroupsOptions.html" title="class in org.apache.kafka.clients.admin">ListConsumerGroupsOptions</a></code>, <code><a href="ListOffsetsOptions.html" title="class in org.apache.kafka.clients.admin">ListOffsetsOptions</a></code>, <code><a href="ListPartitionReassignmentsOptions.html" title="class in org.apache.kafka.clients.admin">ListPartitionReassignmentsOptions</a></code>, <code><a href="ListTopicsOptions.html" title="class in org.apache.kafka.clients.admin">ListTopicsOptions</a></code>, <code><a href="ListTransactionsOptions.html" title="class in org.apache.kafka.clients.admin">ListTransactionsOptions</a></code>, <code><a href="RemoveMembersFromConsumerGroupOptions.html" title="class in org.apache.kafka.clients.admin">RemoveMembersFromConsumerGroupOptions</a></code>, <code><a href="RenewDelegationTokenOptions.html" title="class in org.apache.kafka.clients.admin">RenewDelegationTokenOptions</a></code>, <code><a href="UnregisterBrokerOptions.html" title="class in org.apache.kafka.clients.admin">UnregisterBrokerOptions</a></code>, <code><a href="UpdateFeaturesOptions.html" title="class in org.apache.kafka.clients.admin">UpdateFeaturesOptions</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">AbstractOptions<T extends AbstractOptions></span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#timeoutMs" class="member-name-link">timeoutMs</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">AbstractOptions</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#timeoutMs()" class="member-name-link">timeoutMs</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The timeout in milliseconds for this operation or <code>null</code> if the default api timeout for the |
| AdminClient should be used.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="AbstractOptions.html" title="type parameter in AbstractOptions">T</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#timeoutMs(java.lang.Integer)" class="member-name-link">timeoutMs</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> timeoutMs)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the timeout in milliseconds for this operation or <code>null</code> if the default api timeout for the |
| AdminClient should be used.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="timeoutMs"> |
| <h3>timeoutMs</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></span> <span class="element-name">timeoutMs</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>AbstractOptions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">AbstractOptions</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="timeoutMs(java.lang.Integer)"> |
| <h3>timeoutMs</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="AbstractOptions.html" title="type parameter in AbstractOptions">T</a></span> <span class="element-name">timeoutMs</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> timeoutMs)</span></div> |
| <div class="block">Set the timeout in milliseconds for this operation or <code>null</code> if the default api timeout for the |
| AdminClient should be used.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="timeoutMs()"> |
| <h3>timeoutMs</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></span> <span class="element-name">timeoutMs</span>()</div> |
| <div class="block">The timeout in milliseconds for this operation or <code>null</code> if the default api timeout for the |
| AdminClient should be used.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
