Files
google-apis-rs/google_pubsub1_cli/projects_subscriptions-get-iam-policy/index.html
2024-03-05 21:06:01 +01:00

329 lines
17 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-pubsub1-cli/projects_subscriptions-get-iam-policy/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Subscriptions Get Iam Policy - Pubsub v5.0.4+20240227</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 = "Subscriptions Get Iam Policy";
var mkdocs_page_input_path = "projects_subscriptions-get-iam-policy.md";
var mkdocs_page_url = "/google-apis-rs/google-pubsub1-cli/projects_subscriptions-get-iam-policy/";
</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"> Pubsub v5.0.4+20240227
</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">Projects</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../projects_schemas-commit/">Schemas Commit</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_schemas-create/">Schemas Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_schemas-delete/">Schemas Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_schemas-delete-revision/">Schemas Delete Revision</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_schemas-get/">Schemas Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_schemas-get-iam-policy/">Schemas Get Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_schemas-list/">Schemas List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_schemas-list-revisions/">Schemas List Revisions</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_schemas-rollback/">Schemas Rollback</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_schemas-set-iam-policy/">Schemas Set Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_schemas-test-iam-permissions/">Schemas Test Iam Permissions</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_schemas-validate/">Schemas Validate</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_schemas-validate-message/">Schemas Validate Message</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_snapshots-create/">Snapshots Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_snapshots-delete/">Snapshots Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_snapshots-get/">Snapshots Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_snapshots-get-iam-policy/">Snapshots Get Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_snapshots-list/">Snapshots List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_snapshots-patch/">Snapshots Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_snapshots-set-iam-policy/">Snapshots Set Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_snapshots-test-iam-permissions/">Snapshots Test Iam Permissions</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_subscriptions-acknowledge/">Subscriptions Acknowledge</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_subscriptions-create/">Subscriptions Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_subscriptions-delete/">Subscriptions Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_subscriptions-detach/">Subscriptions Detach</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_subscriptions-get/">Subscriptions Get</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Subscriptions Get Iam Policy</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_subscriptions-list/">Subscriptions List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_subscriptions-modify-ack-deadline/">Subscriptions Modify Ack Deadline</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_subscriptions-modify-push-config/">Subscriptions Modify Push Config</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_subscriptions-patch/">Subscriptions Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_subscriptions-pull/">Subscriptions Pull</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_subscriptions-seek/">Subscriptions Seek</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_subscriptions-set-iam-policy/">Subscriptions Set Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_subscriptions-test-iam-permissions/">Subscriptions Test Iam Permissions</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_topics-create/">Topics Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_topics-delete/">Topics Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_topics-get/">Topics Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_topics-get-iam-policy/">Topics Get Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_topics-list/">Topics List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_topics-patch/">Topics Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_topics-publish/">Topics Publish</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_topics-set-iam-policy/">Topics Set Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_topics-snapshots-list/">Topics Snapshots List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_topics-subscriptions-list/">Topics Subscriptions List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_topics-test-iam-permissions/">Topics Test Iam Permissions</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="..">Pubsub v5.0.4+20240227</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>Subscriptions Get Iam Policy</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/pubsub1-cli/edit/master/docs/projects_subscriptions-get-iam-policy.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>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
<ul>
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
<li><em>https://www.googleapis.com/auth/pubsub</em></li>
</ul>
<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>pubsub1 --scope &lt;scope&gt; projects subscriptions-get-iam-policy ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;resource&gt;</strong> <em>(string)</em><ul>
<li>REQUIRED: The resource for which the policy is being requested. See <a href="https://cloud.google.com/apis/design/resource_names">Resource names</a> for the appropriate value for this field.</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><strong>-p options-requested-policy-version=integer</strong><ul>
<li>Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the <a href="https://cloud.google.com/iam/help/conditions/resource-policies">IAM documentation</a>.</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_subscriptions-get/" class="btn btn-neutral float-left" title="Subscriptions Get"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../projects_subscriptions-list/" class="btn btn-neutral float-right" title="Subscriptions 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/pubsub1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../projects_subscriptions-get/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../projects_subscriptions-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>