Class ColumnSchema (1.30.0)

Version 1.30.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 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ColumnSchema

Implements

ColumnSchemaOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

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

AbstractMessage.equals(Object other)

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

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public ColumnSchema.Builder toBuilder()

Returns
Type	Description
ColumnSchema.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException