Class protos.google.cloud.dataform.v1.CompilationResultAction (2.1.0)

Represents a CompilationResultAction.

Package

@google-cloud/dataform

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dataform.v1.ICompilationResultAction);

Constructs a new CompilationResultAction.

Parameter
Name Description
properties ICompilationResultAction

Properties to set

Properties

_internalMetadata

public _internalMetadata?: "internalMetadata";

CompilationResultAction _internalMetadata.

assertion

public assertion?: (google.cloud.dataform.v1.CompilationResultAction.IAssertion|null);

CompilationResultAction assertion.

canonicalTarget

public canonicalTarget?: (google.cloud.dataform.v1.ITarget|null);

CompilationResultAction canonicalTarget.

compiledObject

public compiledObject?: ("relation"|"operations"|"assertion"|"declaration"|"notebook"|"dataPreparation");

CompilationResultAction compiledObject.

dataPreparation

public dataPreparation?: (google.cloud.dataform.v1.CompilationResultAction.IDataPreparation|null);

CompilationResultAction dataPreparation.

declaration

public declaration?: (google.cloud.dataform.v1.CompilationResultAction.IDeclaration|null);

CompilationResultAction declaration.

filePath

public filePath: string;

CompilationResultAction filePath.

internalMetadata

public internalMetadata?: (string|null);

CompilationResultAction internalMetadata.

notebook

public notebook?: (google.cloud.dataform.v1.CompilationResultAction.INotebook|null);

CompilationResultAction notebook.

operations

public operations?: (google.cloud.dataform.v1.CompilationResultAction.IOperations|null);

CompilationResultAction operations.

relation

public relation?: (google.cloud.dataform.v1.CompilationResultAction.IRelation|null);

CompilationResultAction relation.

target

public target?: (google.cloud.dataform.v1.ITarget|null);

CompilationResultAction target.

Methods

create(properties)

public static create(properties?: google.cloud.dataform.v1.ICompilationResultAction): google.cloud.dataform.v1.CompilationResultAction;

Creates a new CompilationResultAction instance using the specified properties.

Parameter
Name Description
properties ICompilationResultAction

Properties to set

Returns
Type Description
CompilationResultAction

CompilationResultAction instance

decode(reader, length)

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

Decodes a CompilationResultAction 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
CompilationResultAction

CompilationResultAction

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
CompilationResultAction

CompilationResultAction

encode(message, writer)

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

Encodes the specified CompilationResultAction message. Does not implicitly messages.

Parameters
Name Description
message ICompilationResultAction

CompilationResultAction 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.dataform.v1.ICompilationResultAction, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ICompilationResultAction

CompilationResultAction 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.dataform.v1.CompilationResultAction;

Creates a CompilationResultAction 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
CompilationResultAction

CompilationResultAction

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CompilationResultAction

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message CompilationResultAction

CompilationResultAction

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