blob: 4b10bf2d00fae47a586cfdd4a5fde2317b411993 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_181-google-v7) on Fri Oct 04 15:32:52 PDT 2019 -->
<title>IAMPolicyGrpc.IAMPolicyFutureStub (java API)</title>
<meta name="date" content="2019-10-04">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IAMPolicyGrpc.IAMPolicyFutureStub (java API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/google/iam/v1/IAMPolicyGrpc.IAMPolicyBlockingStub.html" title="class in com.google.iam.v1"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/google/iam/v1/IAMPolicyGrpc.IAMPolicyImplBase.html" title="class in com.google.iam.v1"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/google/iam/v1/IAMPolicyGrpc.IAMPolicyFutureStub.html" target="_top">Frames</a></li>
<li><a href="IAMPolicyGrpc.IAMPolicyFutureStub.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.google.iam.v1</div>
<h2 title="Class IAMPolicyGrpc.IAMPolicyFutureStub" class="title">Class IAMPolicyGrpc.IAMPolicyFutureStub</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>io.grpc.stub.AbstractStub&lt;<a href="../../../../com/google/iam/v1/IAMPolicyGrpc.IAMPolicyFutureStub.html" title="class in com.google.iam.v1">IAMPolicyGrpc.IAMPolicyFutureStub</a>&gt;</li>
<li>
<ul class="inheritance">
<li>com.google.iam.v1.IAMPolicyGrpc.IAMPolicyFutureStub</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../com/google/iam/v1/IAMPolicyGrpc.html" title="class in com.google.iam.v1">IAMPolicyGrpc</a></dd>
</dl>
<hr>
<br>
<pre>public static final class <span class="typeNameLabel">IAMPolicyGrpc.IAMPolicyFutureStub</span>
extends io.grpc.stub.AbstractStub&lt;<a href="../../../../com/google/iam/v1/IAMPolicyGrpc.IAMPolicyFutureStub.html" title="class in com.google.iam.v1">IAMPolicyGrpc.IAMPolicyFutureStub</a>&gt;</pre>
<div class="block"><pre>
## API Overview
Manages Identity and Access Management (IAM) policies.
Any implementation of an API that offers access control features
implements the google.iam.v1.IAMPolicy interface.
## Data model
Access control is applied when a principal (user or service account), takes
some action on a resource exposed by a service. Resources, identified by
URI-like names, are the unit of access control specification. Service
implementations can choose the granularity of access control and the
supported permissions for their resources.
For example one database service may allow access control to be
specified only at the Table level, whereas another might allow access control
to also be specified at the Column level.
## Policy Structure
See google.iam.v1.Policy
This is intentionally not a CRUD style API because access control policies
are created and deleted implicitly with the resources to which they are
attached.
</pre></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected <a href="../../../../com/google/iam/v1/IAMPolicyGrpc.IAMPolicyFutureStub.html" title="class in com.google.iam.v1">IAMPolicyGrpc.IAMPolicyFutureStub</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/iam/v1/IAMPolicyGrpc.IAMPolicyFutureStub.html#build-io.grpc.Channel-io.grpc.CallOptions-">build</a></span>(io.grpc.Channel&nbsp;channel,
io.grpc.CallOptions&nbsp;callOptions)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;<a href="../../../../com/google/iam/v1/Policy.html" title="class in com.google.iam.v1">Policy</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/iam/v1/IAMPolicyGrpc.IAMPolicyFutureStub.html#getIamPolicy-com.google.iam.v1.GetIamPolicyRequest-">getIamPolicy</a></span>(<a href="../../../../com/google/iam/v1/GetIamPolicyRequest.html" title="class in com.google.iam.v1">GetIamPolicyRequest</a>&nbsp;request)</code>
<div class="block">
Gets the access control policy for a resource.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;<a href="../../../../com/google/iam/v1/Policy.html" title="class in com.google.iam.v1">Policy</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/iam/v1/IAMPolicyGrpc.IAMPolicyFutureStub.html#setIamPolicy-com.google.iam.v1.SetIamPolicyRequest-">setIamPolicy</a></span>(<a href="../../../../com/google/iam/v1/SetIamPolicyRequest.html" title="class in com.google.iam.v1">SetIamPolicyRequest</a>&nbsp;request)</code>
<div class="block">
Sets the access control policy on the specified resource.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;<a href="../../../../com/google/iam/v1/TestIamPermissionsResponse.html" title="class in com.google.iam.v1">TestIamPermissionsResponse</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/iam/v1/IAMPolicyGrpc.IAMPolicyFutureStub.html#testIamPermissions-com.google.iam.v1.TestIamPermissionsRequest-">testIamPermissions</a></span>(<a href="../../../../com/google/iam/v1/TestIamPermissionsRequest.html" title="class in com.google.iam.v1">TestIamPermissionsRequest</a>&nbsp;request)</code>
<div class="block">
Returns permissions that a caller has on the specified resource.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.io.grpc.stub.AbstractStub">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;io.grpc.stub.AbstractStub</h3>
<code>getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="build-io.grpc.Channel-io.grpc.CallOptions-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre>protected&nbsp;<a href="../../../../com/google/iam/v1/IAMPolicyGrpc.IAMPolicyFutureStub.html" title="class in com.google.iam.v1">IAMPolicyGrpc.IAMPolicyFutureStub</a>&nbsp;build(io.grpc.Channel&nbsp;channel,
io.grpc.CallOptions&nbsp;callOptions)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>build</code>&nbsp;in class&nbsp;<code>io.grpc.stub.AbstractStub&lt;<a href="../../../../com/google/iam/v1/IAMPolicyGrpc.IAMPolicyFutureStub.html" title="class in com.google.iam.v1">IAMPolicyGrpc.IAMPolicyFutureStub</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="setIamPolicy-com.google.iam.v1.SetIamPolicyRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIamPolicy</h4>
<pre>public&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;<a href="../../../../com/google/iam/v1/Policy.html" title="class in com.google.iam.v1">Policy</a>&gt;&nbsp;setIamPolicy(<a href="../../../../com/google/iam/v1/SetIamPolicyRequest.html" title="class in com.google.iam.v1">SetIamPolicyRequest</a>&nbsp;request)</pre>
<div class="block"><pre>
Sets the access control policy on the specified resource. Replaces any
existing policy.
</pre></div>
</li>
</ul>
<a name="getIamPolicy-com.google.iam.v1.GetIamPolicyRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIamPolicy</h4>
<pre>public&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;<a href="../../../../com/google/iam/v1/Policy.html" title="class in com.google.iam.v1">Policy</a>&gt;&nbsp;getIamPolicy(<a href="../../../../com/google/iam/v1/GetIamPolicyRequest.html" title="class in com.google.iam.v1">GetIamPolicyRequest</a>&nbsp;request)</pre>
<div class="block"><pre>
Gets the access control policy for a resource.
Returns an empty policy if the resource exists and does not have a policy
set.
</pre></div>
</li>
</ul>
<a name="testIamPermissions-com.google.iam.v1.TestIamPermissionsRequest-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>testIamPermissions</h4>
<pre>public&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;<a href="../../../../com/google/iam/v1/TestIamPermissionsResponse.html" title="class in com.google.iam.v1">TestIamPermissionsResponse</a>&gt;&nbsp;testIamPermissions(<a href="../../../../com/google/iam/v1/TestIamPermissionsRequest.html" title="class in com.google.iam.v1">TestIamPermissionsRequest</a>&nbsp;request)</pre>
<div class="block"><pre>
Returns permissions that a caller has on the specified resource.
If the resource does not exist, this will return an empty set of
permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware
UIs and command-line tools, not for authorization checking. This operation
may "fail open" without warning.
</pre></div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/google/iam/v1/IAMPolicyGrpc.IAMPolicyBlockingStub.html" title="class in com.google.iam.v1"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/google/iam/v1/IAMPolicyGrpc.IAMPolicyImplBase.html" title="class in com.google.iam.v1"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/google/iam/v1/IAMPolicyGrpc.IAMPolicyFutureStub.html" target="_top">Frames</a></li>
<li><a href="IAMPolicyGrpc.IAMPolicyFutureStub.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>