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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ColumnSchema.Builder newBuilder()
newBuilder(ColumnSchema prototype)
public static ColumnSchema.Builder newBuilder(ColumnSchema prototype)
public static ColumnSchema parseDelimitedFrom(InputStream input)
public static ColumnSchema parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ColumnSchema parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ColumnSchema parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ColumnSchema parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ColumnSchema parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ColumnSchema parseFrom(CodedInputStream input)
public static ColumnSchema parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ColumnSchema parseFrom(InputStream input)
public static ColumnSchema parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ColumnSchema parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ColumnSchema parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ColumnSchema> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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()
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];
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;
getLookerColumnSpecOrBuilder()
public ColumnSchema.LookerColumnSpecOrBuilder getLookerColumnSpecOrBuilder()
Looker specific column info of this column.
.google.cloud.datacatalog.v1.ColumnSchema.LookerColumnSpec looker_column_spec = 18;
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()
Overrides
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
|
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];
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
|
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()
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()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ColumnSchema.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ColumnSchema.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public ColumnSchema.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
