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

Represents a LaunchTemplateParameters.

Package

@google-cloud/dataflow

Constructors

(constructor)(properties)

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

Constructs a new LaunchTemplateParameters.

Parameter
Name Description
properties ILaunchTemplateParameters

Properties to set

Properties

environment

public environment?: (google.dataflow.v1beta3.IRuntimeEnvironment|null);

LaunchTemplateParameters environment.

jobName

public jobName: string;

LaunchTemplateParameters jobName.

parameters

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

LaunchTemplateParameters parameters.

transformNameMapping

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

LaunchTemplateParameters transformNameMapping.

update

public update: boolean;

LaunchTemplateParameters update.

Methods

create(properties)

public static create(properties?: google.dataflow.v1beta3.ILaunchTemplateParameters): google.dataflow.v1beta3.LaunchTemplateParameters;

Creates a new LaunchTemplateParameters instance using the specified properties.

Parameter
Name Description
properties ILaunchTemplateParameters

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

LaunchTemplateParameters instance

decode(reader, length)

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

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

LaunchTemplateParameters

decodeDelimited(reader)

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

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

LaunchTemplateParameters

encode(message, writer)

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

Encodes the specified LaunchTemplateParameters message. Does not implicitly messages.

Parameters
Name Description
message ILaunchTemplateParameters

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

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

Parameters
Name Description
message ILaunchTemplateParameters

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

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

LaunchTemplateParameters

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for LaunchTemplateParameters

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.dataflow.v1beta3.LaunchTemplateParameters

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