blob: b60c70e8a187841aa251664aae487422212b00b0 [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>PolicyOrBuilder (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="PolicyOrBuilder (java API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/PolicyDeltaOrBuilder.html" title="interface in com.google.iam.v1"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/google/iam/v1/PolicyProto.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/PolicyOrBuilder.html" target="_top">Frames</a></li>
<li><a href="PolicyOrBuilder.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="Interface PolicyOrBuilder" class="title">Interface PolicyOrBuilder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageLiteOrBuilder</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageOrBuilder</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../com/google/iam/v1/Policy.html" title="class in com.google.iam.v1">Policy</a>, <a href="../../../../com/google/iam/v1/Policy.Builder.html" title="class in com.google.iam.v1">Policy.Builder</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">PolicyOrBuilder</span>
extends <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageOrBuilder</a></pre>
</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="../../../../com/google/iam/v1/Binding.html" title="class in com.google.iam.v1">Binding</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/iam/v1/PolicyOrBuilder.html#getBindings-int-">getBindings</a></span>(int&nbsp;index)</code>
<div class="block">
Associates a list of `members` to a `role`.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/iam/v1/PolicyOrBuilder.html#getBindingsCount--">getBindingsCount</a></span>()</code>
<div class="block">
Associates a list of `members` to a `role`.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../com/google/iam/v1/Binding.html" title="class in com.google.iam.v1">Binding</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/iam/v1/PolicyOrBuilder.html#getBindingsList--">getBindingsList</a></span>()</code>
<div class="block">
Associates a list of `members` to a `role`.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/google/iam/v1/BindingOrBuilder.html" title="interface in com.google.iam.v1">BindingOrBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/iam/v1/PolicyOrBuilder.html#getBindingsOrBuilder-int-">getBindingsOrBuilder</a></span>(int&nbsp;index)</code>
<div class="block">
Associates a list of `members` to a `role`.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.List&lt;? extends <a href="../../../../com/google/iam/v1/BindingOrBuilder.html" title="interface in com.google.iam.v1">BindingOrBuilder</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/iam/v1/PolicyOrBuilder.html#getBindingsOrBuilderList--">getBindingsOrBuilderList</a></span>()</code>
<div class="block">
Associates a list of `members` to a `role`.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/iam/v1/PolicyOrBuilder.html#getEtag--">getEtag</a></span>()</code>
<div class="block">
`etag` is used for optimistic concurrency control as a way to help
prevent simultaneous updates of a policy from overwriting each other.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/iam/v1/PolicyOrBuilder.html#getVersion--">getVersion</a></span>()</code>
<div class="block">
Specifies the format of the policy.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageOrBuilder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.google.protobuf.<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageOrBuilder</a></h3>
<code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#findInitializationErrors--" title="class or interface in com.google.protobuf">findInitializationErrors</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getAllFields--" title="class or interface in com.google.protobuf">getAllFields</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getDefaultInstanceForType--" title="class or interface in com.google.protobuf">getDefaultInstanceForType</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getDescriptorForType--" title="class or interface in com.google.protobuf">getDescriptorForType</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getField-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf">getField</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getInitializationErrorString--" title="class or interface in com.google.protobuf">getInitializationErrorString</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getOneofFieldDescriptor-com.google.protobuf.Descriptors.OneofDescriptor-" title="class or interface in com.google.protobuf">getOneofFieldDescriptor</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getRepeatedField-com.google.protobuf.Descriptors.FieldDescriptor-int-" title="class or interface in com.google.protobuf">getRepeatedField</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getRepeatedFieldCount-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf">getRepeatedFieldCount</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getUnknownFields--" title="class or interface in com.google.protobuf">getUnknownFields</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#hasField-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf">hasField</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#hasOneof-com.google.protobuf.Descriptors.OneofDescriptor-" title="class or interface in com.google.protobuf">hasOneof</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageLiteOrBuilder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.google.protobuf.<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageLiteOrBuilder</a></h3>
<code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true#isInitialized--" title="class or interface in com.google.protobuf">isInitialized</a></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="getVersion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVersion</h4>
<pre>int&nbsp;getVersion()</pre>
<div class="block"><pre>
Specifies the format of the policy.
Valid values are 0, 1, and 3. Requests specifying an invalid value will be
rejected.
Operations affecting conditional bindings must specify version 3. This can
be either setting a conditional policy, modifying a conditional binding,
or removing a conditional binding from the stored conditional policy.
Operations on non-conditional policies may specify any valid value or
leave the field unset.
If no etag is provided in the call to `setIamPolicy`, any version
compliance checks on the incoming and/or stored policy is skipped.
</pre>
<code>int32 version = 1;</code></div>
</li>
</ul>
<a name="getBindingsList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBindingsList</h4>
<pre>java.util.List&lt;<a href="../../../../com/google/iam/v1/Binding.html" title="class in com.google.iam.v1">Binding</a>&gt;&nbsp;getBindingsList()</pre>
<div class="block"><pre>
Associates a list of `members` to a `role`. Optionally may specify a
`condition` that determines when binding is in effect.
`bindings` with no members will result in an error.
</pre>
<code>repeated .google.iam.v1.Binding bindings = 4;</code></div>
</li>
</ul>
<a name="getBindings-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBindings</h4>
<pre><a href="../../../../com/google/iam/v1/Binding.html" title="class in com.google.iam.v1">Binding</a>&nbsp;getBindings(int&nbsp;index)</pre>
<div class="block"><pre>
Associates a list of `members` to a `role`. Optionally may specify a
`condition` that determines when binding is in effect.
`bindings` with no members will result in an error.
</pre>
<code>repeated .google.iam.v1.Binding bindings = 4;</code></div>
</li>
</ul>
<a name="getBindingsCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBindingsCount</h4>
<pre>int&nbsp;getBindingsCount()</pre>
<div class="block"><pre>
Associates a list of `members` to a `role`. Optionally may specify a
`condition` that determines when binding is in effect.
`bindings` with no members will result in an error.
</pre>
<code>repeated .google.iam.v1.Binding bindings = 4;</code></div>
</li>
</ul>
<a name="getBindingsOrBuilderList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBindingsOrBuilderList</h4>
<pre>java.util.List&lt;? extends <a href="../../../../com/google/iam/v1/BindingOrBuilder.html" title="interface in com.google.iam.v1">BindingOrBuilder</a>&gt;&nbsp;getBindingsOrBuilderList()</pre>
<div class="block"><pre>
Associates a list of `members` to a `role`. Optionally may specify a
`condition` that determines when binding is in effect.
`bindings` with no members will result in an error.
</pre>
<code>repeated .google.iam.v1.Binding bindings = 4;</code></div>
</li>
</ul>
<a name="getBindingsOrBuilder-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBindingsOrBuilder</h4>
<pre><a href="../../../../com/google/iam/v1/BindingOrBuilder.html" title="interface in com.google.iam.v1">BindingOrBuilder</a>&nbsp;getBindingsOrBuilder(int&nbsp;index)</pre>
<div class="block"><pre>
Associates a list of `members` to a `role`. Optionally may specify a
`condition` that determines when binding is in effect.
`bindings` with no members will result in an error.
</pre>
<code>repeated .google.iam.v1.Binding bindings = 4;</code></div>
</li>
</ul>
<a name="getEtag--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getEtag</h4>
<pre><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a>&nbsp;getEtag()</pre>
<div class="block"><pre>
`etag` is used for optimistic concurrency control as a way to help
prevent simultaneous updates of a policy from overwriting each other.
It is strongly suggested that systems make use of the `etag` in the
read-modify-write cycle to perform policy updates in order to avoid race
conditions: An `etag` is returned in the response to `getIamPolicy`, and
systems are expected to put that etag in the request to `setIamPolicy` to
ensure that their change will be applied to the same version of the policy.
If no `etag` is provided in the call to `setIamPolicy`, then the existing
policy is overwritten. Due to blind-set semantics of an etag-less policy,
'setIamPolicy' will not fail even if either of incoming or stored policy
does not meet the version requirements.
</pre>
<code>bytes etag = 3;</code></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/PolicyDeltaOrBuilder.html" title="interface in com.google.iam.v1"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/google/iam/v1/PolicyProto.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/PolicyOrBuilder.html" target="_top">Frames</a></li>
<li><a href="PolicyOrBuilder.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>