Class Schema.SchemaField (1.45.0)
Version 1.45.0keyboard_arrow_down
public static final class Schema . SchemaField extends GeneratedMessageV3 implements Schema . SchemaFieldOrBuilder
Represents a column field within a table schema.
Protobuf type google.cloud.dataplex.v1.Schema.SchemaField
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
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int
FIELDS_FIELD_NUMBER
public static final int FIELDS_FIELD_NUMBER
Field Value
Type Description
int
MODE_FIELD_NUMBER
public static final int MODE_FIELD_NUMBER
Field Value
Type Description
int
NAME_FIELD_NUMBER
public static final int NAME_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 Schema . SchemaField getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Schema . SchemaField . Builder newBuilder ()
newBuilder(Schema.SchemaField prototype)
public static Schema . SchemaField . Builder newBuilder ( Schema . SchemaField prototype )
public static Schema . SchemaField parseDelimitedFrom ( InputStream input )
public static Schema . SchemaField parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Schema . SchemaField parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Schema . SchemaField parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Schema . SchemaField parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Schema . SchemaField parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Schema . SchemaField parseFrom ( CodedInputStream input )
public static Schema . SchemaField parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Schema . SchemaField parseFrom ( InputStream input )
public static Schema . SchemaField parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Schema . SchemaField parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Schema . SchemaField parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Schema . SchemaField > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public Schema . SchemaField getDefaultInstanceForType ()
getDescription()
public String getDescription ()
Optional. User friendly field description. Must be less than or equal to
1024 characters.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
String The description.
getDescriptionBytes()
public ByteString getDescriptionBytes ()
Optional. User friendly field description. Must be less than or equal to
1024 characters.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
ByteString The bytes for description.
getFields(int index)
public Schema . SchemaField getFields ( int index )
Optional. Any nested field for complex types.
repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Name Description
indexint
getFieldsCount()
public int getFieldsCount ()
Optional. Any nested field for complex types.
repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int
getFieldsList()
public List<Schema . SchemaField > getFieldsList ()
Optional. Any nested field for complex types.
repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];
getFieldsOrBuilder(int index)
public Schema . SchemaFieldOrBuilder getFieldsOrBuilder ( int index )
Optional. Any nested field for complex types.
repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Name Description
indexint
getFieldsOrBuilderList()
public List <? extends Schema . SchemaFieldOrBuilder > getFieldsOrBuilderList ()
Optional. Any nested field for complex types.
repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 10 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
List <? extends com.google.cloud.dataplex.v1.Schema.SchemaFieldOrBuilder >
getMode()
public Schema . Mode getMode ()
Required. Additional field semantics.
.google.cloud.dataplex.v1.Schema.Mode mode = 4 [(.google.api.field_behavior) = REQUIRED];
getModeValue()
public int getModeValue ()
Required. Additional field semantics.
.google.cloud.dataplex.v1.Schema.Mode mode = 4 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
int The enum numeric value on the wire for mode.
getName()
Required. The name of the field. Must contain only letters, numbers and
underscores, with a maximum length of 767 characters,
and must begin with a letter or underscore.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The name.
getNameBytes()
public ByteString getNameBytes ()
Required. The name of the field. Must contain only letters, numbers and
underscores, with a maximum length of 767 characters,
and must begin with a letter or underscore.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
ByteString The bytes for name.
getParserForType()
public Parser<Schema . SchemaField > getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getType()
public Schema . Type getType ()
Required. The type of field.
.google.cloud.dataplex.v1.Schema.Type type = 3 [(.google.api.field_behavior) = REQUIRED];
getTypeValue()
public int getTypeValue ()
Required. The type of field.
.google.cloud.dataplex.v1.Schema.Type type = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
int The enum numeric value on the wire for type.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Schema . SchemaField . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Schema . SchemaField . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Schema . SchemaField . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-11 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-11 UTC."],[],[]]
