blob: 0434c31560cdbcf44a2b19a9e05b82fd2aeb3e72 [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_131-google-v7) on Thu Apr 19 15:02:05 PDT 2018 -->
<title>ClusterOrBuilder (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="ClusterOrBuilder (java API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":38,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated 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/ClusterOperationStatusOrBuilder.html" title="interface in com.google.cloud.dataproc.v1"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/google/cloud/dataproc/v1/ClustersProto.html" title="class in com.google.cloud.dataproc.v1"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/google/cloud/dataproc/v1/ClusterOrBuilder.html" target="_top">Frames</a></li>
<li><a href="ClusterOrBuilder.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.cloud.dataproc.v1</div>
<h2 title="Interface ClusterOrBuilder" class="title">Interface ClusterOrBuilder</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/Cluster.html" title="class in com.google.cloud.dataproc.v1">Cluster</a>, <a href="../../../../../com/google/cloud/dataproc/v1/Cluster.Builder.html" title="class in com.google.cloud.dataproc.v1">Cluster.Builder</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ClusterOrBuilder</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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/cloud/dataproc/v1/ClusterOrBuilder.html#containsLabels-java.lang.String-">containsLabels</a></span>(java.lang.String&nbsp;key)</code>
<div class="block">
Optional.</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/ClusterOrBuilder.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/ClusterOrBuilder.html#getClusterNameBytes--">getClusterNameBytes</a></span>()</code>
<div class="block">
Required.</div>
</td>
</tr>
<tr id="i3" 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/ClusterOrBuilder.html#getClusterUuid--">getClusterUuid</a></span>()</code>
<div class="block">
Output-only.</div>
</td>
</tr>
<tr id="i4" 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/ClusterOrBuilder.html#getClusterUuidBytes--">getClusterUuidBytes</a></span>()</code>
<div class="block">
Output-only.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../com/google/cloud/dataproc/v1/ClusterConfig.html" title="class in com.google.cloud.dataproc.v1">ClusterConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/ClusterOrBuilder.html#getConfig--">getConfig</a></span>()</code>
<div class="block">
Required.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../com/google/cloud/dataproc/v1/ClusterConfigOrBuilder.html" title="interface in com.google.cloud.dataproc.v1">ClusterConfigOrBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/ClusterOrBuilder.html#getConfigOrBuilder--">getConfigOrBuilder</a></span>()</code>
<div class="block">
Required.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/ClusterOrBuilder.html#getLabels--">getLabels</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/ClusterOrBuilder.html#getLabelsCount--">getLabelsCount</a></span>()</code>
<div class="block">
Optional.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/ClusterOrBuilder.html#getLabelsMap--">getLabelsMap</a></span>()</code>
<div class="block">
Optional.</div>
</td>
</tr>
<tr id="i10" 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/ClusterOrBuilder.html#getLabelsOrDefault-java.lang.String-java.lang.String-">getLabelsOrDefault</a></span>(java.lang.String&nbsp;key,
java.lang.String&nbsp;defaultValue)</code>
<div class="block">
Optional.</div>
</td>
</tr>
<tr id="i11" 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/ClusterOrBuilder.html#getLabelsOrThrow-java.lang.String-">getLabelsOrThrow</a></span>(java.lang.String&nbsp;key)</code>
<div class="block">
Optional.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../../com/google/cloud/dataproc/v1/ClusterMetrics.html" title="class in com.google.cloud.dataproc.v1">ClusterMetrics</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/ClusterOrBuilder.html#getMetrics--">getMetrics</a></span>()</code>
<div class="block">
Contains cluster daemon metrics such as HDFS and YARN stats.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../../com/google/cloud/dataproc/v1/ClusterMetricsOrBuilder.html" title="interface in com.google.cloud.dataproc.v1">ClusterMetricsOrBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/ClusterOrBuilder.html#getMetricsOrBuilder--">getMetricsOrBuilder</a></span>()</code>
<div class="block">
Contains cluster daemon metrics such as HDFS and YARN stats.</div>
</td>
</tr>
<tr id="i14" 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/ClusterOrBuilder.html#getProjectId--">getProjectId</a></span>()</code>
<div class="block">
Required.</div>
</td>
</tr>
<tr id="i15" 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/ClusterOrBuilder.html#getProjectIdBytes--">getProjectIdBytes</a></span>()</code>
<div class="block">
Required.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../../../com/google/cloud/dataproc/v1/ClusterStatus.html" title="class in com.google.cloud.dataproc.v1">ClusterStatus</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/ClusterOrBuilder.html#getStatus--">getStatus</a></span>()</code>
<div class="block">
Output-only.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../../com/google/cloud/dataproc/v1/ClusterStatus.html" title="class in com.google.cloud.dataproc.v1">ClusterStatus</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/ClusterOrBuilder.html#getStatusHistory-int-">getStatusHistory</a></span>(int&nbsp;index)</code>
<div class="block">
Output-only.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/ClusterOrBuilder.html#getStatusHistoryCount--">getStatusHistoryCount</a></span>()</code>
<div class="block">
Output-only.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../com/google/cloud/dataproc/v1/ClusterStatus.html" title="class in com.google.cloud.dataproc.v1">ClusterStatus</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/ClusterOrBuilder.html#getStatusHistoryList--">getStatusHistoryList</a></span>()</code>
<div class="block">
Output-only.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="../../../../../com/google/cloud/dataproc/v1/ClusterStatusOrBuilder.html" title="interface in com.google.cloud.dataproc.v1">ClusterStatusOrBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/ClusterOrBuilder.html#getStatusHistoryOrBuilder-int-">getStatusHistoryOrBuilder</a></span>(int&nbsp;index)</code>
<div class="block">
Output-only.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;? extends <a href="../../../../../com/google/cloud/dataproc/v1/ClusterStatusOrBuilder.html" title="interface in com.google.cloud.dataproc.v1">ClusterStatusOrBuilder</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/ClusterOrBuilder.html#getStatusHistoryOrBuilderList--">getStatusHistoryOrBuilderList</a></span>()</code>
<div class="block">
Output-only.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="../../../../../com/google/cloud/dataproc/v1/ClusterStatusOrBuilder.html" title="interface in com.google.cloud.dataproc.v1">ClusterStatusOrBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/ClusterOrBuilder.html#getStatusOrBuilder--">getStatusOrBuilder</a></span>()</code>
<div class="block">
Output-only.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/ClusterOrBuilder.html#hasConfig--">hasConfig</a></span>()</code>
<div class="block">
Required.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/ClusterOrBuilder.html#hasMetrics--">hasMetrics</a></span>()</code>
<div class="block">
Contains cluster daemon metrics such as HDFS and YARN stats.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/dataproc/v1/ClusterOrBuilder.html#hasStatus--">hasStatus</a></span>()</code>
<div class="block">
Output-only.</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="getProjectId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProjectId</h4>
<pre>java.lang.String&nbsp;getProjectId()</pre>
<div class="block"><pre>
Required. The Google Cloud Platform project ID that 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>&nbsp;getProjectIdBytes()</pre>
<div class="block"><pre>
Required. The Google Cloud Platform project ID that the cluster belongs to.
</pre>
<code>string project_id = 1;</code></div>
</li>
</ul>
<a name="getClusterName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClusterName</h4>
<pre>java.lang.String&nbsp;getClusterName()</pre>
<div class="block"><pre>
Required. The cluster name. Cluster names within a project must be
unique. Names of deleted clusters can be reused.
</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>&nbsp;getClusterNameBytes()</pre>
<div class="block"><pre>
Required. The cluster name. Cluster names within a project must be
unique. Names of deleted clusters can be reused.
</pre>
<code>string cluster_name = 2;</code></div>
</li>
</ul>
<a name="hasConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasConfig</h4>
<pre>boolean&nbsp;hasConfig()</pre>
<div class="block"><pre>
Required. The cluster config. Note that Cloud Dataproc may set
default values, and values may change when clusters are updated.
</pre>
<code>.google.cloud.dataproc.v1.ClusterConfig config = 3;</code></div>
</li>
</ul>
<a name="getConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfig</h4>
<pre><a href="../../../../../com/google/cloud/dataproc/v1/ClusterConfig.html" title="class in com.google.cloud.dataproc.v1">ClusterConfig</a>&nbsp;getConfig()</pre>
<div class="block"><pre>
Required. The cluster config. Note that Cloud Dataproc may set
default values, and values may change when clusters are updated.
</pre>
<code>.google.cloud.dataproc.v1.ClusterConfig config = 3;</code></div>
</li>
</ul>
<a name="getConfigOrBuilder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfigOrBuilder</h4>
<pre><a href="../../../../../com/google/cloud/dataproc/v1/ClusterConfigOrBuilder.html" title="interface in com.google.cloud.dataproc.v1">ClusterConfigOrBuilder</a>&nbsp;getConfigOrBuilder()</pre>
<div class="block"><pre>
Required. The cluster config. Note that Cloud Dataproc may set
default values, and values may change when clusters are updated.
</pre>
<code>.google.cloud.dataproc.v1.ClusterConfig config = 3;</code></div>
</li>
</ul>
<a name="getLabelsCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLabelsCount</h4>
<pre>int&nbsp;getLabelsCount()</pre>
<div class="block"><pre>
Optional. The labels to associate with this cluster.
Label **keys** must contain 1 to 63 characters, and must conform to
[RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
Label **values** may be empty, but, if present, must contain 1 to 63
characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
No more than 32 labels can be associated with a cluster.
</pre>
<code>map&lt;string, string&gt; labels = 8;</code></div>
</li>
</ul>
<a name="containsLabels-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsLabels</h4>
<pre>boolean&nbsp;containsLabels(java.lang.String&nbsp;key)</pre>
<div class="block"><pre>
Optional. The labels to associate with this cluster.
Label **keys** must contain 1 to 63 characters, and must conform to
[RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
Label **values** may be empty, but, if present, must contain 1 to 63
characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
No more than 32 labels can be associated with a cluster.
</pre>
<code>map&lt;string, string&gt; labels = 8;</code></div>
</li>
</ul>
<a name="getLabels--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLabels</h4>
<pre>@Deprecated
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;getLabels()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Use <a href="../../../../../com/google/cloud/dataproc/v1/ClusterOrBuilder.html#getLabelsMap--"><code>getLabelsMap()</code></a> instead.</div>
</li>
</ul>
<a name="getLabelsMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLabelsMap</h4>
<pre>java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;getLabelsMap()</pre>
<div class="block"><pre>
Optional. The labels to associate with this cluster.
Label **keys** must contain 1 to 63 characters, and must conform to
[RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
Label **values** may be empty, but, if present, must contain 1 to 63
characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
No more than 32 labels can be associated with a cluster.
</pre>
<code>map&lt;string, string&gt; labels = 8;</code></div>
</li>
</ul>
<a name="getLabelsOrDefault-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLabelsOrDefault</h4>
<pre>java.lang.String&nbsp;getLabelsOrDefault(java.lang.String&nbsp;key,
java.lang.String&nbsp;defaultValue)</pre>
<div class="block"><pre>
Optional. The labels to associate with this cluster.
Label **keys** must contain 1 to 63 characters, and must conform to
[RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
Label **values** may be empty, but, if present, must contain 1 to 63
characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
No more than 32 labels can be associated with a cluster.
</pre>
<code>map&lt;string, string&gt; labels = 8;</code></div>
</li>
</ul>
<a name="getLabelsOrThrow-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLabelsOrThrow</h4>
<pre>java.lang.String&nbsp;getLabelsOrThrow(java.lang.String&nbsp;key)</pre>
<div class="block"><pre>
Optional. The labels to associate with this cluster.
Label **keys** must contain 1 to 63 characters, and must conform to
[RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
Label **values** may be empty, but, if present, must contain 1 to 63
characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
No more than 32 labels can be associated with a cluster.
</pre>
<code>map&lt;string, string&gt; labels = 8;</code></div>
</li>
</ul>
<a name="hasStatus--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasStatus</h4>
<pre>boolean&nbsp;hasStatus()</pre>
<div class="block"><pre>
Output-only. Cluster status.
</pre>
<code>.google.cloud.dataproc.v1.ClusterStatus status = 4;</code></div>
</li>
</ul>
<a name="getStatus--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatus</h4>
<pre><a href="../../../../../com/google/cloud/dataproc/v1/ClusterStatus.html" title="class in com.google.cloud.dataproc.v1">ClusterStatus</a>&nbsp;getStatus()</pre>
<div class="block"><pre>
Output-only. Cluster status.
</pre>
<code>.google.cloud.dataproc.v1.ClusterStatus status = 4;</code></div>
</li>
</ul>
<a name="getStatusOrBuilder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatusOrBuilder</h4>
<pre><a href="../../../../../com/google/cloud/dataproc/v1/ClusterStatusOrBuilder.html" title="interface in com.google.cloud.dataproc.v1">ClusterStatusOrBuilder</a>&nbsp;getStatusOrBuilder()</pre>
<div class="block"><pre>
Output-only. Cluster status.
</pre>
<code>.google.cloud.dataproc.v1.ClusterStatus status = 4;</code></div>
</li>
</ul>
<a name="getStatusHistoryList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatusHistoryList</h4>
<pre>java.util.List&lt;<a href="../../../../../com/google/cloud/dataproc/v1/ClusterStatus.html" title="class in com.google.cloud.dataproc.v1">ClusterStatus</a>&gt;&nbsp;getStatusHistoryList()</pre>
<div class="block"><pre>
Output-only. The previous cluster status.
</pre>
<code>repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7;</code></div>
</li>
</ul>
<a name="getStatusHistory-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatusHistory</h4>
<pre><a href="../../../../../com/google/cloud/dataproc/v1/ClusterStatus.html" title="class in com.google.cloud.dataproc.v1">ClusterStatus</a>&nbsp;getStatusHistory(int&nbsp;index)</pre>
<div class="block"><pre>
Output-only. The previous cluster status.
</pre>
<code>repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7;</code></div>
</li>
</ul>
<a name="getStatusHistoryCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatusHistoryCount</h4>
<pre>int&nbsp;getStatusHistoryCount()</pre>
<div class="block"><pre>
Output-only. The previous cluster status.
</pre>
<code>repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7;</code></div>
</li>
</ul>
<a name="getStatusHistoryOrBuilderList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatusHistoryOrBuilderList</h4>
<pre>java.util.List&lt;? extends <a href="../../../../../com/google/cloud/dataproc/v1/ClusterStatusOrBuilder.html" title="interface in com.google.cloud.dataproc.v1">ClusterStatusOrBuilder</a>&gt;&nbsp;getStatusHistoryOrBuilderList()</pre>
<div class="block"><pre>
Output-only. The previous cluster status.
</pre>
<code>repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7;</code></div>
</li>
</ul>
<a name="getStatusHistoryOrBuilder-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatusHistoryOrBuilder</h4>
<pre><a href="../../../../../com/google/cloud/dataproc/v1/ClusterStatusOrBuilder.html" title="interface in com.google.cloud.dataproc.v1">ClusterStatusOrBuilder</a>&nbsp;getStatusHistoryOrBuilder(int&nbsp;index)</pre>
<div class="block"><pre>
Output-only. The previous cluster status.
</pre>
<code>repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7;</code></div>
</li>
</ul>
<a name="getClusterUuid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClusterUuid</h4>
<pre>java.lang.String&nbsp;getClusterUuid()</pre>
<div class="block"><pre>
Output-only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc
generates this value when it creates the cluster.
</pre>
<code>string cluster_uuid = 6;</code></div>
</li>
</ul>
<a name="getClusterUuidBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClusterUuidBytes</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;getClusterUuidBytes()</pre>
<div class="block"><pre>
Output-only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc
generates this value when it creates the cluster.
</pre>
<code>string cluster_uuid = 6;</code></div>
</li>
</ul>
<a name="hasMetrics--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasMetrics</h4>
<pre>boolean&nbsp;hasMetrics()</pre>
<div class="block"><pre>
Contains cluster daemon metrics such as HDFS and YARN stats.
**Beta Feature**: This report is available for testing purposes only. It may
be changed before final release.
</pre>
<code>.google.cloud.dataproc.v1.ClusterMetrics metrics = 9;</code></div>
</li>
</ul>
<a name="getMetrics--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetrics</h4>
<pre><a href="../../../../../com/google/cloud/dataproc/v1/ClusterMetrics.html" title="class in com.google.cloud.dataproc.v1">ClusterMetrics</a>&nbsp;getMetrics()</pre>
<div class="block"><pre>
Contains cluster daemon metrics such as HDFS and YARN stats.
**Beta Feature**: This report is available for testing purposes only. It may
be changed before final release.
</pre>
<code>.google.cloud.dataproc.v1.ClusterMetrics metrics = 9;</code></div>
</li>
</ul>
<a name="getMetricsOrBuilder--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getMetricsOrBuilder</h4>
<pre><a href="../../../../../com/google/cloud/dataproc/v1/ClusterMetricsOrBuilder.html" title="interface in com.google.cloud.dataproc.v1">ClusterMetricsOrBuilder</a>&nbsp;getMetricsOrBuilder()</pre>
<div class="block"><pre>
Contains cluster daemon metrics such as HDFS and YARN stats.
**Beta Feature**: This report is available for testing purposes only. It may
be changed before final release.
</pre>
<code>.google.cloud.dataproc.v1.ClusterMetrics metrics = 9;</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/ClusterOperationStatusOrBuilder.html" title="interface in com.google.cloud.dataproc.v1"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/google/cloud/dataproc/v1/ClustersProto.html" title="class in com.google.cloud.dataproc.v1"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/google/cloud/dataproc/v1/ClusterOrBuilder.html" target="_top">Frames</a></li>
<li><a href="ClusterOrBuilder.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>