Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Anax v3.1 archiveprevrelease2 docs #4068

Merged
merged 4 commits into from
Jan 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `ibm_db` dependency, which utilizes pre-built drivers to access DB2 and downloads those drivers at install time, pulls down drivers with a pre-requisite on the GNU C library (glibc) version 2.32.

Due to potential incompatibility issues, users on some Linux distributions might likely encounter an error while attempting to install any version of the DB2 Plug-in. Known distributions affected include Ubuntu 20, Debian 11, CentOS 8, and Red Hat Enterprise Linux 8.
Due to potential incompatibility issues, users on some Linux distributions might encounter an error while attempting to install any version of the DB2 Plug-in. Known distributions affected include Ubuntu 20, Debian 11, CentOS 8, and Red Hat Enterprise Linux 8.

If you are using any of these distributions of Linux, a workaround is required.

Expand Down
Binary file added static/v3.0.x/CLIReference_Zowe.pdf
Binary file not shown.
Binary file not shown.
Binary file added static/v3.0.x/Zowe_Overview.pdf
Binary file not shown.
1 change: 1 addition & 0 deletions static/v3.0.x/typedoc/assets/css/main.css

Large diffs are not rendered by default.

Binary file added static/v3.0.x/typedoc/assets/images/icons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/v3.0.x/typedoc/assets/images/widgets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
51 changes: 51 additions & 0 deletions static/v3.0.x/typedoc/assets/js/main.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions static/v3.0.x/typedoc/assets/js/search.json

Large diffs are not rendered by default.

Large diffs are not rendered by default.

348 changes: 348 additions & 0 deletions static/v3.0.x/typedoc/classes/_zowe_core_for_zowe_sdk.login.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

348 changes: 348 additions & 0 deletions static/v3.0.x/typedoc/classes/_zowe_core_for_zowe_sdk.logout.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

2,111 changes: 2,111 additions & 0 deletions static/v3.0.x/typedoc/classes/_zowe_core_for_zowe_sdk.profileconstants.html

Large diffs are not rendered by default.

483 changes: 483 additions & 0 deletions static/v3.0.x/typedoc/classes/_zowe_core_for_zowe_sdk.services.html

Large diffs are not rendered by default.

1,352 changes: 1,352 additions & 0 deletions static/v3.0.x/typedoc/classes/_zowe_core_for_zowe_sdk.zosmfheaders.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

1,019 changes: 1,019 additions & 0 deletions static/v3.0.x/typedoc/classes/_zowe_imperative.abstractcommandyargs.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

1,676 changes: 1,676 additions & 0 deletions static/v3.0.x/typedoc/classes/_zowe_imperative.abstractrestclient.html

Large diffs are not rendered by default.

908 changes: 908 additions & 0 deletions static/v3.0.x/typedoc/classes/_zowe_imperative.abstractsession.html

Large diffs are not rendered by default.

624 changes: 624 additions & 0 deletions static/v3.0.x/typedoc/classes/_zowe_imperative.appsettings.html

Large diffs are not rendered by default.

496 changes: 496 additions & 0 deletions static/v3.0.x/typedoc/classes/_zowe_imperative.authcommandbuilder.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

795 changes: 795 additions & 0 deletions static/v3.0.x/typedoc/classes/_zowe_imperative.autoinitconstants.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

686 changes: 686 additions & 0 deletions static/v3.0.x/typedoc/classes/_zowe_imperative.baseauthhandler.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

6,292 changes: 6,292 additions & 0 deletions static/v3.0.x/typedoc/classes/_zowe_imperative.bufferbuilder.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,294 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ChainedHandlerService | Zowe Node.js SDK - v3.0.0</title>
<meta name="description" content="Documentation for Zowe Node.js SDK - v3.0.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Zowe Node.js SDK - v3.0.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/_zowe_imperative.html">@zowe/imperative</a>
</li>
<li>
<a href="_zowe_imperative.chainedhandlerservice.html">ChainedHandlerService</a>
</li>
</ul>
<h1>Class ChainedHandlerService</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Service for processing chained handlers and their
argument mappings.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ChainedHandlerService</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_zowe_imperative.chainedhandlerservice.html#getarguments" class="tsd-kind-icon">get<wbr>Arguments</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="getarguments" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Arguments</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">get<wbr>Arguments<span class="tsd-signature-symbol">(</span>binName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, chainedHandlerConfigs<span class="tsd-signature-symbol">: </span><a href="../interfaces/_zowe_imperative.ichainedhandlerentry.html" class="tsd-signature-type">IChainedHandlerEntry</a><span class="tsd-signature-symbol">[]</span>, handlerIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, previousResponseObjects<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span>, overallArguments<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">yargs.Arguments</span>, logger<span class="tsd-signature-symbol">: </span><a href="_zowe_imperative.logger.html" class="tsd-signature-type">Logger</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">yargs.Arguments</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/zowe/zowe-cli/blob/v8.0.0/packages/imperative/src/cmd/src/ChainedHandlerUtils.ts#L37">@zowe/imperative/src/cmd/src/ChainedHandlerUtils.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the arguments for the current handler in the chain</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>binName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>name of the binary/primary command for this CLI</p>
</div>
</li>
<li>
<h5>chainedHandlerConfigs: <a href="../interfaces/_zowe_imperative.ichainedhandlerentry.html" class="tsd-signature-type">IChainedHandlerEntry</a><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>the configured chained handlers.</p>
</div>
</li>
<li>
<h5>handlerIndex: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>current index into the chained handlers e.g. 0 is the first chained handler</p>
</div>
</li>
<li>
<h5>previousResponseObjects: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>command responses completed so far</p>
</div>
</li>
<li>
<h5>overallArguments: <span class="tsd-signature-type">yargs.Arguments</span></h5>
<div class="tsd-comment tsd-typography">
<p>arguments specified by the use for the overall chained command</p>
</div>
</li>
<li>
<h5>logger: <a href="_zowe_imperative.logger.html" class="tsd-signature-type">Logger</a></h5>
<div class="tsd-comment tsd-typography">
<p>a logger to use as we check and perform the argument mappings</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">yargs.Arguments</span></h4>
<p>fully mapped arguments for this command</p>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_core_for_zowe_sdk.html">@zowe/core-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/_zowe_imperative.html">@zowe/imperative</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_provisioning_for_zowe_sdk.html">@zowe/provisioning-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_console_for_zowe_sdk.html">@zowe/zos-<wbr>console-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_files_for_zowe_sdk.html">@zowe/zos-<wbr>files-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_jobs_for_zowe_sdk.html">@zowe/zos-<wbr>jobs-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_logs_for_zowe_sdk.html">@zowe/zos-<wbr>logs-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_tso_for_zowe_sdk.html">@zowe/zos-<wbr>tso-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_uss_for_zowe_sdk.html">@zowe/zos-<wbr>uss-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_workflows_for_zowe_sdk.html">@zowe/zos-<wbr>workflows-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zosmf_for_zowe_sdk.html">@zowe/zosmf-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-module">
<a href="../modules/_zowe_core_for_zowe_sdk.html" class="tsd-kind-icon">@zowe/core-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-module">
<a href="../modules/_zowe_imperative.html" class="tsd-kind-icon">@zowe/imperative</a>
<ul>
<li class="current tsd-kind-class tsd-parent-kind-module">
<a href="_zowe_imperative.chainedhandlerservice.html" class="tsd-kind-icon">Chained<wbr>Handler<wbr>Service</a>
<ul>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_zowe_imperative.chainedhandlerservice.html#getarguments" class="tsd-kind-icon">get<wbr>Arguments</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-module">
<a href="../modules/_zowe_provisioning_for_zowe_sdk.html" class="tsd-kind-icon">@zowe/provisioning-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_console_for_zowe_sdk.html" class="tsd-kind-icon">@zowe/zos-<wbr>console-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_files_for_zowe_sdk.html" class="tsd-kind-icon">@zowe/zos-<wbr>files-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_jobs_for_zowe_sdk.html" class="tsd-kind-icon">@zowe/zos-<wbr>jobs-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_logs_for_zowe_sdk.html" class="tsd-kind-icon">@zowe/zos-<wbr>logs-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_tso_for_zowe_sdk.html" class="tsd-kind-icon">@zowe/zos-<wbr>tso-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_uss_for_zowe_sdk.html" class="tsd-kind-icon">@zowe/zos-<wbr>uss-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_workflows_for_zowe_sdk.html" class="tsd-kind-icon">@zowe/zos-<wbr>workflows-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zosmf_for_zowe_sdk.html" class="tsd-kind-icon">@zowe/zosmf-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Loading
Loading