| <!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_131-google-v7) on Thu Apr 19 15:02:07 PDT 2018 --> |
| <title>UpdateClusterRequestOrBuilder (java API)</title> |
| <meta name="date" content="2018-04-19"> |
| <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="UpdateClusterRequestOrBuilder (java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":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/cloud/dataproc/v1/UpdateClusterRequest.Builder.html" title="class in com.google.cloud.dataproc.v1"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../com/google/cloud/dataproc/v1/UpdateJobRequest.html" title="class in com.google.cloud.dataproc.v1"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?com/google/cloud/dataproc/v1/UpdateClusterRequestOrBuilder.html" target="_top">Frames</a></li> |
| <li><a href="UpdateClusterRequestOrBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.cloud.dataproc.v1</div> |
| <h2 title="Interface UpdateClusterRequestOrBuilder" class="title">Interface UpdateClusterRequestOrBuilder</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/cloud/dataproc/v1/UpdateClusterRequest.html" title="class in com.google.cloud.dataproc.v1">UpdateClusterRequest</a>, <a href="../../../../../com/google/cloud/dataproc/v1/UpdateClusterRequest.Builder.html" title="class in com.google.cloud.dataproc.v1">UpdateClusterRequest.Builder</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">UpdateClusterRequestOrBuilder</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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/cloud/dataproc/v1/Cluster.html" title="class in com.google.cloud.dataproc.v1">Cluster</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/UpdateClusterRequestOrBuilder.html#getCluster--">getCluster</a></span>()</code> |
| <div class="block"> |
| Required.</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/cloud/dataproc/v1/UpdateClusterRequestOrBuilder.html#getClusterName--">getClusterName</a></span>()</code> |
| <div class="block"> |
| Required.</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/cloud/dataproc/v1/UpdateClusterRequestOrBuilder.html#getClusterNameBytes--">getClusterNameBytes</a></span>()</code> |
| <div class="block"> |
| Required.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../com/google/cloud/dataproc/v1/ClusterOrBuilder.html" title="interface in com.google.cloud.dataproc.v1">ClusterOrBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/UpdateClusterRequestOrBuilder.html#getClusterOrBuilder--">getClusterOrBuilder</a></span>()</code> |
| <div class="block"> |
| Required.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/UpdateClusterRequestOrBuilder.html#getProjectId--">getProjectId</a></span>()</code> |
| <div class="block"> |
| Required.</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/cloud/dataproc/v1/UpdateClusterRequestOrBuilder.html#getProjectIdBytes--">getProjectIdBytes</a></span>()</code> |
| <div class="block"> |
| Required.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/UpdateClusterRequestOrBuilder.html#getRegion--">getRegion</a></span>()</code> |
| <div class="block"> |
| Required.</div> |
| </td> |
| </tr> |
| <tr id="i7" 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/cloud/dataproc/v1/UpdateClusterRequestOrBuilder.html#getRegionBytes--">getRegionBytes</a></span>()</code> |
| <div class="block"> |
| Required.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <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/cloud/dataproc/v1/UpdateClusterRequestOrBuilder.html#getUpdateMask--">getUpdateMask</a></span>()</code> |
| <div class="block"> |
| Required.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <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/cloud/dataproc/v1/UpdateClusterRequestOrBuilder.html#getUpdateMaskOrBuilder--">getUpdateMaskOrBuilder</a></span>()</code> |
| <div class="block"> |
| Required.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/UpdateClusterRequestOrBuilder.html#hasCluster--">hasCluster</a></span>()</code> |
| <div class="block"> |
| Required.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/UpdateClusterRequestOrBuilder.html#hasUpdateMask--">hasUpdateMask</a></span>()</code> |
| <div class="block"> |
| Required.</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 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 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="getProjectId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProjectId</h4> |
| <pre>java.lang.String getProjectId()</pre> |
| <div class="block"><pre> |
| Required. The ID of the Google Cloud Platform project the |
| cluster belongs to. |
| </pre> |
| |
| <code>string project_id = 1;</code></div> |
| </li> |
| </ul> |
| <a name="getProjectIdBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProjectIdBytes</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> getProjectIdBytes()</pre> |
| <div class="block"><pre> |
| Required. The ID of the Google Cloud Platform project the |
| cluster belongs to. |
| </pre> |
| |
| <code>string project_id = 1;</code></div> |
| </li> |
| </ul> |
| <a name="getRegion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegion</h4> |
| <pre>java.lang.String getRegion()</pre> |
| <div class="block"><pre> |
| Required. The Cloud Dataproc region in which to handle the request. |
| </pre> |
| |
| <code>string region = 5;</code></div> |
| </li> |
| </ul> |
| <a name="getRegionBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegionBytes</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> getRegionBytes()</pre> |
| <div class="block"><pre> |
| Required. The Cloud Dataproc region in which to handle the request. |
| </pre> |
| |
| <code>string region = 5;</code></div> |
| </li> |
| </ul> |
| <a name="getClusterName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClusterName</h4> |
| <pre>java.lang.String getClusterName()</pre> |
| <div class="block"><pre> |
| Required. The cluster name. |
| </pre> |
| |
| <code>string cluster_name = 2;</code></div> |
| </li> |
| </ul> |
| <a name="getClusterNameBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClusterNameBytes</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> getClusterNameBytes()</pre> |
| <div class="block"><pre> |
| Required. The cluster name. |
| </pre> |
| |
| <code>string cluster_name = 2;</code></div> |
| </li> |
| </ul> |
| <a name="hasCluster--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasCluster</h4> |
| <pre>boolean hasCluster()</pre> |
| <div class="block"><pre> |
| Required. The changes to the cluster. |
| </pre> |
| |
| <code>.google.cloud.dataproc.v1.Cluster cluster = 3;</code></div> |
| </li> |
| </ul> |
| <a name="getCluster--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCluster</h4> |
| <pre><a href="../../../../../com/google/cloud/dataproc/v1/Cluster.html" title="class in com.google.cloud.dataproc.v1">Cluster</a> getCluster()</pre> |
| <div class="block"><pre> |
| Required. The changes to the cluster. |
| </pre> |
| |
| <code>.google.cloud.dataproc.v1.Cluster cluster = 3;</code></div> |
| </li> |
| </ul> |
| <a name="getClusterOrBuilder--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClusterOrBuilder</h4> |
| <pre><a href="../../../../../com/google/cloud/dataproc/v1/ClusterOrBuilder.html" title="interface in com.google.cloud.dataproc.v1">ClusterOrBuilder</a> getClusterOrBuilder()</pre> |
| <div class="block"><pre> |
| Required. The changes to the cluster. |
| </pre> |
| |
| <code>.google.cloud.dataproc.v1.Cluster cluster = 3;</code></div> |
| </li> |
| </ul> |
| <a name="hasUpdateMask--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasUpdateMask</h4> |
| <pre>boolean hasUpdateMask()</pre> |
| <div class="block"><pre> |
| Required. Specifies the path, relative to `Cluster`, of |
| the field to update. For example, to change the number of workers |
| in a cluster to 5, the `update_mask` parameter would be |
| specified as `config.worker_config.num_instances`, |
| and the `PATCH` request body would specify the new value, as follows: |
| { |
| "config":{ |
| "workerConfig":{ |
| "numInstances":"5" |
| } |
| } |
| } |
| Similarly, to change the number of preemptible workers in a cluster to 5, |
| the `update_mask` parameter would be |
| `config.secondary_worker_config.num_instances`, and the `PATCH` request |
| body would be set as follows: |
| { |
| "config":{ |
| "secondaryWorkerConfig":{ |
| "numInstances":"5" |
| } |
| } |
| } |
| <strong>Note:</strong> Currently, only the following fields can be updated: |
| <table> |
| <tbody> |
| <tr> |
| <td><strong>Mask</strong></td> |
| <td><strong>Purpose</strong></td> |
| </tr> |
| <tr> |
| <td><strong><em>labels</em></strong></td> |
| <td>Update labels</td> |
| </tr> |
| <tr> |
| <td><strong><em>config.worker_config.num_instances</em></strong></td> |
| <td>Resize primary worker group</td> |
| </tr> |
| <tr> |
| <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td> |
| <td>Resize secondary worker group</td> |
| </tr> |
| </tbody> |
| </table> |
| </pre> |
| |
| <code>.google.protobuf.FieldMask update_mask = 4;</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> getUpdateMask()</pre> |
| <div class="block"><pre> |
| Required. Specifies the path, relative to `Cluster`, of |
| the field to update. For example, to change the number of workers |
| in a cluster to 5, the `update_mask` parameter would be |
| specified as `config.worker_config.num_instances`, |
| and the `PATCH` request body would specify the new value, as follows: |
| { |
| "config":{ |
| "workerConfig":{ |
| "numInstances":"5" |
| } |
| } |
| } |
| Similarly, to change the number of preemptible workers in a cluster to 5, |
| the `update_mask` parameter would be |
| `config.secondary_worker_config.num_instances`, and the `PATCH` request |
| body would be set as follows: |
| { |
| "config":{ |
| "secondaryWorkerConfig":{ |
| "numInstances":"5" |
| } |
| } |
| } |
| <strong>Note:</strong> Currently, only the following fields can be updated: |
| <table> |
| <tbody> |
| <tr> |
| <td><strong>Mask</strong></td> |
| <td><strong>Purpose</strong></td> |
| </tr> |
| <tr> |
| <td><strong><em>labels</em></strong></td> |
| <td>Update labels</td> |
| </tr> |
| <tr> |
| <td><strong><em>config.worker_config.num_instances</em></strong></td> |
| <td>Resize primary worker group</td> |
| </tr> |
| <tr> |
| <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td> |
| <td>Resize secondary worker group</td> |
| </tr> |
| </tbody> |
| </table> |
| </pre> |
| |
| <code>.google.protobuf.FieldMask update_mask = 4;</code></div> |
| </li> |
| </ul> |
| <a name="getUpdateMaskOrBuilder--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <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> getUpdateMaskOrBuilder()</pre> |
| <div class="block"><pre> |
| Required. Specifies the path, relative to `Cluster`, of |
| the field to update. For example, to change the number of workers |
| in a cluster to 5, the `update_mask` parameter would be |
| specified as `config.worker_config.num_instances`, |
| and the `PATCH` request body would specify the new value, as follows: |
| { |
| "config":{ |
| "workerConfig":{ |
| "numInstances":"5" |
| } |
| } |
| } |
| Similarly, to change the number of preemptible workers in a cluster to 5, |
| the `update_mask` parameter would be |
| `config.secondary_worker_config.num_instances`, and the `PATCH` request |
| body would be set as follows: |
| { |
| "config":{ |
| "secondaryWorkerConfig":{ |
| "numInstances":"5" |
| } |
| } |
| } |
| <strong>Note:</strong> Currently, only the following fields can be updated: |
| <table> |
| <tbody> |
| <tr> |
| <td><strong>Mask</strong></td> |
| <td><strong>Purpose</strong></td> |
| </tr> |
| <tr> |
| <td><strong><em>labels</em></strong></td> |
| <td>Update labels</td> |
| </tr> |
| <tr> |
| <td><strong><em>config.worker_config.num_instances</em></strong></td> |
| <td>Resize primary worker group</td> |
| </tr> |
| <tr> |
| <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td> |
| <td>Resize secondary worker group</td> |
| </tr> |
| </tbody> |
| </table> |
| </pre> |
| |
| <code>.google.protobuf.FieldMask update_mask = 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/cloud/dataproc/v1/UpdateClusterRequest.Builder.html" title="class in com.google.cloud.dataproc.v1"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../com/google/cloud/dataproc/v1/UpdateJobRequest.html" title="class in com.google.cloud.dataproc.v1"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?com/google/cloud/dataproc/v1/UpdateClusterRequestOrBuilder.html" target="_top">Frames</a></li> |
| <li><a href="UpdateClusterRequestOrBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
