Class protos.google.cloud.dataproc.v1.ClusterConfig (4.5.0)

Represents a ClusterConfig.

Package

@google-cloud/dataproc

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dataproc.v1.IClusterConfig);

Constructs a new ClusterConfig.

Parameter
NameDescription
properties IClusterConfig

Properties to set

Properties

autoscalingConfig

public autoscalingConfig?: (google.cloud.dataproc.v1.IAutoscalingConfig|null);

ClusterConfig autoscalingConfig.

auxiliaryNodeGroups

public auxiliaryNodeGroups: google.cloud.dataproc.v1.IAuxiliaryNodeGroup[];

ClusterConfig auxiliaryNodeGroups.

configBucket

public configBucket: string;

ClusterConfig configBucket.

dataprocMetricConfig

public dataprocMetricConfig?: (google.cloud.dataproc.v1.IDataprocMetricConfig|null);

ClusterConfig dataprocMetricConfig.

encryptionConfig

public encryptionConfig?: (google.cloud.dataproc.v1.IEncryptionConfig|null);

ClusterConfig encryptionConfig.

endpointConfig

public endpointConfig?: (google.cloud.dataproc.v1.IEndpointConfig|null);

ClusterConfig endpointConfig.

gceClusterConfig

public gceClusterConfig?: (google.cloud.dataproc.v1.IGceClusterConfig|null);

ClusterConfig gceClusterConfig.

initializationActions

public initializationActions: google.cloud.dataproc.v1.INodeInitializationAction[];

ClusterConfig initializationActions.

lifecycleConfig

public lifecycleConfig?: (google.cloud.dataproc.v1.ILifecycleConfig|null);

ClusterConfig lifecycleConfig.

masterConfig

public masterConfig?: (google.cloud.dataproc.v1.IInstanceGroupConfig|null);

ClusterConfig masterConfig.

metastoreConfig

public metastoreConfig?: (google.cloud.dataproc.v1.IMetastoreConfig|null);

ClusterConfig metastoreConfig.

secondaryWorkerConfig

public secondaryWorkerConfig?: (google.cloud.dataproc.v1.IInstanceGroupConfig|null);

ClusterConfig secondaryWorkerConfig.

securityConfig

public securityConfig?: (google.cloud.dataproc.v1.ISecurityConfig|null);

ClusterConfig securityConfig.

softwareConfig

public softwareConfig?: (google.cloud.dataproc.v1.ISoftwareConfig|null);

ClusterConfig softwareConfig.

tempBucket

public tempBucket: string;

ClusterConfig tempBucket.

workerConfig

public workerConfig?: (google.cloud.dataproc.v1.IInstanceGroupConfig|null);

ClusterConfig workerConfig.

Methods

create(properties)

public static create(properties?: google.cloud.dataproc.v1.IClusterConfig): google.cloud.dataproc.v1.ClusterConfig;

Creates a new ClusterConfig instance using the specified properties.

Parameter
NameDescription
properties IClusterConfig

Properties to set

Returns
TypeDescription
google.cloud.dataproc.v1.ClusterConfig

ClusterConfig instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dataproc.v1.ClusterConfig;

Decodes a ClusterConfig message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.dataproc.v1.ClusterConfig

ClusterConfig

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dataproc.v1.ClusterConfig;

Decodes a ClusterConfig message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.dataproc.v1.ClusterConfig

ClusterConfig

encode(message, writer)

public static encode(message: google.cloud.dataproc.v1.IClusterConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ClusterConfig message. Does not implicitly messages.

Parameters
NameDescription
message IClusterConfig

ClusterConfig message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.dataproc.v1.IClusterConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ClusterConfig message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IClusterConfig

ClusterConfig message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.dataproc.v1.ClusterConfig;

Creates a ClusterConfig message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.dataproc.v1.ClusterConfig

ClusterConfig

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for ClusterConfig

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this ClusterConfig to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.dataproc.v1.ClusterConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a ClusterConfig message. Also converts values to other types if specified.

Parameters
NameDescription
message google.cloud.dataproc.v1.ClusterConfig

ClusterConfig

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a ClusterConfig message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not