Reference documentation and code samples for the Google Cloud Dataproc V1 Client class SoftwareConfig.
Specifies the selection and config of software inside the cluster.
Generated from protobuf message google.cloud.dataproc.v1.SoftwareConfig
Namespace
Google \ Cloud \ Dataproc \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ image_version
string
Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions, such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version. If unspecified, it defaults to the latest Debian version.
Optional. The properties to set on daemon config files. Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings: * capacity-scheduler: capacity-scheduler.xml * core: core-site.xml * distcp: distcp-default.xml * hdfs: hdfs-site.xml * hive: hive-site.xml * mapred: mapred-site.xml * pig: pig.properties * spark: spark-defaults.conf * yarn: yarn-site.xml For more information, see Cluster properties.
↳ optional_components
array
Optional. The set of components to activate on the cluster.
getImageVersion
Optional. The version of software inside the cluster. It must be one of the
supported Dataproc
Versions,
such as "1.2" (including a subminor version, such as "1.2.29"), or the
"preview"
version.
If unspecified, it defaults to the latest Debian version.
Returns
Type
Description
string
setImageVersion
Optional. The version of software inside the cluster. It must be one of the
supported Dataproc
Versions,
such as "1.2" (including a subminor version, such as "1.2.29"), or the
"preview"
version.
If unspecified, it defaults to the latest Debian version.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getProperties
Optional. The properties to set on daemon config files.
Property keys are specified in prefix:property format, for example
core:hadoop.tmp.dir. The following are supported prefixes
and their mappings:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dataproc V1 Client - Class SoftwareConfig (3.14.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.14.0 (latest)](/php/docs/reference/cloud-dataproc/latest/V1.SoftwareConfig)\n- [3.13.4](/php/docs/reference/cloud-dataproc/3.13.4/V1.SoftwareConfig)\n- [3.12.0](/php/docs/reference/cloud-dataproc/3.12.0/V1.SoftwareConfig)\n- [3.11.0](/php/docs/reference/cloud-dataproc/3.11.0/V1.SoftwareConfig)\n- [3.10.1](/php/docs/reference/cloud-dataproc/3.10.1/V1.SoftwareConfig)\n- [3.9.0](/php/docs/reference/cloud-dataproc/3.9.0/V1.SoftwareConfig)\n- [3.8.1](/php/docs/reference/cloud-dataproc/3.8.1/V1.SoftwareConfig)\n- [3.7.1](/php/docs/reference/cloud-dataproc/3.7.1/V1.SoftwareConfig)\n- [3.6.1](/php/docs/reference/cloud-dataproc/3.6.1/V1.SoftwareConfig)\n- [3.5.1](/php/docs/reference/cloud-dataproc/3.5.1/V1.SoftwareConfig)\n- [3.4.0](/php/docs/reference/cloud-dataproc/3.4.0/V1.SoftwareConfig)\n- [3.3.0](/php/docs/reference/cloud-dataproc/3.3.0/V1.SoftwareConfig)\n- [3.2.2](/php/docs/reference/cloud-dataproc/3.2.2/V1.SoftwareConfig)\n- [2.6.1](/php/docs/reference/cloud-dataproc/2.6.1/V1.SoftwareConfig)\n- [2.5.0](/php/docs/reference/cloud-dataproc/2.5.0/V1.SoftwareConfig)\n- [2.3.0](/php/docs/reference/cloud-dataproc/2.3.0/V1.SoftwareConfig)\n- [2.2.3](/php/docs/reference/cloud-dataproc/2.2.3/V1.SoftwareConfig)\n- [2.1.0](/php/docs/reference/cloud-dataproc/2.1.0/V1.SoftwareConfig)\n- [2.0.0](/php/docs/reference/cloud-dataproc/2.0.0/V1.SoftwareConfig) \nReference documentation and code samples for the Google Cloud Dataproc V1 Client class SoftwareConfig.\n\nSpecifies the selection and config of software inside the cluster.\n\nGenerated from protobuf message `google.cloud.dataproc.v1.SoftwareConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataproc \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getImageVersion\n\nOptional. The version of software inside the cluster. It must be one of the\nsupported [Dataproc\nVersions](https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_dataproc_versions),\nsuch as \"1.2\" (including a subminor version, such as \"1.2.29\"), or the\n[\"preview\"\nversion](https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions).\n\nIf unspecified, it defaults to the latest Debian version.\n\n### setImageVersion\n\nOptional. The version of software inside the cluster. It must be one of the\nsupported [Dataproc\nVersions](https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_dataproc_versions),\nsuch as \"1.2\" (including a subminor version, such as \"1.2.29\"), or the\n[\"preview\"\nversion](https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions).\n\nIf unspecified, it defaults to the latest Debian version.\n\n### getProperties\n\nOptional. The properties to set on daemon config files.\n\nProperty keys are specified in `prefix:property` format, for example\n`core:hadoop.tmp.dir`. The following are supported prefixes\nand their mappings:\n\n- capacity-scheduler: `capacity-scheduler.xml`\n- core: `core-site.xml`\n- distcp: `distcp-default.xml`\n- hdfs: `hdfs-site.xml`\n- hive: `hive-site.xml`\n- mapred: `mapred-site.xml`\n- pig: `pig.properties`\n- spark: `spark-defaults.conf`\n- yarn: `yarn-site.xml` For more information, see [Cluster\n properties](https://cloud.google.com/dataproc/docs/concepts/cluster-properties).\n\n### setProperties\n\nOptional. The properties to set on daemon config files.\n\nProperty keys are specified in `prefix:property` format, for example\n`core:hadoop.tmp.dir`. The following are supported prefixes\nand their mappings:\n\n- capacity-scheduler: `capacity-scheduler.xml`\n- core: `core-site.xml`\n- distcp: `distcp-default.xml`\n- hdfs: `hdfs-site.xml`\n- hive: `hive-site.xml`\n- mapred: `mapred-site.xml`\n- pig: `pig.properties`\n- spark: `spark-defaults.conf`\n- yarn: `yarn-site.xml` For more information, see [Cluster\n properties](https://cloud.google.com/dataproc/docs/concepts/cluster-properties).\n\n### getOptionalComponents\n\nOptional. The set of components to activate on the cluster.\n\n### setOptionalComponents\n\nOptional. The set of components to activate on the cluster."]]
