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

Represents a MessageTransform.

Package

@google-cloud/bigquery-analyticshub

Constructors

(constructor)(properties)

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

Constructs a new MessageTransform.

Parameter
Name Description
properties IMessageTransform

Properties to set

Properties

disabled

public disabled: boolean;

MessageTransform disabled.

enabled

public enabled: boolean;

MessageTransform enabled.

javascriptUdf

public javascriptUdf?: (google.cloud.bigquery.analyticshub.v1.IJavaScriptUDF|null);

MessageTransform javascriptUdf.

transform

public transform?: "javascriptUdf";

MessageTransform transform.

Methods

create(properties)

public static create(properties?: google.cloud.bigquery.analyticshub.v1.IMessageTransform): google.cloud.bigquery.analyticshub.v1.MessageTransform;

Creates a new MessageTransform instance using the specified properties.

Parameter
Name Description
properties IMessageTransform

Properties to set

Returns
Type Description
MessageTransform

MessageTransform instance

decode(reader, length)

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

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

MessageTransform

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
MessageTransform

MessageTransform

encode(message, writer)

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

Encodes the specified MessageTransform message. Does not implicitly messages.

Parameters
Name Description
message IMessageTransform

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

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

Parameters
Name Description
message IMessageTransform

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

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

MessageTransform

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for MessageTransform

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message MessageTransform

MessageTransform

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