Class protos.google.dataflow.v1beta3.LaunchFlexTemplateParameter (2.1.1)

Represents a LaunchFlexTemplateParameter.

Package

@google-cloud/dataflow

Constructors

(constructor)(properties)

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

Constructs a new LaunchFlexTemplateParameter.

Parameter
NameDescription
properties ILaunchFlexTemplateParameter

Properties to set

Properties

containerSpec

public containerSpec?: (google.dataflow.v1beta3.IContainerSpec|null);

LaunchFlexTemplateParameter containerSpec.

containerSpecGcsPath

public containerSpecGcsPath?: (string|null);

LaunchFlexTemplateParameter containerSpecGcsPath.

environment

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

LaunchFlexTemplateParameter environment.

jobName

public jobName: string;

LaunchFlexTemplateParameter jobName.

launchOptions

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

LaunchFlexTemplateParameter launchOptions.

parameters

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

LaunchFlexTemplateParameter parameters.

template

public template?: ("containerSpec"|"containerSpecGcsPath");

LaunchFlexTemplateParameter template.

transformNameMappings

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

LaunchFlexTemplateParameter transformNameMappings.

update

public update: boolean;

LaunchFlexTemplateParameter update.

Methods

create(properties)

public static create(properties?: google.dataflow.v1beta3.ILaunchFlexTemplateParameter): google.dataflow.v1beta3.LaunchFlexTemplateParameter;

Creates a new LaunchFlexTemplateParameter instance using the specified properties.

Parameter
NameDescription
properties ILaunchFlexTemplateParameter

Properties to set

Returns
TypeDescription
google.dataflow.v1beta3.LaunchFlexTemplateParameter

LaunchFlexTemplateParameter instance

decode(reader, length)

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

Decodes a LaunchFlexTemplateParameter 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.dataflow.v1beta3.LaunchFlexTemplateParameter

LaunchFlexTemplateParameter

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.dataflow.v1beta3.LaunchFlexTemplateParameter

LaunchFlexTemplateParameter

encode(message, writer)

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

Encodes the specified LaunchFlexTemplateParameter message. Does not implicitly messages.

Parameters
NameDescription
message ILaunchFlexTemplateParameter

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

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

Parameters
NameDescription
message ILaunchFlexTemplateParameter

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

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

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

Plain object

Returns
TypeDescription
google.dataflow.v1beta3.LaunchFlexTemplateParameter

LaunchFlexTemplateParameter

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for LaunchFlexTemplateParameter

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.dataflow.v1beta3.LaunchFlexTemplateParameter

LaunchFlexTemplateParameter

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