com.google.cloud.datacatalog.v1

Interface ColumnSchemaOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ColumnSchema, ColumnSchema.Builder

public interface ColumnSchemaOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getColumn() Required.
com.google.protobuf.ByteString	getColumnBytes() Required.
String	getDefaultValue() Optional.
com.google.protobuf.ByteString	getDefaultValueBytes() Optional.
String	getDescription() Optional.
com.google.protobuf.ByteString	getDescriptionBytes() Optional.
String	getGcRule() Optional.
com.google.protobuf.ByteString	getGcRuleBytes() Optional.
ColumnSchema.IndexingType	getHighestIndexingType() Optional.
int	getHighestIndexingTypeValue() Optional.
ColumnSchema.LookerColumnSpec	getLookerColumnSpec() Looker specific column info of this column.
ColumnSchema.LookerColumnSpecOrBuilder	getLookerColumnSpecOrBuilder() Looker specific column info of this column.
String	getMode() Optional.
com.google.protobuf.ByteString	getModeBytes() Optional.
int	getOrdinalPosition() Optional.
ColumnSchema.FieldElementType	getRangeElementType() Optional.
ColumnSchema.FieldElementTypeOrBuilder	getRangeElementTypeOrBuilder() Optional.
ColumnSchema	getSubcolumns(int index) Optional.
int	getSubcolumnsCount() Optional.
List<ColumnSchema>	getSubcolumnsList() Optional.
ColumnSchemaOrBuilder	getSubcolumnsOrBuilder(int index) Optional.
List<? extends ColumnSchemaOrBuilder>	getSubcolumnsOrBuilderList() Optional.
ColumnSchema.SystemSpecCase	getSystemSpecCase()
String	getType() Required.
com.google.protobuf.ByteString	getTypeBytes() Required.
boolean	hasLookerColumnSpec() Looker specific column info of this column.
boolean	hasRangeElementType() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getColumn

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:

The column.

getColumnBytes

com.google.protobuf.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:

The bytes for column.

getType

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:

The type.

getTypeBytes

com.google.protobuf.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:

The bytes for type.

getDescription

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:

The description.

getDescriptionBytes

com.google.protobuf.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:

The bytes for description.

getMode

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:

The mode.

getModeBytes

com.google.protobuf.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:

The bytes for mode.

getDefaultValue

String getDefaultValue()

 Optional. Default value for the column.
 

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

Returns:

The defaultValue.

getDefaultValueBytes

com.google.protobuf.ByteString getDefaultValueBytes()

 Optional. Default value for the column.
 

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

Returns:

The bytes for defaultValue.

getOrdinalPosition

int getOrdinalPosition()

 Optional. Ordinal position
 

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

Returns:

The ordinalPosition.

getHighestIndexingTypeValue

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:

The enum numeric value on the wire for highestIndexingType.

getHighestIndexingType

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:

The highestIndexingType.

getSubcolumnsList

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];

getSubcolumns

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];

getSubcolumnsCount

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];

getSubcolumnsOrBuilderList

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];

getSubcolumnsOrBuilder

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];

hasLookerColumnSpec

boolean hasLookerColumnSpec()

 Looker specific column info of this column.
 

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

Returns:

Whether the lookerColumnSpec field is set.

getLookerColumnSpec

ColumnSchema.LookerColumnSpec getLookerColumnSpec()

 Looker specific column info of this column.
 

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

Returns:

The lookerColumnSpec.

getLookerColumnSpecOrBuilder

ColumnSchema.LookerColumnSpecOrBuilder getLookerColumnSpecOrBuilder()

 Looker specific column info of this column.
 

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

hasRangeElementType

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:

Whether the rangeElementType field is set.

getRangeElementType

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:

The rangeElementType.

getRangeElementTypeOrBuilder

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];

getGcRule

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:

The gcRule.

getGcRuleBytes

com.google.protobuf.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:

The bytes for gcRule.

getSystemSpecCase

ColumnSchema.SystemSpecCase getSystemSpecCase()