Skip to content

Commit

Permalink
Deploying to gh-pages from @ 432287d 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@bshaffer
bshaffer committed Aug 20, 2024
1 parent c2ca9b9 commit 82198c9
Show file tree
Hide file tree
Showing 118 changed files with 43,271 additions and 0 deletions.
1 change: 1 addition & 0 deletions v1.34.1/DOCTUM_VERSION
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
5.5.4
99 changes: 99 additions & 0 deletions v1.34.1/Google.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Google | Google API Core - v1.34.1</title>

<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="css/doctum.css">
<link rel="stylesheet" type="text/css" href="fonts/doctum-font.css">
<script src="js/jquery-3.5.1.slim.min.js"></script>
<script async defer src="doctum.js"></script>
<script async defer src="js/bootstrap.min.js"></script>
<script async defer src="js/autocomplete.min.js"></script>
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">

</head>

<body id="namespace" data-name="namespace:Google" data-root-path="" data-search-index-url="doctum-search.json">
<div id="content">
<div id="left-column">
<div id="control-panel">
<div class="search-bar hidden" id="search-progress-bar-container">
<div class="progress">
<div class="progress-bar" role="progressbar" id="search-progress-bar"
aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 0%"></div>
</div>
</div>
<form id="search-form" action="search.html">
<span class="icon icon-search"></span>
<input name="search"
id="doctum-search-auto-complete"
class="typeahead form-control"
type="search"
placeholder="Search"
spellcheck="false"
autocorrect="off"
autocomplete="off"
autocapitalize="off">
<div class="auto-complete-results" id="auto-complete-results"></div>
</form>
</div>

<div id="api-tree"></div>

</div>
<div id="right-column">
<nav id="site-nav" class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">Google API Core - v1.34.1</a>
</div>
<div class="collapse navbar-collapse" id="navbar-elements">
<ul class="nav navbar-nav">
<li><a href="classes.html">Classes</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="interfaces.html">Interfaces</a></li>
<li><a href="traits.html">Traits</a></li>
<li><a href="doc-index.html">Index</a></li>
<li><a href="search.html">Search</a></li>
</ul>
</div>
</div>
</nav>

<div class="namespace-breadcrumbs">
<ol class="breadcrumb">
<li><span class="label label-default">Namespace</span></li>
<li><a href="Google.html">Google</a></li><li class="backslash">\</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>Google</h1>
</div>

<h2>Namespaces</h2>
<div class="namespace-list">
<a href="Google/ApiCore.html">Google\ApiCore</a> </div>





</div><div id="footer">
Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>.</div></div>
</div>
</body>

</html>
278 changes: 278 additions & 0 deletions v1.34.1/Google/ApiCore.html
View file

Large diffs are not rendered by default.

283 changes: 283 additions & 0 deletions v1.34.1/Google/ApiCore/AgentHeader.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,283 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Google\ApiCore\AgentHeader | Google API Core - v1.34.1</title>

<link rel="stylesheet" type="text/css" href="../../css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="../../css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="../../css/doctum.css">
<link rel="stylesheet" type="text/css" href="../../fonts/doctum-font.css">
<script src="../../js/jquery-3.5.1.slim.min.js"></script>
<script async defer src="../../doctum.js"></script>
<script async defer src="../../js/bootstrap.min.js"></script>
<script async defer src="../../js/autocomplete.min.js"></script>
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">

</head>

<body id="class" data-name="class:Google_ApiCore_AgentHeader" data-root-path="../../" data-search-index-url="../../doctum-search.json">
<div id="content">
<div id="left-column">
<div id="control-panel">
<div class="search-bar hidden" id="search-progress-bar-container">
<div class="progress">
<div class="progress-bar" role="progressbar" id="search-progress-bar"
aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 0%"></div>
</div>
</div>
<form id="search-form" action="../../search.html">
<span class="icon icon-search"></span>
<input name="search"
id="doctum-search-auto-complete"
class="typeahead form-control"
type="search"
placeholder="Search"
spellcheck="false"
autocorrect="off"
autocomplete="off"
autocapitalize="off">
<div class="auto-complete-results" id="auto-complete-results"></div>
</form>
</div>

<div id="api-tree"></div>

</div>
<div id="right-column">
<nav id="site-nav" class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">Google API Core - v1.34.1</a>
</div>
<div class="collapse navbar-collapse" id="navbar-elements">
<ul class="nav navbar-nav">
<li><a href="../../classes.html">Classes</a></li>
<li><a href="../../namespaces.html">Namespaces</a></li>
<li><a href="../../interfaces.html">Interfaces</a></li>
<li><a href="../../traits.html">Traits</a></li>
<li><a href="../../doc-index.html">Index</a></li>
<li><a href="../../search.html">Search</a></li>
</ul>
</div>
</div>
</nav>

<div class="namespace-breadcrumbs">
<ol class="breadcrumb">
<li><span class="label label-default">class</span></li>
<li><a href="../../Google.html">Google</a></li><li class="backslash">\</li><li><a href="../../Google/ApiCore.html">ApiCore</a></li><li class="backslash">\</li><li>AgentHeader</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>AgentHeader
</h1>
</div>


<p> class
<strong>AgentHeader</strong> (<a href="https://github.com/googleapis/gax-php/blob/v1.34.1/src/AgentHeader.php">View source</a>)
</p>





<div class="description">
<p><p>Class containing functions used to build the Agent header.</p></p> </div>


<h2>Constants</h2> <table class="table table-condensed">
<tr>
<td>
AGENT_HEADER_KEY
</td>
<td class="last">
<p><em></em></p>
<p></p>
</td>
</tr>
<tr>
<td>
UNKNOWN_VERSION
</td>
<td class="last">
<p><em></em></p>
<p></p>
</td>
</tr>
</table>



<h2>Methods</h2>

<div class="container-fluid underlined">
<div class="row">
<div class="col-md-2 type">
static&nbsp;array
</div>
<div class="col-md-8">
<a href="#method_buildAgentHeader">buildAgentHeader</a>(array $headerInfo)

<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static&nbsp;string
</div>
<div class="col-md-8">
<a href="#method_readGapicVersionFromFile">readGapicVersionFromFile</a>(string $callingClass)

<p><p>Reads the gapic version string from a VERSION file. In order to determine the file
location, this method follows this procedure:</p>
<ul>
<li>accepts a class name $callingClass</li>
<li>identifies the file defining that class</li>
<li>searches up the directory structure for the 'src' directory</li>
<li>looks in the directory above 'src' for a file named VERSION</li>
</ul></p> </div>
<div class="col-md-2"></div>
</div>
</div>


<h2>Details</h2>

<div id="method-details">
<div class="method-item">
<h3 id="method_buildAgentHeader">
<div class="location"><a href="https://github.com/googleapis/gax-php/blob/v1.34.1/src/AgentHeader.php#L62">at line 62</a></div>
<code> static array
<strong>buildAgentHeader</strong>(array $headerInfo)
</code>
</h3>
<div class="details">



<div class="method-description">
<p class="no-description">No description</p>

</div>
<div class="tags">
<h4>Parameters</h4>

<table class="table table-condensed">
<tr>
<td>array</td>
<td>$headerInfo</td>
<td><p>{
Optional.</p>
<pre><code>@type string $phpVersion the PHP version.
@type string $libName the name of the client application.
@type string $libVersion the version of the client application.
@type string $gapicVersion the code generator version of the GAPIC library.
@type string $apiCoreVersion the ApiCore version.
@type string $grpcVersion the gRPC version.
@type string $restVersion the REST transport version (typically same as the
ApiCore version).
@type string $protobufVersion the protobuf version in format 'x.y.z+a' where both 'x.y.z'
and '+a' are optional, and where 'a' is a single letter representing the
implementation type of the protobuf runtime. It is recommended to use 'c' for a C
implementation, and 'n' for the native language implementation (PHP).</code></pre>
<p>}</p></td>
</tr>
</table>


<h4>Return Value</h4>

<table class="table table-condensed">
<tr>
<td>array</td>
<td><p>Agent header array</p></td>
</tr>
</table>




</div>
</div>

</div>
<div class="method-item">
<h3 id="method_readGapicVersionFromFile">
<div class="location"><a href="https://github.com/googleapis/gax-php/blob/v1.34.1/src/AgentHeader.php#L121">at line 121</a></div>
<code> static string
<strong>readGapicVersionFromFile</strong>(string $callingClass)
</code>
</h3>
<div class="details">



<div class="method-description">
<p><p>Reads the gapic version string from a VERSION file. In order to determine the file
location, this method follows this procedure:</p>
<ul>
<li>accepts a class name $callingClass</li>
<li>identifies the file defining that class</li>
<li>searches up the directory structure for the 'src' directory</li>
<li>looks in the directory above 'src' for a file named VERSION</li>
</ul></p>
</div>
<div class="tags">
<h4>Parameters</h4>

<table class="table table-condensed">
<tr>
<td>string</td>
<td>$callingClass</td>
<td></td>
</tr>
</table>


<h4>Return Value</h4>

<table class="table table-condensed">
<tr>
<td>string</td>
<td><p>the gapic version</p></td>
</tr>
</table>


<h4>Exceptions</h4>

<table class="table table-condensed">
<tr>
<td><a target="_blank" rel="noopener" href="https://www.php.net/ReflectionException">ReflectionException</a></td>
<td></td>
</tr>
</table>



</div>
</div>

</div>
</div>


</div><div id="footer">
Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>.</div></div>
</div>
</body>

</html>
Loading

0 comments on commit 82198c9

Please sign in to comment.