Class protos.google.cloud.dataproc.v1.PigJob (5.5.0)

Represents a PigJob.

Package

@google-cloud/dataproc

Constructors

(constructor)(properties)

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

Constructs a new PigJob.

Parameter
NameDescription
properties IPigJob

Properties to set

Properties

continueOnFailure

public continueOnFailure: boolean;

PigJob continueOnFailure.

jarFileUris

public jarFileUris: string[];

PigJob jarFileUris.

loggingConfig

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

PigJob loggingConfig.

properties

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

PigJob properties.

queries

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

PigJob queries.

queryFileUri

public queryFileUri?: (string|null);

PigJob queryFileUri.

queryList

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

PigJob queryList.

scriptVariables

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

PigJob scriptVariables.

Methods

create(properties)

public static create(properties?: google.cloud.dataproc.v1.IPigJob): google.cloud.dataproc.v1.PigJob;

Creates a new PigJob instance using the specified properties.

Parameter
NameDescription
properties IPigJob

Properties to set

Returns
TypeDescription
PigJob

PigJob instance

decode(reader, length)

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

Decodes a PigJob message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
PigJob

PigJob

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
PigJob

PigJob

encode(message, writer)

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

Encodes the specified PigJob message. Does not implicitly messages.

Parameters
NameDescription
message IPigJob

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

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

Parameters
NameDescription
message IPigJob

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

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

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

Plain object

Returns
TypeDescription
PigJob

PigJob

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for PigJob

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message PigJob

PigJob

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