Console
    Contact Us Start free

    Google Cloud Dataproc V1 Client - Class InstanceGroupConfig (3.2.2)

    Reference documentation and code samples for the Google Cloud Dataproc V1 Client class InstanceGroupConfig.

    The config settings for Compute Engine resources in an instance group, such as a master or worker group.

    Generated from protobuf message google.cloud.dataproc.v1.InstanceGroupConfig

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ num_instances
    int

    Optional. The number of VM instances in the instance group. For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1.

    ↳ instance_names
    array

    Output only. The list of instance names. Dataproc derives the names from cluster_name , num_instances , and the instance group.

    ↳ image_uri
    string

    Optional. The Compute Engine image resource used for cluster instances. The URI can represent an image or image family. Image examples: * https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id] * projects/[project_id]/global/images/[image-id] * image-id Image family examples. Dataproc will use the most recent image from the family: * https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name] * projects/[project_id]/global/images/family/[custom-image-family-name] If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

    ↳ machine_type_uri
    string

    Optional. The Compute Engine machine type used for cluster instances. A full URL, partial URI, or short name are valid. Examples: * https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 * projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 * n1-standard-2 Auto Zone Exception: If you are using the Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2 .

    ↳ disk_config
    Google\Cloud\Dataproc\V1\DiskConfig

    Optional. Disk option config settings.

    ↳ is_preemptible
    bool

    Output only. Specifies that this instance group contains preemptible instances.

    ↳ preemptibility
    int

    Optional. Specifies the preemptibility of the instance group. The default value for master and worker groups is NON_PREEMPTIBLE . This default cannot be changed. The default value for secondary instances is PREEMPTIBLE .

    ↳ managed_group_config
    Google\Cloud\Dataproc\V1\ManagedGroupConfig

    Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

    ↳ accelerators
    array< Google\Cloud\Dataproc\V1\AcceleratorConfig >

    Optional. The Compute Engine accelerator configuration for these instances.

    ↳ min_cpu_platform
    string

    Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform .

    getNumInstances

    Optional. The number of VM instances in the instance group.

    For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1.

    Generated from protobuf field int32 num_instances = 1 [(.google.api.field_behavior) = OPTIONAL];

    Returns
    Type
    Description
    int

    setNumInstances

    Optional. The number of VM instances in the instance group.

    For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1.

    Generated from protobuf field int32 num_instances = 1 [(.google.api.field_behavior) = OPTIONAL];

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getInstanceNames

    Output only. The list of instance names. Dataproc derives the names from cluster_name , num_instances , and the instance group.

    Generated from protobuf field repeated string instance_names = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setInstanceNames

    Output only. The list of instance names. Dataproc derives the names from cluster_name , num_instances , and the instance group.

    Generated from protobuf field repeated string instance_names = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    getImageUri

    Optional. The Compute Engine image resource used for cluster instances.

    The URI can represent an image or image family. Image examples:

    • https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
    • projects/[project_id]/global/images/[image-id]
    • image-id Image family examples. Dataproc will use the most recent image from the family:
    • https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
    • projects/[project_id]/global/images/family/[custom-image-family-name] If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

    Generated from protobuf field string image_uri = 3 [(.google.api.field_behavior) = OPTIONAL];

    Returns
    Type
    Description
    string

    setImageUri

    Optional. The Compute Engine image resource used for cluster instances.

    The URI can represent an image or image family. Image examples:

    • https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
    • projects/[project_id]/global/images/[image-id]
    • image-id Image family examples. Dataproc will use the most recent image from the family:
    • https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
    • projects/[project_id]/global/images/family/[custom-image-family-name] If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

    Generated from protobuf field string image_uri = 3 [(.google.api.field_behavior) = OPTIONAL];

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getMachineTypeUri

    Optional. The Compute Engine machine type used for cluster instances.

    A full URL, partial URI, or short name are valid. Examples:

    • https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
    • projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
    • n1-standard-2 Auto Zone Exception: If you are using the Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2 .

    Generated from protobuf field string machine_type_uri = 4 [(.google.api.field_behavior) = OPTIONAL];

    Returns
    Type
    Description
    string

    setMachineTypeUri

    Optional. The Compute Engine machine type used for cluster instances.

    A full URL, partial URI, or short name are valid. Examples:

    • https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
    • projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
    • n1-standard-2 Auto Zone Exception: If you are using the Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2 .

    Generated from protobuf field string machine_type_uri = 4 [(.google.api.field_behavior) = OPTIONAL];

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDiskConfig

    Optional. Disk option config settings.

    Generated from protobuf field .google.cloud.dataproc.v1.DiskConfig disk_config = 5 [(.google.api.field_behavior) = OPTIONAL];

    Returns
    Type
    Description
    Google\Cloud\Dataproc\V1\DiskConfig |null

    hasDiskConfig

    clearDiskConfig

    setDiskConfig

    Optional. Disk option config settings.

    Generated from protobuf field .google.cloud.dataproc.v1.DiskConfig disk_config = 5 [(.google.api.field_behavior) = OPTIONAL];

    Parameter
    Name
    Description
    var
    Google\Cloud\Dataproc\V1\DiskConfig
    Returns
    Type
    Description
    $this

    getIsPreemptible

    Output only. Specifies that this instance group contains preemptible instances.

    Generated from protobuf field bool is_preemptible = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    bool

    setIsPreemptible

    Output only. Specifies that this instance group contains preemptible instances.

    Generated from protobuf field bool is_preemptible = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getPreemptibility

    Optional. Specifies the preemptibility of the instance group.

    The default value for master and worker groups is NON_PREEMPTIBLE . This default cannot be changed. The default value for secondary instances is PREEMPTIBLE .

    Generated from protobuf field .google.cloud.dataproc.v1.InstanceGroupConfig.Preemptibility preemptibility = 10 [(.google.api.field_behavior) = OPTIONAL];

    Returns
    Type
    Description
    int

    setPreemptibility

    Optional. Specifies the preemptibility of the instance group.

    The default value for master and worker groups is NON_PREEMPTIBLE . This default cannot be changed. The default value for secondary instances is PREEMPTIBLE .

    Generated from protobuf field .google.cloud.dataproc.v1.InstanceGroupConfig.Preemptibility preemptibility = 10 [(.google.api.field_behavior) = OPTIONAL];

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getManagedGroupConfig

    Output only. The config for Compute Engine Instance Group Manager that manages this group.

    This is only used for preemptible instance groups.

    Generated from protobuf field .google.cloud.dataproc.v1.ManagedGroupConfig managed_group_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    Google\Cloud\Dataproc\V1\ManagedGroupConfig |null

    hasManagedGroupConfig

    clearManagedGroupConfig

    setManagedGroupConfig

    Output only. The config for Compute Engine Instance Group Manager that manages this group.

    This is only used for preemptible instance groups.

    Generated from protobuf field .google.cloud.dataproc.v1.ManagedGroupConfig managed_group_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    Google\Cloud\Dataproc\V1\ManagedGroupConfig
    Returns
    Type
    Description
    $this

    getAccelerators

    Optional. The Compute Engine accelerator configuration for these instances.

    Generated from protobuf field repeated .google.cloud.dataproc.v1.AcceleratorConfig accelerators = 8 [(.google.api.field_behavior) = OPTIONAL];

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setAccelerators

    Optional. The Compute Engine accelerator configuration for these instances.

    Generated from protobuf field repeated .google.cloud.dataproc.v1.AcceleratorConfig accelerators = 8 [(.google.api.field_behavior) = OPTIONAL];

    Parameter
    Name
    Description
    var
    array< Google\Cloud\Dataproc\V1\AcceleratorConfig >
    Returns
    Type
    Description
    $this

    getMinCpuPlatform

    Optional. Specifies the minimum cpu platform for the Instance Group.

    See Dataproc -> Minimum CPU Platform .

    Generated from protobuf field string min_cpu_platform = 9 [(.google.api.field_behavior) = OPTIONAL];

    Returns
    Type
    Description
    string

    setMinCpuPlatform

    Optional. Specifies the minimum cpu platform for the Instance Group.

    See Dataproc -> Minimum CPU Platform .

    Generated from protobuf field string min_cpu_platform = 9 [(.google.api.field_behavior) = OPTIONAL];

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: