Interface ColumnSchemaOrBuilder (1.43.0)

public interface ColumnSchemaOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getColumn()

public abstract String getColumn()

Required. Name of the column.

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

string column = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The column.

getColumnBytes()

public abstract ByteString getColumnBytes()

Required. Name of the column.

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

string column = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for column.

getDefaultValue()

public abstract String getDefaultValue()

Optional. Default value for the column.

string default_value = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The defaultValue.

getDefaultValueBytes()

public abstract ByteString getDefaultValueBytes()

Optional. Default value for the column.

string default_value = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for defaultValue.

getDescription()

public abstract String getDescription()

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.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

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.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for description.

getGcRule()

public abstract String getGcRule()

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

string gc_rule = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The gcRule.

getGcRuleBytes()

public abstract ByteString getGcRuleBytes()

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

string gc_rule = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for gcRule.

getHighestIndexingType()

public abstract ColumnSchema.IndexingType getHighestIndexingType()

Optional. Most important inclusion of this column.

.google.cloud.datacatalog.v1.ColumnSchema.IndexingType highest_indexing_type = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ColumnSchema.IndexingType

The highestIndexingType.

getHighestIndexingTypeValue()

public abstract int getHighestIndexingTypeValue()

Optional. Most important inclusion of this column.

.google.cloud.datacatalog.v1.ColumnSchema.IndexingType highest_indexing_type = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The enum numeric value on the wire for highestIndexingType.

getLookerColumnSpec()

public abstract ColumnSchema.LookerColumnSpec getLookerColumnSpec()

Looker specific column info of this column.

.google.cloud.datacatalog.v1.ColumnSchema.LookerColumnSpec looker_column_spec = 18;

Returns
TypeDescription
ColumnSchema.LookerColumnSpec

The lookerColumnSpec.

getLookerColumnSpecOrBuilder()

public abstract ColumnSchema.LookerColumnSpecOrBuilder getLookerColumnSpecOrBuilder()

Looker specific column info of this column.

.google.cloud.datacatalog.v1.ColumnSchema.LookerColumnSpec looker_column_spec = 18;

Returns
TypeDescription
ColumnSchema.LookerColumnSpecOrBuilder

getMode()

public abstract String getMode()

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.

string mode = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The mode.

getModeBytes()

public abstract ByteString getModeBytes()

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.

string mode = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for mode.

getOrdinalPosition()

public abstract int getOrdinalPosition()

Optional. Ordinal position

int32 ordinal_position = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The ordinalPosition.

getSubcolumns(int index)

public abstract ColumnSchema getSubcolumns(int index)

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

repeated .google.cloud.datacatalog.v1.ColumnSchema subcolumns = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
ColumnSchema

getSubcolumnsCount()

public abstract int getSubcolumnsCount()

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

repeated .google.cloud.datacatalog.v1.ColumnSchema subcolumns = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

getSubcolumnsList()

public abstract List<ColumnSchema> getSubcolumnsList()

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

repeated .google.cloud.datacatalog.v1.ColumnSchema subcolumns = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
List<ColumnSchema>

getSubcolumnsOrBuilder(int index)

public abstract ColumnSchemaOrBuilder getSubcolumnsOrBuilder(int index)

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

repeated .google.cloud.datacatalog.v1.ColumnSchema subcolumns = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
ColumnSchemaOrBuilder

getSubcolumnsOrBuilderList()

public abstract List<? extends ColumnSchemaOrBuilder> getSubcolumnsOrBuilderList()

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

repeated .google.cloud.datacatalog.v1.ColumnSchema subcolumns = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
List<? extends com.google.cloud.datacatalog.v1.ColumnSchemaOrBuilder>

getSystemSpecCase()

public abstract ColumnSchema.SystemSpecCase getSystemSpecCase()
Returns
TypeDescription
ColumnSchema.SystemSpecCase

getType()

public abstract String getType()

Required. Type of the column.

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

string type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The type.

getTypeBytes()

public abstract ByteString getTypeBytes()

Required. Type of the column.

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

string type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for type.

hasLookerColumnSpec()

public abstract boolean hasLookerColumnSpec()

Looker specific column info of this column.

.google.cloud.datacatalog.v1.ColumnSchema.LookerColumnSpec looker_column_spec = 18;

Returns
TypeDescription
boolean

Whether the lookerColumnSpec field is set.