Data Catalog v1 API - Class ColumnSchema (2.6.0)

public sealed class ColumnSchema : IMessage<ColumnSchema>, IEquatable<ColumnSchema>, IDeepCloneable<ColumnSchema>, IBufferMessage, IMessage

Reference documentation and code samples for the Data Catalog v1 API class ColumnSchema.

A column within a schema. Columns can be nested inside other columns.

Inheritance

object > ColumnSchema

Namespace

Google.Cloud.DataCatalog.V1

Assembly

Google.Cloud.DataCatalog.V1.dll

Constructors

ColumnSchema()

public ColumnSchema()

ColumnSchema(ColumnSchema)

public ColumnSchema(ColumnSchema other)
Parameter
NameDescription
otherColumnSchema

Properties

Column

public string Column { get; set; }

Required. Name of the column.

Must be a UTF-8 string without dots (.). The maximum size is 64 bytes.

Property Value
TypeDescription
string

DefaultValue

public string DefaultValue { get; set; }

Optional. Default value for the column.

Property Value
TypeDescription
string

Description

public string Description { get; set; }

Optional. Description of the column. Default value is an empty string.

The description must be a UTF-8 string with the maximum size of 2000 bytes.

Property Value
TypeDescription
string

GcRule

public string GcRule { get; set; }

Optional. Garbage collection policy for the column or column family. Applies to systems like Cloud Bigtable.

Property Value
TypeDescription
string

HighestIndexingType

public ColumnSchema.Types.IndexingType HighestIndexingType { get; set; }

Optional. Most important inclusion of this column.

Property Value
TypeDescription
ColumnSchemaTypesIndexingType

LookerColumnSpec

public ColumnSchema.Types.LookerColumnSpec LookerColumnSpec { get; set; }

Looker specific column info of this column.

Property Value
TypeDescription
ColumnSchemaTypesLookerColumnSpec

Mode

public string Mode { get; set; }

Optional. A column's mode indicates whether values in this column are required, nullable, or repeated.

Only NULLABLE, REQUIRED, and REPEATED values are supported. Default mode is NULLABLE.

Property Value
TypeDescription
string

OrdinalPosition

public int OrdinalPosition { get; set; }

Optional. Ordinal position

Property Value
TypeDescription
int

Subcolumns

public RepeatedField<ColumnSchema> Subcolumns { get; }

Optional. Schema of sub-columns. A column can have zero or more sub-columns.

Property Value
TypeDescription
RepeatedFieldColumnSchema

SystemSpecCase

public ColumnSchema.SystemSpecOneofCase SystemSpecCase { get; }
Property Value
TypeDescription
ColumnSchemaSystemSpecOneofCase

Type

public string Type { get; set; }

Required. Type of the column.

Must be a UTF-8 string with the maximum size of 128 bytes.

Property Value
TypeDescription
string