1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/dataproc/v1/clusters.proto 18 19 package com.google.cloud.dataproc.v1; 20 21 public interface ClusterOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.dataproc.v1.Cluster) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. The Google Cloud Platform project ID that the cluster belongs to. 31 * </pre> 32 * 33 * <code>string project_id = 1 [(.google.api.field_behavior) = REQUIRED];</code> 34 * 35 * @return The projectId. 36 */ getProjectId()37 java.lang.String getProjectId(); 38 /** 39 * 40 * 41 * <pre> 42 * Required. The Google Cloud Platform project ID that the cluster belongs to. 43 * </pre> 44 * 45 * <code>string project_id = 1 [(.google.api.field_behavior) = REQUIRED];</code> 46 * 47 * @return The bytes for projectId. 48 */ getProjectIdBytes()49 com.google.protobuf.ByteString getProjectIdBytes(); 50 51 /** 52 * 53 * 54 * <pre> 55 * Required. The cluster name, which must be unique within a project. 56 * The name must start with a lowercase letter, and can contain 57 * up to 51 lowercase letters, numbers, and hyphens. It cannot end 58 * with a hyphen. The name of a deleted cluster can be reused. 59 * </pre> 60 * 61 * <code>string cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];</code> 62 * 63 * @return The clusterName. 64 */ getClusterName()65 java.lang.String getClusterName(); 66 /** 67 * 68 * 69 * <pre> 70 * Required. The cluster name, which must be unique within a project. 71 * The name must start with a lowercase letter, and can contain 72 * up to 51 lowercase letters, numbers, and hyphens. It cannot end 73 * with a hyphen. The name of a deleted cluster can be reused. 74 * </pre> 75 * 76 * <code>string cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];</code> 77 * 78 * @return The bytes for clusterName. 79 */ getClusterNameBytes()80 com.google.protobuf.ByteString getClusterNameBytes(); 81 82 /** 83 * 84 * 85 * <pre> 86 * Optional. The cluster config for a cluster of Compute Engine Instances. 87 * Note that Dataproc may set default values, and values may change 88 * when clusters are updated. 89 * Exactly one of ClusterConfig or VirtualClusterConfig must be specified. 90 * </pre> 91 * 92 * <code> 93 * .google.cloud.dataproc.v1.ClusterConfig config = 3 [(.google.api.field_behavior) = OPTIONAL]; 94 * </code> 95 * 96 * @return Whether the config field is set. 97 */ hasConfig()98 boolean hasConfig(); 99 /** 100 * 101 * 102 * <pre> 103 * Optional. The cluster config for a cluster of Compute Engine Instances. 104 * Note that Dataproc may set default values, and values may change 105 * when clusters are updated. 106 * Exactly one of ClusterConfig or VirtualClusterConfig must be specified. 107 * </pre> 108 * 109 * <code> 110 * .google.cloud.dataproc.v1.ClusterConfig config = 3 [(.google.api.field_behavior) = OPTIONAL]; 111 * </code> 112 * 113 * @return The config. 114 */ getConfig()115 com.google.cloud.dataproc.v1.ClusterConfig getConfig(); 116 /** 117 * 118 * 119 * <pre> 120 * Optional. The cluster config for a cluster of Compute Engine Instances. 121 * Note that Dataproc may set default values, and values may change 122 * when clusters are updated. 123 * Exactly one of ClusterConfig or VirtualClusterConfig must be specified. 124 * </pre> 125 * 126 * <code> 127 * .google.cloud.dataproc.v1.ClusterConfig config = 3 [(.google.api.field_behavior) = OPTIONAL]; 128 * </code> 129 */ getConfigOrBuilder()130 com.google.cloud.dataproc.v1.ClusterConfigOrBuilder getConfigOrBuilder(); 131 132 /** 133 * 134 * 135 * <pre> 136 * Optional. The virtual cluster config is used when creating a Dataproc 137 * cluster that does not directly control the underlying compute resources, 138 * for example, when creating a [Dataproc-on-GKE 139 * cluster](https://cloud.google.com/dataproc/docs/guides/dpgke/dataproc-gke-overview). 140 * Dataproc may set default values, and values may change when 141 * clusters are updated. Exactly one of 142 * [config][google.cloud.dataproc.v1.Cluster.config] or 143 * [virtual_cluster_config][google.cloud.dataproc.v1.Cluster.virtual_cluster_config] 144 * must be specified. 145 * </pre> 146 * 147 * <code> 148 * .google.cloud.dataproc.v1.VirtualClusterConfig virtual_cluster_config = 10 [(.google.api.field_behavior) = OPTIONAL]; 149 * </code> 150 * 151 * @return Whether the virtualClusterConfig field is set. 152 */ hasVirtualClusterConfig()153 boolean hasVirtualClusterConfig(); 154 /** 155 * 156 * 157 * <pre> 158 * Optional. The virtual cluster config is used when creating a Dataproc 159 * cluster that does not directly control the underlying compute resources, 160 * for example, when creating a [Dataproc-on-GKE 161 * cluster](https://cloud.google.com/dataproc/docs/guides/dpgke/dataproc-gke-overview). 162 * Dataproc may set default values, and values may change when 163 * clusters are updated. Exactly one of 164 * [config][google.cloud.dataproc.v1.Cluster.config] or 165 * [virtual_cluster_config][google.cloud.dataproc.v1.Cluster.virtual_cluster_config] 166 * must be specified. 167 * </pre> 168 * 169 * <code> 170 * .google.cloud.dataproc.v1.VirtualClusterConfig virtual_cluster_config = 10 [(.google.api.field_behavior) = OPTIONAL]; 171 * </code> 172 * 173 * @return The virtualClusterConfig. 174 */ getVirtualClusterConfig()175 com.google.cloud.dataproc.v1.VirtualClusterConfig getVirtualClusterConfig(); 176 /** 177 * 178 * 179 * <pre> 180 * Optional. The virtual cluster config is used when creating a Dataproc 181 * cluster that does not directly control the underlying compute resources, 182 * for example, when creating a [Dataproc-on-GKE 183 * cluster](https://cloud.google.com/dataproc/docs/guides/dpgke/dataproc-gke-overview). 184 * Dataproc may set default values, and values may change when 185 * clusters are updated. Exactly one of 186 * [config][google.cloud.dataproc.v1.Cluster.config] or 187 * [virtual_cluster_config][google.cloud.dataproc.v1.Cluster.virtual_cluster_config] 188 * must be specified. 189 * </pre> 190 * 191 * <code> 192 * .google.cloud.dataproc.v1.VirtualClusterConfig virtual_cluster_config = 10 [(.google.api.field_behavior) = OPTIONAL]; 193 * </code> 194 */ getVirtualClusterConfigOrBuilder()195 com.google.cloud.dataproc.v1.VirtualClusterConfigOrBuilder getVirtualClusterConfigOrBuilder(); 196 197 /** 198 * 199 * 200 * <pre> 201 * Optional. The labels to associate with this cluster. 202 * Label **keys** must contain 1 to 63 characters, and must conform to 203 * [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). 204 * Label **values** may be empty, but, if present, must contain 1 to 63 205 * characters, and must conform to [RFC 206 * 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be 207 * associated with a cluster. 208 * </pre> 209 * 210 * <code>map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];</code> 211 */ getLabelsCount()212 int getLabelsCount(); 213 /** 214 * 215 * 216 * <pre> 217 * Optional. The labels to associate with this cluster. 218 * Label **keys** must contain 1 to 63 characters, and must conform to 219 * [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). 220 * Label **values** may be empty, but, if present, must contain 1 to 63 221 * characters, and must conform to [RFC 222 * 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be 223 * associated with a cluster. 224 * </pre> 225 * 226 * <code>map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];</code> 227 */ containsLabels(java.lang.String key)228 boolean containsLabels(java.lang.String key); 229 /** Use {@link #getLabelsMap()} instead. */ 230 @java.lang.Deprecated getLabels()231 java.util.Map<java.lang.String, java.lang.String> getLabels(); 232 /** 233 * 234 * 235 * <pre> 236 * Optional. The labels to associate with this cluster. 237 * Label **keys** must contain 1 to 63 characters, and must conform to 238 * [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). 239 * Label **values** may be empty, but, if present, must contain 1 to 63 240 * characters, and must conform to [RFC 241 * 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be 242 * associated with a cluster. 243 * </pre> 244 * 245 * <code>map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];</code> 246 */ getLabelsMap()247 java.util.Map<java.lang.String, java.lang.String> getLabelsMap(); 248 /** 249 * 250 * 251 * <pre> 252 * Optional. The labels to associate with this cluster. 253 * Label **keys** must contain 1 to 63 characters, and must conform to 254 * [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). 255 * Label **values** may be empty, but, if present, must contain 1 to 63 256 * characters, and must conform to [RFC 257 * 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be 258 * associated with a cluster. 259 * </pre> 260 * 261 * <code>map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];</code> 262 */ 263 /* nullable */ getLabelsOrDefault( java.lang.String key, java.lang.String defaultValue)264 java.lang.String getLabelsOrDefault( 265 java.lang.String key, 266 /* nullable */ 267 java.lang.String defaultValue); 268 /** 269 * 270 * 271 * <pre> 272 * Optional. The labels to associate with this cluster. 273 * Label **keys** must contain 1 to 63 characters, and must conform to 274 * [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). 275 * Label **values** may be empty, but, if present, must contain 1 to 63 276 * characters, and must conform to [RFC 277 * 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be 278 * associated with a cluster. 279 * </pre> 280 * 281 * <code>map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];</code> 282 */ getLabelsOrThrow(java.lang.String key)283 java.lang.String getLabelsOrThrow(java.lang.String key); 284 285 /** 286 * 287 * 288 * <pre> 289 * Output only. Cluster status. 290 * </pre> 291 * 292 * <code> 293 * .google.cloud.dataproc.v1.ClusterStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; 294 * </code> 295 * 296 * @return Whether the status field is set. 297 */ hasStatus()298 boolean hasStatus(); 299 /** 300 * 301 * 302 * <pre> 303 * Output only. Cluster status. 304 * </pre> 305 * 306 * <code> 307 * .google.cloud.dataproc.v1.ClusterStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; 308 * </code> 309 * 310 * @return The status. 311 */ getStatus()312 com.google.cloud.dataproc.v1.ClusterStatus getStatus(); 313 /** 314 * 315 * 316 * <pre> 317 * Output only. Cluster status. 318 * </pre> 319 * 320 * <code> 321 * .google.cloud.dataproc.v1.ClusterStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; 322 * </code> 323 */ getStatusOrBuilder()324 com.google.cloud.dataproc.v1.ClusterStatusOrBuilder getStatusOrBuilder(); 325 326 /** 327 * 328 * 329 * <pre> 330 * Output only. The previous cluster status. 331 * </pre> 332 * 333 * <code> 334 * repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 335 * </code> 336 */ getStatusHistoryList()337 java.util.List<com.google.cloud.dataproc.v1.ClusterStatus> getStatusHistoryList(); 338 /** 339 * 340 * 341 * <pre> 342 * Output only. The previous cluster status. 343 * </pre> 344 * 345 * <code> 346 * repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 347 * </code> 348 */ getStatusHistory(int index)349 com.google.cloud.dataproc.v1.ClusterStatus getStatusHistory(int index); 350 /** 351 * 352 * 353 * <pre> 354 * Output only. The previous cluster status. 355 * </pre> 356 * 357 * <code> 358 * repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 359 * </code> 360 */ getStatusHistoryCount()361 int getStatusHistoryCount(); 362 /** 363 * 364 * 365 * <pre> 366 * Output only. The previous cluster status. 367 * </pre> 368 * 369 * <code> 370 * repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 371 * </code> 372 */ 373 java.util.List<? extends com.google.cloud.dataproc.v1.ClusterStatusOrBuilder> getStatusHistoryOrBuilderList()374 getStatusHistoryOrBuilderList(); 375 /** 376 * 377 * 378 * <pre> 379 * Output only. The previous cluster status. 380 * </pre> 381 * 382 * <code> 383 * repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 384 * </code> 385 */ getStatusHistoryOrBuilder(int index)386 com.google.cloud.dataproc.v1.ClusterStatusOrBuilder getStatusHistoryOrBuilder(int index); 387 388 /** 389 * 390 * 391 * <pre> 392 * Output only. A cluster UUID (Unique Universal Identifier). Dataproc 393 * generates this value when it creates the cluster. 394 * </pre> 395 * 396 * <code>string cluster_uuid = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 397 * 398 * @return The clusterUuid. 399 */ getClusterUuid()400 java.lang.String getClusterUuid(); 401 /** 402 * 403 * 404 * <pre> 405 * Output only. A cluster UUID (Unique Universal Identifier). Dataproc 406 * generates this value when it creates the cluster. 407 * </pre> 408 * 409 * <code>string cluster_uuid = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 410 * 411 * @return The bytes for clusterUuid. 412 */ getClusterUuidBytes()413 com.google.protobuf.ByteString getClusterUuidBytes(); 414 415 /** 416 * 417 * 418 * <pre> 419 * Output only. Contains cluster daemon metrics such as HDFS and YARN stats. 420 * **Beta Feature**: This report is available for testing purposes only. It 421 * may be changed before final release. 422 * </pre> 423 * 424 * <code> 425 * .google.cloud.dataproc.v1.ClusterMetrics metrics = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; 426 * </code> 427 * 428 * @return Whether the metrics field is set. 429 */ hasMetrics()430 boolean hasMetrics(); 431 /** 432 * 433 * 434 * <pre> 435 * Output only. Contains cluster daemon metrics such as HDFS and YARN stats. 436 * **Beta Feature**: This report is available for testing purposes only. It 437 * may be changed before final release. 438 * </pre> 439 * 440 * <code> 441 * .google.cloud.dataproc.v1.ClusterMetrics metrics = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; 442 * </code> 443 * 444 * @return The metrics. 445 */ getMetrics()446 com.google.cloud.dataproc.v1.ClusterMetrics getMetrics(); 447 /** 448 * 449 * 450 * <pre> 451 * Output only. Contains cluster daemon metrics such as HDFS and YARN stats. 452 * **Beta Feature**: This report is available for testing purposes only. It 453 * may be changed before final release. 454 * </pre> 455 * 456 * <code> 457 * .google.cloud.dataproc.v1.ClusterMetrics metrics = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; 458 * </code> 459 */ getMetricsOrBuilder()460 com.google.cloud.dataproc.v1.ClusterMetricsOrBuilder getMetricsOrBuilder(); 461 } 462