Class SoftwareConfig (4.13.0)

public final class SoftwareConfig extends GeneratedMessageV3 implements SoftwareConfigOrBuilder

Specifies the selection and config of software inside the cluster.

Protobuf type google.cloud.dataproc.v1.SoftwareConfig

Static Fields

IMAGE_VERSION_FIELD_NUMBER

public static final int IMAGE_VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

OPTIONAL_COMPONENTS_FIELD_NUMBER

public static final int OPTIONAL_COMPONENTS_FIELD_NUMBER
Field Value
TypeDescription
int

PROPERTIES_FIELD_NUMBER

public static final int PROPERTIES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SoftwareConfig getDefaultInstance()
Returns
TypeDescription
SoftwareConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SoftwareConfig.Builder newBuilder()
Returns
TypeDescription
SoftwareConfig.Builder

newBuilder(SoftwareConfig prototype)

public static SoftwareConfig.Builder newBuilder(SoftwareConfig prototype)
Parameter
NameDescription
prototypeSoftwareConfig
Returns
TypeDescription
SoftwareConfig.Builder

parseDelimitedFrom(InputStream input)

public static SoftwareConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SoftwareConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SoftwareConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SoftwareConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SoftwareConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SoftwareConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SoftwareConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SoftwareConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SoftwareConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SoftwareConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SoftwareConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SoftwareConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SoftwareConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SoftwareConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SoftwareConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SoftwareConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SoftwareConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SoftwareConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SoftwareConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SoftwareConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SoftwareConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SoftwareConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SoftwareConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SoftwareConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SoftwareConfig> parser()
Returns
TypeDescription
Parser<SoftwareConfig>

Methods

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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SoftwareConfig getDefaultInstanceForType()
Returns
TypeDescription
SoftwareConfig

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
TypeDescription
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
TypeDescription
ByteString

The bytes for imageVersion.

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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
List<Integer>

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

getParserForType()

public Parser<SoftwareConfig> getParserForType()
Returns
TypeDescription
Parser<SoftwareConfig>
Overrides

getProperties()

public Map<String,String> getProperties()

Use #getPropertiesMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SoftwareConfig.Builder newBuilderForType()
Returns
TypeDescription
SoftwareConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SoftwareConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SoftwareConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SoftwareConfig.Builder toBuilder()
Returns
TypeDescription
SoftwareConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException