blob: 5fe8bf7488001009e0285ab8eb081b551236615d [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:50 PDT 2019 -->
<title>UpdateServiceRequestOrBuilder (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="UpdateServiceRequestOrBuilder (java API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":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/appengine/v1/UpdateServiceRequest.Builder.html" title="class in com.google.appengine.v1"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/google/appengine/v1/UpdateVersionRequest.html" title="class in com.google.appengine.v1"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/google/appengine/v1/UpdateServiceRequestOrBuilder.html" target="_top">Frames</a></li>
<li><a href="UpdateServiceRequestOrBuilder.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.appengine.v1</div>
<h2 title="Interface UpdateServiceRequestOrBuilder" class="title">Interface UpdateServiceRequestOrBuilder</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/appengine/v1/UpdateServiceRequest.html" title="class in com.google.appengine.v1">UpdateServiceRequest</a>, <a href="../../../../com/google/appengine/v1/UpdateServiceRequest.Builder.html" title="class in com.google.appengine.v1">UpdateServiceRequest.Builder</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">UpdateServiceRequestOrBuilder</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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/appengine/v1/UpdateServiceRequestOrBuilder.html#getMigrateTraffic--">getMigrateTraffic</a></span>()</code>
<div class="block">
Set to `true` to gradually shift traffic from one version to another
single version.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/appengine/v1/UpdateServiceRequestOrBuilder.html#getName--">getName</a></span>()</code>
<div class="block">
Name of the resource to update.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<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/appengine/v1/UpdateServiceRequestOrBuilder.html#getNameBytes--">getNameBytes</a></span>()</code>
<div class="block">
Name of the resource to update.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/google/appengine/v1/Service.html" title="class in com.google.appengine.v1">Service</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/appengine/v1/UpdateServiceRequestOrBuilder.html#getService--">getService</a></span>()</code>
<div class="block">
A Service resource containing the updated service.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../com/google/appengine/v1/ServiceOrBuilder.html" title="interface in com.google.appengine.v1">ServiceOrBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/appengine/v1/UpdateServiceRequestOrBuilder.html#getServiceOrBuilder--">getServiceOrBuilder</a></span>()</code>
<div class="block">
A Service resource containing the updated service.</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/FieldMask.html?is-external=true" title="class or interface in com.google.protobuf">FieldMask</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/appengine/v1/UpdateServiceRequestOrBuilder.html#getUpdateMask--">getUpdateMask</a></span>()</code>
<div class="block">
Standard field mask for the set of fields to be updated.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/FieldMaskOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">FieldMaskOrBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/appengine/v1/UpdateServiceRequestOrBuilder.html#getUpdateMaskOrBuilder--">getUpdateMaskOrBuilder</a></span>()</code>
<div class="block">
Standard field mask for the set of fields to be updated.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/appengine/v1/UpdateServiceRequestOrBuilder.html#hasService--">hasService</a></span>()</code>
<div class="block">
A Service resource containing the updated service.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/appengine/v1/UpdateServiceRequestOrBuilder.html#hasUpdateMask--">hasUpdateMask</a></span>()</code>
<div class="block">
Standard field mask for the set of fields to be updated.</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="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>java.lang.String&nbsp;getName()</pre>
<div class="block"><pre>
Name of the resource to update. Example: `apps/myapp/services/default`.
</pre>
<code>string name = 1;</code></div>
</li>
</ul>
<a name="getNameBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNameBytes</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;getNameBytes()</pre>
<div class="block"><pre>
Name of the resource to update. Example: `apps/myapp/services/default`.
</pre>
<code>string name = 1;</code></div>
</li>
</ul>
<a name="hasService--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasService</h4>
<pre>boolean&nbsp;hasService()</pre>
<div class="block"><pre>
A Service resource containing the updated service. Only fields set in the
field mask will be updated.
</pre>
<code>.google.appengine.v1.Service service = 2;</code></div>
</li>
</ul>
<a name="getService--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getService</h4>
<pre><a href="../../../../com/google/appengine/v1/Service.html" title="class in com.google.appengine.v1">Service</a>&nbsp;getService()</pre>
<div class="block"><pre>
A Service resource containing the updated service. Only fields set in the
field mask will be updated.
</pre>
<code>.google.appengine.v1.Service service = 2;</code></div>
</li>
</ul>
<a name="getServiceOrBuilder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServiceOrBuilder</h4>
<pre><a href="../../../../com/google/appengine/v1/ServiceOrBuilder.html" title="interface in com.google.appengine.v1">ServiceOrBuilder</a>&nbsp;getServiceOrBuilder()</pre>
<div class="block"><pre>
A Service resource containing the updated service. Only fields set in the
field mask will be updated.
</pre>
<code>.google.appengine.v1.Service service = 2;</code></div>
</li>
</ul>
<a name="hasUpdateMask--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasUpdateMask</h4>
<pre>boolean&nbsp;hasUpdateMask()</pre>
<div class="block"><pre>
Standard field mask for the set of fields to be updated.
</pre>
<code>.google.protobuf.FieldMask update_mask = 3;</code></div>
</li>
</ul>
<a name="getUpdateMask--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUpdateMask</h4>
<pre><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/FieldMask.html?is-external=true" title="class or interface in com.google.protobuf">FieldMask</a>&nbsp;getUpdateMask()</pre>
<div class="block"><pre>
Standard field mask for the set of fields to be updated.
</pre>
<code>.google.protobuf.FieldMask update_mask = 3;</code></div>
</li>
</ul>
<a name="getUpdateMaskOrBuilder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUpdateMaskOrBuilder</h4>
<pre><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/FieldMaskOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">FieldMaskOrBuilder</a>&nbsp;getUpdateMaskOrBuilder()</pre>
<div class="block"><pre>
Standard field mask for the set of fields to be updated.
</pre>
<code>.google.protobuf.FieldMask update_mask = 3;</code></div>
</li>
</ul>
<a name="getMigrateTraffic--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getMigrateTraffic</h4>
<pre>boolean&nbsp;getMigrateTraffic()</pre>
<div class="block"><pre>
Set to `true` to gradually shift traffic from one version to another
single version. By default, traffic is shifted immediately.
For gradual traffic migration, the target version
must be located within instances that are configured for both
[warmup requests](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#inboundservicetype)
and
[automatic scaling](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#automaticscaling).
You must specify the
[`shardBy`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#shardby)
field in the Service resource. Gradual traffic migration is not
supported in the App Engine flexible environment. For examples, see
[Migrating and Splitting Traffic](https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
</pre>
<code>bool migrate_traffic = 4;</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/appengine/v1/UpdateServiceRequest.Builder.html" title="class in com.google.appengine.v1"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/google/appengine/v1/UpdateVersionRequest.html" title="class in com.google.appengine.v1"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/google/appengine/v1/UpdateServiceRequestOrBuilder.html" target="_top">Frames</a></li>
<li><a href="UpdateServiceRequestOrBuilder.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>