Class protos.google.cloud.dataproc.v1.HiveJob (5.12.0)

Represents a HiveJob.

Package

@google-cloud/dataproc

Constructors

(constructor)(properties)

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

Constructs a new HiveJob.

Parameter
Name Description
properties IHiveJob

Properties to set

Properties

continueOnFailure

public continueOnFailure: boolean;

HiveJob continueOnFailure.

jarFileUris

public jarFileUris: string[];

HiveJob jarFileUris.

properties

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

HiveJob properties.

queries

public queries?: ("queryFileUri"|"queryList");

HiveJob queries.

queryFileUri

public queryFileUri?: (string|null);

HiveJob queryFileUri.

queryList

public queryList?: (google.cloud.dataproc.v1.IQueryList|null);

HiveJob queryList.

scriptVariables

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

HiveJob scriptVariables.

Methods

create(properties)

public static create(properties?: google.cloud.dataproc.v1.IHiveJob): google.cloud.dataproc.v1.HiveJob;

Creates a new HiveJob instance using the specified properties.

Parameter
Name Description
properties IHiveJob

Properties to set

Returns
Type Description
HiveJob

HiveJob instance

decode(reader, length)

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

Decodes a HiveJob message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
HiveJob

HiveJob

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
HiveJob

HiveJob

encode(message, writer)

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

Encodes the specified HiveJob message. Does not implicitly messages.

Parameters
Name Description
message IHiveJob

HiveJob message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
Name Description
message IHiveJob

HiveJob message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
HiveJob

HiveJob

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for HiveJob

Parameter
Name Description
typeUrlPrefix string

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

Returns
Type Description
string

The default type url

toJSON()

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

Converts this HiveJob to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message HiveJob

HiveJob

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a HiveJob message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not