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 InstanceGroupConfigOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.dataproc.v1.InstanceGroupConfig) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Optional. The number of VM instances in the instance group. 31 * For [HA 32 * cluster](/dataproc/docs/concepts/configuring-clusters/high-availability) 33 * [master_config](#FIELDS.master_config) groups, **must be set to 3**. 34 * For standard cluster [master_config](#FIELDS.master_config) groups, 35 * **must be set to 1**. 36 * </pre> 37 * 38 * <code>int32 num_instances = 1 [(.google.api.field_behavior) = OPTIONAL];</code> 39 * 40 * @return The numInstances. 41 */ getNumInstances()42 int getNumInstances(); 43 44 /** 45 * 46 * 47 * <pre> 48 * Output only. The list of instance names. Dataproc derives the names 49 * from `cluster_name`, `num_instances`, and the instance group. 50 * </pre> 51 * 52 * <code>repeated string instance_names = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 53 * 54 * @return A list containing the instanceNames. 55 */ getInstanceNamesList()56 java.util.List<java.lang.String> getInstanceNamesList(); 57 /** 58 * 59 * 60 * <pre> 61 * Output only. The list of instance names. Dataproc derives the names 62 * from `cluster_name`, `num_instances`, and the instance group. 63 * </pre> 64 * 65 * <code>repeated string instance_names = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 66 * 67 * @return The count of instanceNames. 68 */ getInstanceNamesCount()69 int getInstanceNamesCount(); 70 /** 71 * 72 * 73 * <pre> 74 * Output only. The list of instance names. Dataproc derives the names 75 * from `cluster_name`, `num_instances`, and the instance group. 76 * </pre> 77 * 78 * <code>repeated string instance_names = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 79 * 80 * @param index The index of the element to return. 81 * @return The instanceNames at the given index. 82 */ getInstanceNames(int index)83 java.lang.String getInstanceNames(int index); 84 /** 85 * 86 * 87 * <pre> 88 * Output only. The list of instance names. Dataproc derives the names 89 * from `cluster_name`, `num_instances`, and the instance group. 90 * </pre> 91 * 92 * <code>repeated string instance_names = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 93 * 94 * @param index The index of the value to return. 95 * @return The bytes of the instanceNames at the given index. 96 */ getInstanceNamesBytes(int index)97 com.google.protobuf.ByteString getInstanceNamesBytes(int index); 98 99 /** 100 * 101 * 102 * <pre> 103 * Optional. The Compute Engine image resource used for cluster instances. 104 * The URI can represent an image or image family. 105 * Image examples: 106 * * `https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/[image-id]` 107 * * `projects/[project_id]/global/images/[image-id]` 108 * * `image-id` 109 * Image family examples. Dataproc will use the most recent 110 * image from the family: 111 * * `https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/family/[custom-image-family-name]` 112 * * `projects/[project_id]/global/images/family/[custom-image-family-name]` 113 * If the URI is unspecified, it will be inferred from 114 * `SoftwareConfig.image_version` or the system default. 115 * </pre> 116 * 117 * <code>string image_uri = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 118 * 119 * @return The imageUri. 120 */ getImageUri()121 java.lang.String getImageUri(); 122 /** 123 * 124 * 125 * <pre> 126 * Optional. The Compute Engine image resource used for cluster instances. 127 * The URI can represent an image or image family. 128 * Image examples: 129 * * `https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/[image-id]` 130 * * `projects/[project_id]/global/images/[image-id]` 131 * * `image-id` 132 * Image family examples. Dataproc will use the most recent 133 * image from the family: 134 * * `https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/family/[custom-image-family-name]` 135 * * `projects/[project_id]/global/images/family/[custom-image-family-name]` 136 * If the URI is unspecified, it will be inferred from 137 * `SoftwareConfig.image_version` or the system default. 138 * </pre> 139 * 140 * <code>string image_uri = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 141 * 142 * @return The bytes for imageUri. 143 */ getImageUriBytes()144 com.google.protobuf.ByteString getImageUriBytes(); 145 146 /** 147 * 148 * 149 * <pre> 150 * Optional. The Compute Engine machine type used for cluster instances. 151 * A full URL, partial URI, or short name are valid. Examples: 152 * * `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2` 153 * * `projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2` 154 * * `n1-standard-2` 155 * **Auto Zone Exception**: If you are using the Dataproc 156 * [Auto Zone 157 * Placement](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) 158 * feature, you must use the short name of the machine type 159 * resource, for example, `n1-standard-2`. 160 * </pre> 161 * 162 * <code>string machine_type_uri = 4 [(.google.api.field_behavior) = OPTIONAL];</code> 163 * 164 * @return The machineTypeUri. 165 */ getMachineTypeUri()166 java.lang.String getMachineTypeUri(); 167 /** 168 * 169 * 170 * <pre> 171 * Optional. The Compute Engine machine type used for cluster instances. 172 * A full URL, partial URI, or short name are valid. Examples: 173 * * `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2` 174 * * `projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2` 175 * * `n1-standard-2` 176 * **Auto Zone Exception**: If you are using the Dataproc 177 * [Auto Zone 178 * Placement](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) 179 * feature, you must use the short name of the machine type 180 * resource, for example, `n1-standard-2`. 181 * </pre> 182 * 183 * <code>string machine_type_uri = 4 [(.google.api.field_behavior) = OPTIONAL];</code> 184 * 185 * @return The bytes for machineTypeUri. 186 */ getMachineTypeUriBytes()187 com.google.protobuf.ByteString getMachineTypeUriBytes(); 188 189 /** 190 * 191 * 192 * <pre> 193 * Optional. Disk option config settings. 194 * </pre> 195 * 196 * <code> 197 * .google.cloud.dataproc.v1.DiskConfig disk_config = 5 [(.google.api.field_behavior) = OPTIONAL]; 198 * </code> 199 * 200 * @return Whether the diskConfig field is set. 201 */ hasDiskConfig()202 boolean hasDiskConfig(); 203 /** 204 * 205 * 206 * <pre> 207 * Optional. Disk option config settings. 208 * </pre> 209 * 210 * <code> 211 * .google.cloud.dataproc.v1.DiskConfig disk_config = 5 [(.google.api.field_behavior) = OPTIONAL]; 212 * </code> 213 * 214 * @return The diskConfig. 215 */ getDiskConfig()216 com.google.cloud.dataproc.v1.DiskConfig getDiskConfig(); 217 /** 218 * 219 * 220 * <pre> 221 * Optional. Disk option config settings. 222 * </pre> 223 * 224 * <code> 225 * .google.cloud.dataproc.v1.DiskConfig disk_config = 5 [(.google.api.field_behavior) = OPTIONAL]; 226 * </code> 227 */ getDiskConfigOrBuilder()228 com.google.cloud.dataproc.v1.DiskConfigOrBuilder getDiskConfigOrBuilder(); 229 230 /** 231 * 232 * 233 * <pre> 234 * Output only. Specifies that this instance group contains preemptible 235 * instances. 236 * </pre> 237 * 238 * <code>bool is_preemptible = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 239 * 240 * @return The isPreemptible. 241 */ getIsPreemptible()242 boolean getIsPreemptible(); 243 244 /** 245 * 246 * 247 * <pre> 248 * Optional. Specifies the preemptibility of the instance group. 249 * The default value for master and worker groups is 250 * `NON_PREEMPTIBLE`. This default cannot be changed. 251 * The default value for secondary instances is 252 * `PREEMPTIBLE`. 253 * </pre> 254 * 255 * <code> 256 * .google.cloud.dataproc.v1.InstanceGroupConfig.Preemptibility preemptibility = 10 [(.google.api.field_behavior) = OPTIONAL]; 257 * </code> 258 * 259 * @return The enum numeric value on the wire for preemptibility. 260 */ getPreemptibilityValue()261 int getPreemptibilityValue(); 262 /** 263 * 264 * 265 * <pre> 266 * Optional. Specifies the preemptibility of the instance group. 267 * The default value for master and worker groups is 268 * `NON_PREEMPTIBLE`. This default cannot be changed. 269 * The default value for secondary instances is 270 * `PREEMPTIBLE`. 271 * </pre> 272 * 273 * <code> 274 * .google.cloud.dataproc.v1.InstanceGroupConfig.Preemptibility preemptibility = 10 [(.google.api.field_behavior) = OPTIONAL]; 275 * </code> 276 * 277 * @return The preemptibility. 278 */ getPreemptibility()279 com.google.cloud.dataproc.v1.InstanceGroupConfig.Preemptibility getPreemptibility(); 280 281 /** 282 * 283 * 284 * <pre> 285 * Output only. The config for Compute Engine Instance Group 286 * Manager that manages this group. 287 * This is only used for preemptible instance groups. 288 * </pre> 289 * 290 * <code> 291 * .google.cloud.dataproc.v1.ManagedGroupConfig managed_group_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 292 * </code> 293 * 294 * @return Whether the managedGroupConfig field is set. 295 */ hasManagedGroupConfig()296 boolean hasManagedGroupConfig(); 297 /** 298 * 299 * 300 * <pre> 301 * Output only. The config for Compute Engine Instance Group 302 * Manager that manages this group. 303 * This is only used for preemptible instance groups. 304 * </pre> 305 * 306 * <code> 307 * .google.cloud.dataproc.v1.ManagedGroupConfig managed_group_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 308 * </code> 309 * 310 * @return The managedGroupConfig. 311 */ getManagedGroupConfig()312 com.google.cloud.dataproc.v1.ManagedGroupConfig getManagedGroupConfig(); 313 /** 314 * 315 * 316 * <pre> 317 * Output only. The config for Compute Engine Instance Group 318 * Manager that manages this group. 319 * This is only used for preemptible instance groups. 320 * </pre> 321 * 322 * <code> 323 * .google.cloud.dataproc.v1.ManagedGroupConfig managed_group_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 324 * </code> 325 */ getManagedGroupConfigOrBuilder()326 com.google.cloud.dataproc.v1.ManagedGroupConfigOrBuilder getManagedGroupConfigOrBuilder(); 327 328 /** 329 * 330 * 331 * <pre> 332 * Optional. The Compute Engine accelerator configuration for these 333 * instances. 334 * </pre> 335 * 336 * <code> 337 * repeated .google.cloud.dataproc.v1.AcceleratorConfig accelerators = 8 [(.google.api.field_behavior) = OPTIONAL]; 338 * </code> 339 */ getAcceleratorsList()340 java.util.List<com.google.cloud.dataproc.v1.AcceleratorConfig> getAcceleratorsList(); 341 /** 342 * 343 * 344 * <pre> 345 * Optional. The Compute Engine accelerator configuration for these 346 * instances. 347 * </pre> 348 * 349 * <code> 350 * repeated .google.cloud.dataproc.v1.AcceleratorConfig accelerators = 8 [(.google.api.field_behavior) = OPTIONAL]; 351 * </code> 352 */ getAccelerators(int index)353 com.google.cloud.dataproc.v1.AcceleratorConfig getAccelerators(int index); 354 /** 355 * 356 * 357 * <pre> 358 * Optional. The Compute Engine accelerator configuration for these 359 * instances. 360 * </pre> 361 * 362 * <code> 363 * repeated .google.cloud.dataproc.v1.AcceleratorConfig accelerators = 8 [(.google.api.field_behavior) = OPTIONAL]; 364 * </code> 365 */ getAcceleratorsCount()366 int getAcceleratorsCount(); 367 /** 368 * 369 * 370 * <pre> 371 * Optional. The Compute Engine accelerator configuration for these 372 * instances. 373 * </pre> 374 * 375 * <code> 376 * repeated .google.cloud.dataproc.v1.AcceleratorConfig accelerators = 8 [(.google.api.field_behavior) = OPTIONAL]; 377 * </code> 378 */ 379 java.util.List<? extends com.google.cloud.dataproc.v1.AcceleratorConfigOrBuilder> getAcceleratorsOrBuilderList()380 getAcceleratorsOrBuilderList(); 381 /** 382 * 383 * 384 * <pre> 385 * Optional. The Compute Engine accelerator configuration for these 386 * instances. 387 * </pre> 388 * 389 * <code> 390 * repeated .google.cloud.dataproc.v1.AcceleratorConfig accelerators = 8 [(.google.api.field_behavior) = OPTIONAL]; 391 * </code> 392 */ getAcceleratorsOrBuilder(int index)393 com.google.cloud.dataproc.v1.AcceleratorConfigOrBuilder getAcceleratorsOrBuilder(int index); 394 395 /** 396 * 397 * 398 * <pre> 399 * Optional. Specifies the minimum cpu platform for the Instance Group. 400 * See [Dataproc -> Minimum CPU 401 * Platform](https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu). 402 * </pre> 403 * 404 * <code>string min_cpu_platform = 9 [(.google.api.field_behavior) = OPTIONAL];</code> 405 * 406 * @return The minCpuPlatform. 407 */ getMinCpuPlatform()408 java.lang.String getMinCpuPlatform(); 409 /** 410 * 411 * 412 * <pre> 413 * Optional. Specifies the minimum cpu platform for the Instance Group. 414 * See [Dataproc -> Minimum CPU 415 * Platform](https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu). 416 * </pre> 417 * 418 * <code>string min_cpu_platform = 9 [(.google.api.field_behavior) = OPTIONAL];</code> 419 * 420 * @return The bytes for minCpuPlatform. 421 */ getMinCpuPlatformBytes()422 com.google.protobuf.ByteString getMinCpuPlatformBytes(); 423 } 424