Represents a ColumnSchema.
Package
@google-cloud/datacatalogConstructors
(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.
defaultValue
public defaultValue: string;ColumnSchema defaultValue.
description
public description: string;ColumnSchema description.
gcRule
public gcRule: string;ColumnSchema gcRule.
highestIndexingType
public highestIndexingType: (google.cloud.datacatalog.v1.ColumnSchema.IndexingType|keyof typeof google.cloud.datacatalog.v1.ColumnSchema.IndexingType);ColumnSchema highestIndexingType.
lookerColumnSpec
public lookerColumnSpec?: (google.cloud.datacatalog.v1.ColumnSchema.ILookerColumnSpec|null);ColumnSchema lookerColumnSpec.
mode
public mode: string;ColumnSchema mode.
ordinalPosition
public ordinalPosition: number;ColumnSchema ordinalPosition.
subcolumns
public subcolumns: google.cloud.datacatalog.v1.IColumnSchema[];ColumnSchema subcolumns.
systemSpec
public systemSpec?: "lookerColumnSpec";ColumnSchema systemSpec.
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 |
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 |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
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 |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
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 |
ColumnSchema |
ColumnSchema |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for ColumnSchema
| 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 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 |
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) |
|