Class protos.google.dataflow.v1beta3.TaskRunnerSettings (2.0.1)

Represents a TaskRunnerSettings.

Package

@google-cloud/dataflow

Constructors

(constructor)(properties)

constructor(properties?: google.dataflow.v1beta3.ITaskRunnerSettings);

Constructs a new TaskRunnerSettings.

Parameter
Name Description
properties ITaskRunnerSettings

Properties to set

Properties

alsologtostderr

public alsologtostderr: boolean;

TaskRunnerSettings alsologtostderr.

baseTaskDir

public baseTaskDir: string;

TaskRunnerSettings baseTaskDir.

baseUrl

public baseUrl: string;

TaskRunnerSettings baseUrl.

commandlinesFileName

public commandlinesFileName: string;

TaskRunnerSettings commandlinesFileName.

continueOnException

public continueOnException: boolean;

TaskRunnerSettings continueOnException.

dataflowApiVersion

public dataflowApiVersion: string;

TaskRunnerSettings dataflowApiVersion.

harnessCommand

public harnessCommand: string;

TaskRunnerSettings harnessCommand.

languageHint

public languageHint: string;

TaskRunnerSettings languageHint.

logDir

public logDir: string;

TaskRunnerSettings logDir.

logToSerialconsole

public logToSerialconsole: boolean;

TaskRunnerSettings logToSerialconsole.

logUploadLocation

public logUploadLocation: string;

TaskRunnerSettings logUploadLocation.

oauthScopes

public oauthScopes: string[];

TaskRunnerSettings oauthScopes.

parallelWorkerSettings

public parallelWorkerSettings?: (google.dataflow.v1beta3.IWorkerSettings|null);

TaskRunnerSettings parallelWorkerSettings.

streamingWorkerMainClass

public streamingWorkerMainClass: string;

TaskRunnerSettings streamingWorkerMainClass.

taskGroup

public taskGroup: string;

TaskRunnerSettings taskGroup.

taskUser

public taskUser: string;

TaskRunnerSettings taskUser.

tempStoragePrefix

public tempStoragePrefix: string;

TaskRunnerSettings tempStoragePrefix.

vmId

public vmId: string;

TaskRunnerSettings vmId.

workflowFileName

public workflowFileName: string;

TaskRunnerSettings workflowFileName.

Methods

create(properties)

public static create(properties?: google.dataflow.v1beta3.ITaskRunnerSettings): google.dataflow.v1beta3.TaskRunnerSettings;

Creates a new TaskRunnerSettings instance using the specified properties.

Parameter
Name Description
properties ITaskRunnerSettings

Properties to set
Returns
Type Description
google.dataflow.v1beta3.TaskRunnerSettings

TaskRunnerSettings instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.dataflow.v1beta3.TaskRunnerSettings;

Decodes a TaskRunnerSettings message from the specified reader or buffer.

Parameters
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
google.dataflow.v1beta3.TaskRunnerSettings

TaskRunnerSettings

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.dataflow.v1beta3.TaskRunnerSettings;

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

Parameter
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
google.dataflow.v1beta3.TaskRunnerSettings

TaskRunnerSettings

encode(message, writer)

public static encode(message: google.dataflow.v1beta3.ITaskRunnerSettings, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified TaskRunnerSettings message. Does not implicitly messages.

Parameters
Name Description
message ITaskRunnerSettings

TaskRunnerSettings 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.dataflow.v1beta3.ITaskRunnerSettings, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ITaskRunnerSettings

TaskRunnerSettings 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.dataflow.v1beta3.TaskRunnerSettings;

Creates a TaskRunnerSettings 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
google.dataflow.v1beta3.TaskRunnerSettings

TaskRunnerSettings

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for TaskRunnerSettings

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

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

JSON object

toObject(message, options)

public static toObject(message: google.dataflow.v1beta3.TaskRunnerSettings, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message google.dataflow.v1beta3.TaskRunnerSettings

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