Class ColumnSchema (1.19.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
TypeDescription
int

DEFAULT_VALUE_FIELD_NUMBER

public static final int DEFAULT_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

GC_RULE_FIELD_NUMBER

public static final int GC_RULE_FIELD_NUMBER
Field Value
TypeDescription
int

HIGHEST_INDEXING_TYPE_FIELD_NUMBER

public static final int HIGHEST_INDEXING_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

LOOKER_COLUMN_SPEC_FIELD_NUMBER

public static final int LOOKER_COLUMN_SPEC_FIELD_NUMBER
Field Value
TypeDescription
int

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER
Field Value
TypeDescription
int

ORDINAL_POSITION_FIELD_NUMBER

public static final int ORDINAL_POSITION_FIELD_NUMBER
Field Value
TypeDescription
int

SUBCOLUMNS_FIELD_NUMBER

public static final int SUBCOLUMNS_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ColumnSchema getDefaultInstance()
Returns
TypeDescription
ColumnSchema

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ColumnSchema.Builder newBuilder()
Returns
TypeDescription
ColumnSchema.Builder

newBuilder(ColumnSchema prototype)

public static ColumnSchema.Builder newBuilder(ColumnSchema prototype)
Parameter
NameDescription
prototypeColumnSchema
Returns
TypeDescription
ColumnSchema.Builder

parseDelimitedFrom(InputStream input)

public static ColumnSchema parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ColumnSchema
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ColumnSchema parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ColumnSchema
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ColumnSchema parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ColumnSchema
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ColumnSchema parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ColumnSchema
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ColumnSchema parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ColumnSchema
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ColumnSchema parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ColumnSchema
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ColumnSchema parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ColumnSchema
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ColumnSchema parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ColumnSchema
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ColumnSchema parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ColumnSchema
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ColumnSchema parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ColumnSchema
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ColumnSchema parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ColumnSchema
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ColumnSchema parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ColumnSchema
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ColumnSchema> parser()
Returns
TypeDescription
Parser<ColumnSchema>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for column.

getDefaultInstanceForType()

public ColumnSchema getDefaultInstanceForType()
Returns
TypeDescription
ColumnSchema

getDefaultValue()

public String getDefaultValue()

Optional. Default value for the column.

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

Returns
TypeDescription
String

The defaultValue.

getDefaultValueBytes()

public ByteString getDefaultValueBytes()

Optional. Default value for the column.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for mode.

getOrdinalPosition()

public int getOrdinalPosition()

Optional. Ordinal position

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

Returns
TypeDescription
int

The ordinalPosition.

getParserForType()

public Parser<ColumnSchema> getParserForType()
Returns
TypeDescription
Parser<ColumnSchema>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.cloud.datacatalog.v1.ColumnSchemaOrBuilder>

getSystemSpecCase()

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

The bytes for type.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasLookerColumnSpec()

public boolean hasLookerColumnSpec()

Looker specific column info of this column.

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

Returns
TypeDescription
boolean

Whether the lookerColumnSpec field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ColumnSchema.Builder newBuilderForType()
Returns
TypeDescription
ColumnSchema.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ColumnSchema.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ColumnSchema.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ColumnSchema.Builder toBuilder()
Returns
TypeDescription
ColumnSchema.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException