Files
2024-03-05 21:06:01 +01:00

383 lines
20 KiB
HTML

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-cloudbuild1-cli/projects_github-enterprise-configs-get/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Github Enterprise Configs Get - Cloud Build v5.0.4+20240223</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Github Enterprise Configs Get";
var mkdocs_page_input_path = "projects_github-enterprise-configs-get.md";
var mkdocs_page_url = "/google-apis-rs/google-cloudbuild1-cli/projects_github-enterprise-configs-get/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> Cloud Build v5.0.4+20240223
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Github Dot Com Webhook</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../github-dot-com-webhook_receive/">Receive</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Locations</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../locations_regional-webhook/">Regional Webhook</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Methods</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../methods_webhook/">Webhook</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Operations</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../operations_cancel/">Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../operations_get/">Get</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Projects</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../projects_builds-approve/">Builds Approve</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_builds-cancel/">Builds Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_builds-create/">Builds Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_builds-get/">Builds Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_builds-list/">Builds List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_builds-retry/">Builds Retry</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_github-enterprise-configs-create/">Github Enterprise Configs Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_github-enterprise-configs-delete/">Github Enterprise Configs Delete</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Github Enterprise Configs Get</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_github-enterprise-configs-list/">Github Enterprise Configs List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_github-enterprise-configs-patch/">Github Enterprise Configs Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-bitbucket-server-configs-connected-repositories-batch-create/">Locations Bitbucket Server Configs Connected Repositories Batch Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-bitbucket-server-configs-create/">Locations Bitbucket Server Configs Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-bitbucket-server-configs-delete/">Locations Bitbucket Server Configs Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-bitbucket-server-configs-get/">Locations Bitbucket Server Configs Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-bitbucket-server-configs-list/">Locations Bitbucket Server Configs List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-bitbucket-server-configs-patch/">Locations Bitbucket Server Configs Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-bitbucket-server-configs-remove-bitbucket-server-connected-repository/">Locations Bitbucket Server Configs Remove Bitbucket Server Connected Repository</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-bitbucket-server-configs-repos-list/">Locations Bitbucket Server Configs Repos List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-builds-approve/">Locations Builds Approve</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-builds-cancel/">Locations Builds Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-builds-create/">Locations Builds Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-builds-get/">Locations Builds Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-builds-list/">Locations Builds List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-builds-retry/">Locations Builds Retry</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-get-default-service-account/">Locations Get Default Service Account</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-git-lab-configs-connected-repositories-batch-create/">Locations Git Lab Configs Connected Repositories Batch Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-git-lab-configs-create/">Locations Git Lab Configs Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-git-lab-configs-delete/">Locations Git Lab Configs Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-git-lab-configs-get/">Locations Git Lab Configs Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-git-lab-configs-list/">Locations Git Lab Configs List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-git-lab-configs-patch/">Locations Git Lab Configs Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-git-lab-configs-remove-git-lab-connected-repository/">Locations Git Lab Configs Remove Git Lab Connected Repository</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-git-lab-configs-repos-list/">Locations Git Lab Configs Repos List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-github-enterprise-configs-create/">Locations Github Enterprise Configs Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-github-enterprise-configs-delete/">Locations Github Enterprise Configs Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-github-enterprise-configs-get/">Locations Github Enterprise Configs Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-github-enterprise-configs-list/">Locations Github Enterprise Configs List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-github-enterprise-configs-patch/">Locations Github Enterprise Configs Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-cancel/">Locations Operations Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-get/">Locations Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-create/">Locations Triggers Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-delete/">Locations Triggers Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-get/">Locations Triggers Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-list/">Locations Triggers List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-patch/">Locations Triggers Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-run/">Locations Triggers Run</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-webhook/">Locations Triggers Webhook</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-worker-pools-create/">Locations Worker Pools Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-worker-pools-delete/">Locations Worker Pools Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-worker-pools-get/">Locations Worker Pools Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-worker-pools-list/">Locations Worker Pools List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-worker-pools-patch/">Locations Worker Pools Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_triggers-create/">Triggers Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_triggers-delete/">Triggers Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_triggers-get/">Triggers Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_triggers-list/">Triggers List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_triggers-patch/">Triggers Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_triggers-run/">Triggers Run</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_triggers-webhook/">Triggers Webhook</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">Cloud Build v5.0.4+20240223</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Projects &raquo;</li>
<li>Github Enterprise Configs Get</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudbuild1-cli/edit/master/docs/projects_github-enterprise-configs-get.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<p>Retrieve a GitHubEnterpriseConfig.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
You can set the scope for this method like this: <code>cloudbuild1 --scope &lt;scope&gt; projects github-enterprise-configs-get ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</strong> <em>(string)</em><ul>
<li>This field should contain the name of the enterprise config resource. For example: &#34;projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}&#34;</li>
</ul>
</li>
</ul>
<h1 id="optional-output-flags">Optional Output Flags</h1>
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
<ul>
<li><strong>-o out</strong><ul>
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
It will be a JSON-encoded structure.
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
If unset, it defaults to standard output.</li>
</ul>
</li>
</ul>
<h1 id="optional-method-properties">Optional Method Properties</h1>
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
<code>-p</code> for completeness.</p>
<ul>
<li>
<p><strong>-p config-id=string</strong></p>
<ul>
<li>Unique identifier of the <code>GitHubEnterpriseConfig</code></li>
</ul>
</li>
<li>
<p><strong>-p project-id=string</strong></p>
<ul>
<li>ID of the project</li>
</ul>
</li>
</ul>
<h1 id="optional-general-properties">Optional General Properties</h1>
<p>The following properties can configure any call, and are not specific to this method.</p>
<ul>
<li>
<p><strong>-p $-xgafv=string</strong></p>
<ul>
<li>V1 error format.</li>
</ul>
</li>
<li>
<p><strong>-p access-token=string</strong></p>
<ul>
<li>OAuth access token.</li>
</ul>
</li>
<li>
<p><strong>-p alt=string</strong></p>
<ul>
<li>Data format for response.</li>
</ul>
</li>
<li>
<p><strong>-p callback=string</strong></p>
<ul>
<li>JSONP</li>
</ul>
</li>
<li>
<p><strong>-p fields=string</strong></p>
<ul>
<li>Selector specifying which fields to include in a partial response.</li>
</ul>
</li>
<li>
<p><strong>-p key=string</strong></p>
<ul>
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
</ul>
</li>
<li>
<p><strong>-p oauth-token=string</strong></p>
<ul>
<li>OAuth 2.0 token for the current user.</li>
</ul>
</li>
<li>
<p><strong>-p pretty-print=boolean</strong></p>
<ul>
<li>Returns response with indentations and line breaks.</li>
</ul>
</li>
<li>
<p><strong>-p quota-user=string</strong></p>
<ul>
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
</ul>
</li>
<li>
<p><strong>-p upload-type=string</strong></p>
<ul>
<li>Legacy upload protocol for media (e.g. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../projects_github-enterprise-configs-delete/" class="btn btn-neutral float-left" title="Github Enterprise Configs Delete"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../projects_github-enterprise-configs-list/" class="btn btn-neutral float-right" title="Github Enterprise Configs List">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
<p>Copyright &copy; 2015-2020, `Sebastian Thiel`</p>
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudbuild1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../projects_github-enterprise-configs-delete/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../projects_github-enterprise-configs-list/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>