Class ColumnSchema (1.49.0)

public final class ColumnSchema extends GeneratedMessageV3 implements ColumnSchemaOrBuilder

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

Protobuf type google.cloud.datacatalog.v1.ColumnSchema

Static Fields

COLUMN_FIELD_NUMBER

public static final int COLUMN_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_VALUE_FIELD_NUMBER

public static final int DEFAULT_VALUE_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

GC_RULE_FIELD_NUMBER

public static final int GC_RULE_FIELD_NUMBER
Field Value
Type Description
int

HIGHEST_INDEXING_TYPE_FIELD_NUMBER

public static final int HIGHEST_INDEXING_TYPE_FIELD_NUMBER
Field Value
Type Description
int

LOOKER_COLUMN_SPEC_FIELD_NUMBER

public static final int LOOKER_COLUMN_SPEC_FIELD_NUMBER
Field Value
Type Description
int

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER
Field Value
Type Description
int

ORDINAL_POSITION_FIELD_NUMBER

public static final int ORDINAL_POSITION_FIELD_NUMBER
Field Value
Type Description
int

RANGE_ELEMENT_TYPE_FIELD_NUMBER

public static final int RANGE_ELEMENT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

SUBCOLUMNS_FIELD_NUMBER

public static final int SUBCOLUMNS_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ColumnSchema getDefaultInstance()
Returns
Type Description
ColumnSchema

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ColumnSchema.Builder newBuilder()
Returns
Type Description
ColumnSchema.Builder

newBuilder(ColumnSchema prototype)

public static ColumnSchema.Builder newBuilder(ColumnSchema prototype)
Parameter
Name Description
prototype ColumnSchema
Returns
Type Description
ColumnSchema.Builder

parseDelimitedFrom(InputStream input)

public static ColumnSchema parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ColumnSchema
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ColumnSchema parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ColumnSchema
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ColumnSchema parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ColumnSchema
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ColumnSchema parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ColumnSchema
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ColumnSchema parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ColumnSchema
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ColumnSchema parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ColumnSchema
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ColumnSchema parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ColumnSchema
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ColumnSchema parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ColumnSchema
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ColumnSchema parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ColumnSchema
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ColumnSchema parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ColumnSchema
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ColumnSchema parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ColumnSchema
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ColumnSchema parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ColumnSchema
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ColumnSchema> parser()
Returns
Type Description
Parser<ColumnSchema>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getColumn()

public 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 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.

getDefaultInstanceForType()

public ColumnSchema getDefaultInstanceForType()
Returns
Type Description
ColumnSchema

getDefaultValue()

public 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 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 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 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 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 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 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 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 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 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 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 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 int getOrdinalPosition()

Optional. Ordinal position

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

Returns
Type Description
int

The ordinalPosition.

getParserForType()

public Parser<ColumnSchema> getParserForType()
Returns
Type Description
Parser<ColumnSchema>
Overrides

getRangeElementType()

public 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 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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSubcolumns(int index)

public 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 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 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 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 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 ColumnSchema.SystemSpecCase getSystemSpecCase()
Returns
Type Description
ColumnSchema.SystemSpecCase

getType()

public 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 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ColumnSchema.Builder newBuilderForType()
Returns
Type Description
ColumnSchema.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ColumnSchema.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ColumnSchema.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ColumnSchema.Builder toBuilder()
Returns
Type Description
ColumnSchema.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException