Class protos.google.area120.tables.v1alpha1.ColumnDescription (2.2.1)

Represents a ColumnDescription.

Package

@google/area120-tables

Constructors

(constructor)(properties)

constructor(properties?: google.area120.tables.v1alpha1.IColumnDescription);

Constructs a new ColumnDescription.

Parameter
NameDescription
properties IColumnDescription

Properties to set

Properties

dataType

public dataType: string;

ColumnDescription dataType.

id

public id: string;

ColumnDescription id.

labels

public labels: google.area120.tables.v1alpha1.ILabeledItem[];

ColumnDescription labels.

lookupDetails

public lookupDetails?: (google.area120.tables.v1alpha1.ILookupDetails|null);

ColumnDescription lookupDetails.

name

public name: string;

ColumnDescription name.

relationshipDetails

public relationshipDetails?: (google.area120.tables.v1alpha1.IRelationshipDetails|null);

ColumnDescription relationshipDetails.

Methods

create(properties)

public static create(properties?: google.area120.tables.v1alpha1.IColumnDescription): google.area120.tables.v1alpha1.ColumnDescription;

Creates a new ColumnDescription instance using the specified properties.

Parameter
NameDescription
properties IColumnDescription

Properties to set

Returns
TypeDescription
google.area120.tables.v1alpha1.ColumnDescription

ColumnDescription instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.area120.tables.v1alpha1.ColumnDescription;

Decodes a ColumnDescription 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.area120.tables.v1alpha1.ColumnDescription

ColumnDescription

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.area120.tables.v1alpha1.ColumnDescription;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.area120.tables.v1alpha1.ColumnDescription

ColumnDescription

encode(message, writer)

public static encode(message: google.area120.tables.v1alpha1.IColumnDescription, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ColumnDescription message. Does not implicitly messages.

Parameters
NameDescription
message IColumnDescription

ColumnDescription 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.area120.tables.v1alpha1.IColumnDescription, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IColumnDescription

ColumnDescription 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.area120.tables.v1alpha1.ColumnDescription;

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

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

Plain object

Returns
TypeDescription
google.area120.tables.v1alpha1.ColumnDescription

ColumnDescription

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ColumnDescription

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.area120.tables.v1alpha1.ColumnDescription, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.area120.tables.v1alpha1.ColumnDescription

ColumnDescription

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