Class protos.google.cloud.dataproc.v1.SparkJob (4.1.1)

Represents a SparkJob.

Package

@google-cloud/dataproc

Constructors

(constructor)(properties)

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

Constructs a new SparkJob.

Parameter
NameDescription
properties ISparkJob

Properties to set

Properties

archiveUris

public archiveUris: string[];

SparkJob archiveUris.

args

public args: string[];

SparkJob args.

driver

public driver?: ("mainJarFileUri"|"mainClass");

SparkJob driver.

fileUris

public fileUris: string[];

SparkJob fileUris.

jarFileUris

public jarFileUris: string[];

SparkJob jarFileUris.

loggingConfig

public loggingConfig?: (google.cloud.dataproc.v1.ILoggingConfig|null);

SparkJob loggingConfig.

mainClass

public mainClass?: (string|null);

SparkJob mainClass.

mainJarFileUri

public mainJarFileUri?: (string|null);

SparkJob mainJarFileUri.

properties

public properties: { [k: string]: string };

SparkJob properties.

Methods

create(properties)

public static create(properties?: google.cloud.dataproc.v1.ISparkJob): google.cloud.dataproc.v1.SparkJob;

Creates a new SparkJob instance using the specified properties.

Parameter
NameDescription
properties ISparkJob

Properties to set

Returns
TypeDescription
google.cloud.dataproc.v1.SparkJob

SparkJob instance

decode(reader, length)

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

Decodes a SparkJob 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.SparkJob

SparkJob

decodeDelimited(reader)

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

Decodes a SparkJob 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.SparkJob

SparkJob

encode(message, writer)

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

Encodes the specified SparkJob message. Does not implicitly messages.

Parameters
NameDescription
message ISparkJob

SparkJob 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.ISparkJob, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ISparkJob

SparkJob 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.SparkJob;

Creates a SparkJob 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.SparkJob

SparkJob

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SparkJob

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 SparkJob to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

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

SparkJob

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 SparkJob 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