Class SoftwareConfig.Builder (4.43.0)

public static final class SoftwareConfig.Builder extends GeneratedMessageV3.Builder<SoftwareConfig.Builder> implements SoftwareConfigOrBuilder

Specifies the selection and config of software inside the cluster.

Protobuf type google.cloud.dataproc.v1.SoftwareConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllOptionalComponents(Iterable<? extends Component> values)

public SoftwareConfig.Builder addAllOptionalComponents(Iterable<? extends Component> values)

Optional. The set of components to activate on the cluster.

repeated .google.cloud.dataproc.v1.Component optional_components = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.dataproc.v1.Component>

The optionalComponents to add.

Returns
Type Description
SoftwareConfig.Builder

This builder for chaining.

addAllOptionalComponentsValue(Iterable<Integer> values)

public SoftwareConfig.Builder addAllOptionalComponentsValue(Iterable<Integer> values)

Optional. The set of components to activate on the cluster.

repeated .google.cloud.dataproc.v1.Component optional_components = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for optionalComponents to add.

Returns
Type Description
SoftwareConfig.Builder

This builder for chaining.

addOptionalComponents(Component value)

public SoftwareConfig.Builder addOptionalComponents(Component value)

Optional. The set of components to activate on the cluster.

repeated .google.cloud.dataproc.v1.Component optional_components = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Component

The optionalComponents to add.

Returns
Type Description
SoftwareConfig.Builder

This builder for chaining.

addOptionalComponentsValue(int value)

public SoftwareConfig.Builder addOptionalComponentsValue(int value)

Optional. The set of components to activate on the cluster.

repeated .google.cloud.dataproc.v1.Component optional_components = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for optionalComponents to add.

Returns
Type Description
SoftwareConfig.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SoftwareConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SoftwareConfig.Builder
Overrides

build()

public SoftwareConfig build()
Returns
Type Description
SoftwareConfig

buildPartial()

public SoftwareConfig buildPartial()
Returns
Type Description
SoftwareConfig

clear()

public SoftwareConfig.Builder clear()
Returns
Type Description
SoftwareConfig.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SoftwareConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SoftwareConfig.Builder
Overrides

clearImageVersion()

public SoftwareConfig.Builder clearImageVersion()

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.

string image_version = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SoftwareConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SoftwareConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SoftwareConfig.Builder
Overrides

clearOptionalComponents()

public SoftwareConfig.Builder clearOptionalComponents()

Optional. The set of components to activate on the cluster.

repeated .google.cloud.dataproc.v1.Component optional_components = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SoftwareConfig.Builder

This builder for chaining.

clearProperties()

public SoftwareConfig.Builder clearProperties()
Returns
Type Description
SoftwareConfig.Builder

clone()

public SoftwareConfig.Builder clone()
Returns
Type Description
SoftwareConfig.Builder
Overrides

containsProperties(String key)

public boolean containsProperties(String key)

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.

map<string, string> properties = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getDefaultInstanceForType()

public SoftwareConfig getDefaultInstanceForType()
Returns
Type Description
SoftwareConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getImageVersion()

public String 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.

string image_version = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The imageVersion.

getImageVersionBytes()

public ByteString getImageVersionBytes()

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.

string image_version = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for imageVersion.

getMutableProperties() (deprecated)

public Map<String,String> getMutableProperties()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getOptionalComponents(int index)

public Component getOptionalComponents(int index)

Optional. The set of components to activate on the cluster.

repeated .google.cloud.dataproc.v1.Component optional_components = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
Component

The optionalComponents at the given index.

getOptionalComponentsCount()

public int getOptionalComponentsCount()

Optional. The set of components to activate on the cluster.

repeated .google.cloud.dataproc.v1.Component optional_components = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of optionalComponents.

getOptionalComponentsList()

public List<Component> getOptionalComponentsList()

Optional. The set of components to activate on the cluster.

repeated .google.cloud.dataproc.v1.Component optional_components = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Component>

A list containing the optionalComponents.

getOptionalComponentsValue(int index)

public int getOptionalComponentsValue(int index)

Optional. The set of components to activate on the cluster.

repeated .google.cloud.dataproc.v1.Component optional_components = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of optionalComponents at the given index.

getOptionalComponentsValueList()

public List<Integer> getOptionalComponentsValueList()

Optional. The set of components to activate on the cluster.

repeated .google.cloud.dataproc.v1.Component optional_components = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for optionalComponents.

getProperties() (deprecated)

public Map<String,String> getProperties()

Use #getPropertiesMap() instead.

Returns
Type Description
Map<String,String>

getPropertiesCount()

public int getPropertiesCount()

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.

map<string, string> properties = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getPropertiesMap()

public Map<String,String> getPropertiesMap()

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.

map<string, string> properties = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getPropertiesOrDefault(String key, String defaultValue)

public String getPropertiesOrDefault(String key, String defaultValue)

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.

map<string, string> properties = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getPropertiesOrThrow(String key)

public String getPropertiesOrThrow(String key)

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.

map<string, string> properties = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SoftwareConfig other)

public SoftwareConfig.Builder mergeFrom(SoftwareConfig other)
Parameter
Name Description
other SoftwareConfig
Returns
Type Description
SoftwareConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SoftwareConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SoftwareConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SoftwareConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SoftwareConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SoftwareConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SoftwareConfig.Builder
Overrides

putAllProperties(Map<String,String> values)

public SoftwareConfig.Builder putAllProperties(Map<String,String> values)

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.

map<string, string> properties = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
SoftwareConfig.Builder

putProperties(String key, String value)

public SoftwareConfig.Builder putProperties(String key, String value)

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.

map<string, string> properties = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value String
Returns
Type Description
SoftwareConfig.Builder

removeProperties(String key)

public SoftwareConfig.Builder removeProperties(String key)

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.

map<string, string> properties = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
SoftwareConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public SoftwareConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SoftwareConfig.Builder
Overrides

setImageVersion(String value)

public SoftwareConfig.Builder setImageVersion(String value)

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.

string image_version = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The imageVersion to set.

Returns
Type Description
SoftwareConfig.Builder

This builder for chaining.

setImageVersionBytes(ByteString value)

public SoftwareConfig.Builder setImageVersionBytes(ByteString value)

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.

string image_version = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for imageVersion to set.

Returns
Type Description
SoftwareConfig.Builder

This builder for chaining.

setOptionalComponents(int index, Component value)

public SoftwareConfig.Builder setOptionalComponents(int index, Component value)

Optional. The set of components to activate on the cluster.

repeated .google.cloud.dataproc.v1.Component optional_components = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value Component

The optionalComponents to set.

Returns
Type Description
SoftwareConfig.Builder

This builder for chaining.

setOptionalComponentsValue(int index, int value)

public SoftwareConfig.Builder setOptionalComponentsValue(int index, int value)

Optional. The set of components to activate on the cluster.

repeated .google.cloud.dataproc.v1.Component optional_components = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value int

The enum numeric value on the wire for optionalComponents to set.

Returns
Type Description
SoftwareConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SoftwareConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SoftwareConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SoftwareConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SoftwareConfig.Builder
Overrides