Class protos.google.cloud.bigquery.analyticshub.v1.JavaScriptUDF (2.2.0)

Represents a JavaScriptUDF.

Package

@google-cloud/bigquery-analyticshub

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.bigquery.analyticshub.v1.IJavaScriptUDF);

Constructs a new JavaScriptUDF.

Parameter
Name Description
properties IJavaScriptUDF

Properties to set

Properties

code

public code: string;

JavaScriptUDF code.

functionName

public functionName: string;

JavaScriptUDF functionName.

Methods

create(properties)

public static create(properties?: google.cloud.bigquery.analyticshub.v1.IJavaScriptUDF): google.cloud.bigquery.analyticshub.v1.JavaScriptUDF;

Creates a new JavaScriptUDF instance using the specified properties.

Parameter
Name Description
properties IJavaScriptUDF

Properties to set

Returns
Type Description
JavaScriptUDF

JavaScriptUDF instance

decode(reader, length)

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

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

JavaScriptUDF

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.bigquery.analyticshub.v1.JavaScriptUDF;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
JavaScriptUDF

JavaScriptUDF

encode(message, writer)

public static encode(message: google.cloud.bigquery.analyticshub.v1.IJavaScriptUDF, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified JavaScriptUDF message. Does not implicitly messages.

Parameters
Name Description
message IJavaScriptUDF

JavaScriptUDF 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.bigquery.analyticshub.v1.IJavaScriptUDF, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IJavaScriptUDF

JavaScriptUDF 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.bigquery.analyticshub.v1.JavaScriptUDF;

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

JavaScriptUDF

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for JavaScriptUDF

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message JavaScriptUDF

JavaScriptUDF

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