com.google.cloud.datacatalog.v1

Class ColumnSchema

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.datacatalog.v1.ColumnSchema

All Implemented Interfaces:

ColumnSchemaOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ColumnSchema
extends com.google.protobuf.GeneratedMessageV3
implements ColumnSchemaOrBuilder

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

Protobuf type google.cloud.datacatalog.v1.ColumnSchema

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ColumnSchema.Builder A column within a schema.
static class	ColumnSchema.IndexingType Specifies inclusion of the column in an index
static class	ColumnSchema.LookerColumnSpec Column info specific to Looker System.
static interface	ColumnSchema.LookerColumnSpecOrBuilder
static class	ColumnSchema.SystemSpecCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	COLUMN_FIELD_NUMBER
static int	DEFAULT_VALUE_FIELD_NUMBER
static int	DESCRIPTION_FIELD_NUMBER
static int	GC_RULE_FIELD_NUMBER
static int	HIGHEST_INDEXING_TYPE_FIELD_NUMBER
static int	LOOKER_COLUMN_SPEC_FIELD_NUMBER
static int	MODE_FIELD_NUMBER
static int	ORDINAL_POSITION_FIELD_NUMBER
static int	SUBCOLUMNS_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getColumn() Required.
com.google.protobuf.ByteString	getColumnBytes() Required.
static ColumnSchema	getDefaultInstance()
ColumnSchema	getDefaultInstanceForType()
String	getDefaultValue() Optional.
com.google.protobuf.ByteString	getDefaultValueBytes() Optional.
String	getDescription() Optional.
com.google.protobuf.ByteString	getDescriptionBytes() Optional.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<ColumnSchema>	getParserForType()
int	getSerializedSize()
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.
int	hashCode()
boolean	hasLookerColumnSpec() Looker specific column info of this column.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ColumnSchema.Builder	newBuilder()
static ColumnSchema.Builder	newBuilder(ColumnSchema prototype)
ColumnSchema.Builder	newBuilderForType()
protected ColumnSchema.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ColumnSchema	parseDelimitedFrom(InputStream input)
static ColumnSchema	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ColumnSchema	parseFrom(byte[] data)
static ColumnSchema	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ColumnSchema	parseFrom(ByteBuffer data)
static ColumnSchema	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ColumnSchema	parseFrom(com.google.protobuf.ByteString data)
static ColumnSchema	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ColumnSchema	parseFrom(com.google.protobuf.CodedInputStream input)
static ColumnSchema	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ColumnSchema	parseFrom(InputStream input)
static ColumnSchema	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ColumnSchema>	parser()
ColumnSchema.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

COLUMN_FIELD_NUMBER

public static final int COLUMN_FIELD_NUMBER

See Also:

Constant Field Values

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER

See Also:

Constant Field Values

DEFAULT_VALUE_FIELD_NUMBER

public static final int DEFAULT_VALUE_FIELD_NUMBER

See Also:

Constant Field Values

ORDINAL_POSITION_FIELD_NUMBER

public static final int ORDINAL_POSITION_FIELD_NUMBER

See Also:

Constant Field Values

HIGHEST_INDEXING_TYPE_FIELD_NUMBER

public static final int HIGHEST_INDEXING_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

SUBCOLUMNS_FIELD_NUMBER

public static final int SUBCOLUMNS_FIELD_NUMBER

See Also:

Constant Field Values

LOOKER_COLUMN_SPEC_FIELD_NUMBER

public static final int LOOKER_COLUMN_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

GC_RULE_FIELD_NUMBER

public static final int GC_RULE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getSystemSpecCase

public ColumnSchema.SystemSpecCase getSystemSpecCase()

Specified by:

getSystemSpecCase in interface ColumnSchemaOrBuilder

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

Specified by:

getColumn in interface ColumnSchemaOrBuilder

Returns:

The column.

getColumnBytes

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

Specified by:

getColumnBytes in interface ColumnSchemaOrBuilder

Returns:

The bytes for column.

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

Specified by:

getType in interface ColumnSchemaOrBuilder

Returns:

The type.

getTypeBytes

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

Specified by:

getTypeBytes in interface ColumnSchemaOrBuilder

Returns:

The bytes for type.

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

Specified by:

getDescription in interface ColumnSchemaOrBuilder

Returns:

The description.

getDescriptionBytes

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

Specified by:

getDescriptionBytes in interface ColumnSchemaOrBuilder

Returns:

The bytes for description.

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

Specified by:

getMode in interface ColumnSchemaOrBuilder

Returns:

The mode.

getModeBytes

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

Specified by:

getModeBytes in interface ColumnSchemaOrBuilder

Returns:

The bytes for mode.

getDefaultValue

public String getDefaultValue()

 Optional. Default value for the column.
 

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

Specified by:

getDefaultValue in interface ColumnSchemaOrBuilder

Returns:

The defaultValue.

getDefaultValueBytes

public com.google.protobuf.ByteString getDefaultValueBytes()

 Optional. Default value for the column.
 

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

Specified by:

getDefaultValueBytes in interface ColumnSchemaOrBuilder

Returns:

The bytes for defaultValue.

getOrdinalPosition

public int getOrdinalPosition()

 Optional. Ordinal position
 

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

Specified by:

getOrdinalPosition in interface ColumnSchemaOrBuilder

Returns:

The ordinalPosition.

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

Specified by:

getHighestIndexingTypeValue in interface ColumnSchemaOrBuilder

Returns:

The enum numeric value on the wire for highestIndexingType.

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

Specified by:

getHighestIndexingType in interface ColumnSchemaOrBuilder

Returns:

The highestIndexingType.

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

Specified by:

getSubcolumnsList in interface 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];

Specified by:

getSubcolumnsOrBuilderList in interface ColumnSchemaOrBuilder

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

Specified by:

getSubcolumnsCount in interface ColumnSchemaOrBuilder

getSubcolumns

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

Specified by:

getSubcolumns in interface ColumnSchemaOrBuilder

getSubcolumnsOrBuilder

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

Specified by:

getSubcolumnsOrBuilder in interface ColumnSchemaOrBuilder

hasLookerColumnSpec

public boolean hasLookerColumnSpec()

 Looker specific column info of this column.
 

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

Specified by:

hasLookerColumnSpec in interface ColumnSchemaOrBuilder

Returns:

Whether the lookerColumnSpec field is set.

getLookerColumnSpec

public ColumnSchema.LookerColumnSpec getLookerColumnSpec()

 Looker specific column info of this column.
 

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

Specified by:

getLookerColumnSpec in interface ColumnSchemaOrBuilder

Returns:

The lookerColumnSpec.

getLookerColumnSpecOrBuilder

public ColumnSchema.LookerColumnSpecOrBuilder getLookerColumnSpecOrBuilder()

 Looker specific column info of this column.
 

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

Specified by:

getLookerColumnSpecOrBuilder in interface ColumnSchemaOrBuilder

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

Specified by:

getGcRule in interface ColumnSchemaOrBuilder

Returns:

The gcRule.

getGcRuleBytes

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

Specified by:

getGcRuleBytes in interface ColumnSchemaOrBuilder

Returns:

The bytes for gcRule.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ColumnSchema parseFrom(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ColumnSchema parseFrom(ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ColumnSchema parseFrom(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ColumnSchema parseFrom(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ColumnSchema parseFrom(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ColumnSchema parseFrom(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ColumnSchema parseFrom(InputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static ColumnSchema parseFrom(InputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static ColumnSchema parseDelimitedFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static ColumnSchema parseDelimitedFrom(InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

parseFrom

public static ColumnSchema parseFrom(com.google.protobuf.CodedInputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static ColumnSchema parseFrom(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

newBuilderForType

public ColumnSchema.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ColumnSchema.Builder newBuilder()

newBuilder

public static ColumnSchema.Builder newBuilder(ColumnSchema prototype)

toBuilder

public ColumnSchema.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ColumnSchema.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ColumnSchema getDefaultInstance()

parser

public static com.google.protobuf.Parser<ColumnSchema> parser()

getParserForType

public com.google.protobuf.Parser<ColumnSchema> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ColumnSchema getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder