Class protos.google.cloud.datacatalog.v1.ColumnSchema (2.5.0)

Represents a ColumnSchema.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.datacatalog.v1.IColumnSchema);

Constructs a new ColumnSchema.

Parameter

Name	Description
properties	`IColumnSchema` Properties to set

Properties

column

public column: string;

ColumnSchema column.

description

public description: string;

ColumnSchema description.

mode

public mode: string;

ColumnSchema mode.

subcolumns

public subcolumns: google.cloud.datacatalog.v1.IColumnSchema[];

ColumnSchema subcolumns.

type

public type: string;

ColumnSchema type.

Methods

create(properties)

public static create(properties?: google.cloud.datacatalog.v1.IColumnSchema): google.cloud.datacatalog.v1.ColumnSchema;

Creates a new ColumnSchema instance using the specified properties.

Parameter

Name	Description
properties	`IColumnSchema` Properties to set

Returns

Type	Description
google.cloud.datacatalog.v1.ColumnSchema	ColumnSchema instance

decode(reader, length)

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

Decodes a ColumnSchema message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.datacatalog.v1.ColumnSchema	ColumnSchema

decodeDelimited(reader)

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

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.datacatalog.v1.ColumnSchema	ColumnSchema

encode(message, writer)

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

Encodes the specified ColumnSchema message. Does not implicitly messages.

Parameters

Name	Description
message	`IColumnSchema` ColumnSchema 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.datacatalog.v1.IColumnSchema, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IColumnSchema` ColumnSchema 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.datacatalog.v1.ColumnSchema;

Creates a ColumnSchema 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
google.cloud.datacatalog.v1.ColumnSchema	ColumnSchema

toJSON()

public toJSON(): { [k: string]: any };

Converts this ColumnSchema to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.datacatalog.v1.ColumnSchema` ColumnSchema
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 ColumnSchema 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