Interface ColumnSchemaOrBuilder (1.47.0)

Version 1.47.0

• 1.61.0 (latest)
• 1.60.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.5
• 1.8.4
• 1.7.2
• 1.6.2
• 1.5.4

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
Type	Description
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
Type	Description
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
Type	Description
String	The defaultValue.

getDefaultValueBytes()

public abstract ByteString getDefaultValueBytes()

Optional. Default value for the column.

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

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
ByteString	The bytes for mode.

getOrdinalPosition()

public abstract int getOrdinalPosition()

Optional. Ordinal position

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

Returns
Type	Description
int	The ordinalPosition.

getRangeElementType()

public abstract ColumnSchema.FieldElementType getRangeElementType()

Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include:

• DATE
• DATETIME
• TIMESTAMP

.google.cloud.datacatalog.v1.ColumnSchema.FieldElementType range_element_type = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ColumnSchema.FieldElementType	The rangeElementType.

getRangeElementTypeOrBuilder()

public abstract ColumnSchema.FieldElementTypeOrBuilder getRangeElementTypeOrBuilder()

Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include:

• DATE
• DATETIME
• TIMESTAMP

.google.cloud.datacatalog.v1.ColumnSchema.FieldElementType range_element_type = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ColumnSchema.FieldElementTypeOrBuilder

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
Name	Description
index	int

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Name	Description
index	int

Returns
Type	Description
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
Type	Description
List<? extends com.google.cloud.datacatalog.v1.ColumnSchemaOrBuilder>

getSystemSpecCase()

public abstract ColumnSchema.SystemSpecCase getSystemSpecCase()

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
boolean	Whether the lookerColumnSpec field is set.

hasRangeElementType()

public abstract boolean hasRangeElementType()

Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include:

• DATE
• DATETIME
• TIMESTAMP

.google.cloud.datacatalog.v1.ColumnSchema.FieldElementType range_element_type = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the rangeElementType field is set.