Package com.google.cloud.datacatalog.v1

Class 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

    • 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

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

      • 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​(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

      • 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